$highlight » History » Version 3
Per Amundsen, 03/18/2014 06:27 AM
| 1 | 1 | Per Amundsen | _Added in 1.8.10_ |
|---|---|---|---|
| 2 | |||
| 3 | *$highlight* |
||
| 4 | |||
| 5 | 3 | Per Amundsen | Returns [[$true]] if highlighting is turned on, otherwise returns [[$false]]. |
| 6 | |||
| 7 | 1 | Per Amundsen | _Added in 1.9.3_ |
| 8 | |||
| 9 | *$highlight(N/text)* |
||
| 10 | |||
| 11 | Returns the Nth line in the highlight options, or if text is specified, returns the properties for the highlight line that matches text. |
||
| 12 | |||
| 13 | *Parameters* |
||
| 14 | |||
| 15 | N - The Nth highlight from the highlight options, if N = 0, total number of highlight items is returned. |
||
| 16 | text - A text to match with a highlight. |
||
| 17 | |||
| 18 | *Properties* |
||
| 19 | |||
| 20 | .text - Highlight match text. |
||
| 21 | .color - Line color. |
||
| 22 | .sound - "beep" or file name. |
||
| 23 | .flash - Flash times or 0 if flash is disabled. |
||
| 24 | .tip - Tip times or 0 if tip is disabled. |
||
| 25 | .message - Tip message. |
||
| 26 | .nicks - [[$true]] if match on nickname is enabled, else [[$false]]. |
||
| 27 | .regex - [[$true]] if regex is enabled, else [[$false]]. |
||
| 28 | 2 | Per Amundsen | .cs - [[$true]] case sensitive is enabled, else [[$false]]. |