Semiconductor & Computer Engineering
From WikiChip
Difference between revisions of "mirc/identifiers/$highlight"
(Created page with "{{mirc title|$highlight Identifier}}The '''$higlight''' identifier return the number of the line that matched the regular expression in dialog's control. == Synopsis == <pre...") |
(→Properties) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{mirc title|$highlight Identifier}}The '''$ | + | {{mirc title|$highlight Identifier}}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. |
| Line 6: | Line 6: | ||
| − | <pre>$highlight(N/text) - return the Nth line in the highlight mIRC dialog's list, or | + | <pre>$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</pre> |
== Parameters == | == Parameters == | ||
* '''N''' - if N is passed, return the Nth line in the highlight mIRC dialog's list | * '''N''' - if N is passed, return the Nth line in the highlight mIRC dialog's list | ||
| − | * '''text''' - if | + | * '''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 == | == 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 | ||
| + | * '''.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 == | == Example == | ||
Latest revision as of 08:42, 6 August 2022
Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
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[edit]
$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[edit]
- 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[edit]
- .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
- .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[edit]
None
Compatibility[edit]
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[edit]
mIRC identifier list