Project

General

Profile

$highlight » History » Version 6

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