Project

General

Profile

$highlight » History » Revision 4

Revision 3 (Per Amundsen, 03/18/2014 06:27 AM) → Revision 4/18 (Per Amundsen, 03/18/2014 06:27 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 highlight options, or if text is specified, returns the properties for the highlight line that matches text. 

 *Parameters* 

 N - The Nth highlight from the highlight 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. 
 .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, else [[$false]]. 
 .regex - [[$true]] if regex is enabled, else [[$false]]. 
 .cs - [[$true]] case sensitive is enabled, else [[$false]].