Difference between revisions of "$strip"

From Scriptwiki
Jump to: navigation, search
(added Also See and Category)
(added the function of 'reverse' control code)
Line 10: Line 10:
 
| u || The ''u'' switch strips all ''underline'' control codes.
 
| u || The ''u'' switch strips all ''underline'' control codes.
 
|-
 
|-
| r || The ''r'' switch strips all ''reverse'' control codes.
+
| r || The ''r'' switch strips all ''reverse'' control codes. This control code reverses the background and text color as specified in the ''Colors...'' dialog.
 
|-
 
|-
 
| c || The ''c'' switch strips all ''color'' control codes.
 
| c || The ''c'' switch strips all ''color'' control codes.

Revision as of 16:06, 12 April 2006

Returns text with control codes stripped out.

$strip(text[,burcmo])

The first parameter is the text you want to strip the control codes from. The second parameter is optional and specifies which control codes are stripped.

Switch Meaning
b The b switch strips all bold control codes.
u The u switch strips all underline control codes.
r The r switch strips all reverse control codes. This control code reverses the background and text color as specified in the Colors... dialog.
c The c switch strips all color control codes.
m The m switch strips all control codes as specified in Options=>IRC=>Messages, not including the Only if... option.
o The o switch applies the Only if... setting in Options=>IRC=>Messages.

Example

on ^*:TEXT:*:?:{
  echo -t $nick < $+ $nick $+ > $strip($1-,m)
  haltdef
}

The above little script would strip control codes from private messages as they are specified in Options=>IRC=>Messages.

Also See

  • $stripped - This returns the number of control codes stripped by $strip.