Project

General

Profile

$highlight » History » Version 16

Per Amundsen, 02/10/2020 03:40 PM

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 9 Per Amundsen
Returns the Nth line in the [[highlights options]], or if text is specified, returns the properties for the highlight line that matches text.
14 1 Per Amundsen
15
*Parameters*
16
17 9 Per Amundsen
N - The Nth highlight from the [[highlights options]], if N = 0, total number of highlight items is returned.
18 1 Per Amundsen
text - A text to match with a highlight.
19
20
*Properties*
21
22
.text - Highlight match text. 
23
.color - Line color.
24 13 Per Amundsen
.rgbcolor - The [[$rgb|rgb]] color if set. *(AdiIRC only)*
25 1 Per Amundsen
.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 6 Per Amundsen
.nicks - [[$true]] if match on nickname is enabled, otherwise [[$false]].
30
.regex - [[$true]] if regex is enabled, otherwise [[$false]].
31
.cs - [[$true]] case sensitive is enabled, otherwise [[$false]].
32 13 Per Amundsen
.network - The network name to match, if any. *(AdiIRC only)*
33
.channel - The channel name to match, if any. *(AdiIRC only)*
34
.rnick - The remote nick name to match, if any. *(AdiIRC only)*
35 15 Per Amundsen
.fontbold - Returns [[$true]] if Bold is checked, otherwise [[$false]]. *(AdiIRC only)*
36
.fontitalic - Returns [[$true]] if Italic is checked, otherwise [[$false]]. *(AdiIRC only)*
37
.fontunderline - Returns [[$true]] if Underline is checked, otherwise [[$false]]. *(AdiIRC only)*
38 16 Per Amundsen
.backcolor - The background color if set. *(AdiIRC only)*
39
.rgbbackcolor - The [[$rgb|rgb]] background color if set. *(AdiIRC only)*
40 11 Per Amundsen
41
*Example*
42
43
<pre>
44
; Check if 'Word' is in the highlight list
45
//echo -ag Word is $iif($highlight(Word), a, not a )) in the highlight list
46
</pre>