Project

General

Profile

$highlight » History » Version 4

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