Revision as of 06:23, 6 August 2022

The $highlight identifier, if used without parameters, returns a $true/$false value depending on if you have the highlight features enabled in mIRC, otherwise returns informations about the highlight entries.

Synopsis

$highlight - return $true/$false depending on if highlighting is turned on in the highlight mIRC dialog

$highlight(N/text) - return the Nth line in the highlight mIRC dialog's list, or return the value of the corresponding entry in mIRC's highlight dialog list, if any, for that string

Parameters

• N - if N is passed, return the Nth line in the highlight mIRC dialog's list
• text - if non-number parameter is passed, return the value of the corresponding entry in mIRC's highlight dialog list in option for that string.

Properties

• .text - returns the matching text of the entry
• .color - returns the color of the line being highligted
• .sound - returns the sound associated with the highlight if any ("beep" or a filename)
• .flash - returns 0 if flash is not set, otherwise it returns the corresponding number of repeat time, with $null for infinity
• .message - returns $true/$false depending on if the highlight is set for messages
• .nicks - returns $true/$false depending on if the highlight is set for nicks
• .regex - returns $true/$false depending on if the text should be compared using a regular expression
• .cs - returns $true/$false depending on if the text should be compared using case sensitivity
• .chans - returns the list of channels and nicknames required to trigger an highlight for that entry, if any.

Example

None

Compatibility

Added: mIRC v5.11
Added on: 11 Sep 1997
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.

See also