$highlight » History » Revision 12
Revision 11 (Per Amundsen, 08/26/2018 12:05 AM) → Revision 12/18 (Per Amundsen, 08/26/2018 12:06 AM)
_Added in 1.8.10_
*$highlight*
Returns [[$true]] if highlighting is turned on, otherwise returns [[$false]].
-----------------------------------------------------------------------------
_Added in 1.9.3_
*$highlight(N/text)*
Returns the Nth line in the [[highlights options]], or if text is specified, returns the properties for the highlight line that matches text.
*Parameters*
N - The Nth highlight from the [[highlights options]], if N = 0, total number of highlight items is returned.
text - A text to match with a highlight.
*Properties*
.text - Highlight match text.
.color - Line color.
.rgbcolor - The [[$rgb|rgb]] color if set. (AdiIRC only)
.sound - "beep" or file name.
.flash - Flash times or 0 if flash is disabled.
.tip - Tip times or 0 if tip is disabled.
.message - Tip message.
.nicks - [[$true]] if match on nickname is enabled, otherwise [[$false]].
.regex - [[$true]] if regex is enabled, otherwise [[$false]].
.cs - [[$true]] case sensitive is enabled, otherwise [[$false]].
.network - The network name to match, if any. (AdiIRC only)
.channel - The channel name to match, if any. (AdiIRC only)
.rnick - The remote nick name to match, if any. (AdiIRC only)
*Example*
<pre>
; Check if 'Word' is in the highlight list
//echo -ag Word is $iif($highlight(Word), a, not a )) in the highlight list
</pre>