Difference between revisions of "$highlight"
From Scriptwiki
(Added arguments) |
|||
| Line 1: | Line 1: | ||
| − | + | Returns information about highlight settings | |
$highlight | $highlight | ||
| + | * Returns $true or $false based on whether or not you have enabled highlighting. | ||
| + | |||
| + | $highlight(N/text)[.text|.color|.sound|.flash|.message|.nicks] | ||
| + | * Without properties, defaults to .text | ||
| + | * .text returns the highlight entry text (What the highlight will trigger on) | ||
| + | * .color returns the ID of the color that the highlight message becomes. | ||
| + | * .sound returns "beep", the location of the sound file, or [[$null]] if no sound is set. | ||
| + | * .flash returns the number of times to flash on this highlight. 0 if none. | ||
| + | * .message returns the message set in the highlight dialog associated with this entry. | ||
| + | * .nicks returns whether or not this highlight can match nicknames. [[$true]] or [[$false]]. | ||
[[Category:Identifiers]] | [[Category:Identifiers]] | ||
Latest revision as of 23:56, 10 May 2008
Returns information about highlight settings
$highlight
- Returns $true or $false based on whether or not you have enabled highlighting.
$highlight(N/text)[.text|.color|.sound|.flash|.message|.nicks]
- Without properties, defaults to .text
- .text returns the highlight entry text (What the highlight will trigger on)
- .color returns the ID of the color that the highlight message becomes.
- .sound returns "beep", the location of the sound file, or $null if no sound is set.
- .flash returns the number of times to flash on this highlight. 0 if none.
- .message returns the message set in the highlight dialog associated with this entry.
- .nicks returns whether or not this highlight can match nicknames. $true or $false.
