From WikiChip
Difference between revisions of "mirc/identifiers/$cnick"
(Created page with "{{mirc title|$cnick Identifier}}'''$cnick''' returns the 'Nick or address' field from the Edit dialog of the Nth entry in the Nick Colors dialog, or if a nick/address is speci...") |
(→Properties) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{mirc title|$cnick Identifier}}'''$cnick''' returns the 'Nick or address' field from the Edit dialog of the Nth entry in the Nick Colors dialog, or if a nick/address is specified, returns the Nth position of the item in list that matches the nick. If the nick/address does not match any items, returns zero. | {{mirc title|$cnick Identifier}}'''$cnick''' returns the 'Nick or address' field from the Edit dialog of the Nth entry in the Nick Colors dialog, or if a nick/address is specified, returns the Nth position of the item in list that matches the nick. If the nick/address does not match any items, returns zero. | ||
+ | |||
== Synopsis == | == Synopsis == | ||
<pre>$cnick(N/nick, M)</pre> | <pre>$cnick(N/nick, M)</pre> | ||
− | == | + | == Parameters == |
* '''<N/nick>''' - a number representing the Nth item in the Nick Color dialog or a nickname/address used as a match against the field 'Nick or address' in Nick Color Edit dialog | * '''<N/nick>''' - a number representing the Nth item in the Nick Color dialog or a nickname/address used as a match against the field 'Nick or address' in Nick Color Edit dialog | ||
Line 10: | Line 11: | ||
== Properties == | == Properties == | ||
− | * '''.color''' - return the color for that entry. if no item is found via a nick/address match, the 'Normal Text' color is returned, if the M parameter is 1, the 'Listbox text' is color is returned | + | * '''.color/.colour''' - return the color for that entry. if no item is found via a nick/address match, the 'Normal Text' color is returned, if the M parameter is 1, the 'Listbox text' is color is returned |
* '''.modes''' - return the 'Channel modes' field | * '''.modes''' - return the 'Channel modes' field | ||
* '''.levels''' - return the 'User levels' field | * '''.levels''' - return the 'User levels' field | ||
Line 22: | Line 23: | ||
* '''.notify''' - return the state of the 'notify' checkbox | * '''.notify''' - return the state of the 'notify' checkbox | ||
* '''.idle''' - return the 'Idle time' field | * '''.idle''' - return the 'Idle time' field | ||
+ | * '''.auto''' - return the state of the 'Auto color' option (where you can use '*' as a color to enable the option) | ||
== Example == | == Example == | ||
Line 33: | Line 35: | ||
− | [[Category: | + | [[Category:mIRC identifiers|cnick]] |
Latest revision as of 18:42, 16 August 2022
Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
$cnick returns the 'Nick or address' field from the Edit dialog of the Nth entry in the Nick Colors dialog, or if a nick/address is specified, returns the Nth position of the item in list that matches the nick. If the nick/address does not match any items, returns zero.
Synopsis[edit]
$cnick(N/nick, M)
Parameters[edit]
- <N/nick> - a number representing the Nth item in the Nick Color dialog or a nickname/address used as a match against the field 'Nick or address' in Nick Color Edit dialog
- M - if you use the .color property and no item is found via a nick/address match, the 'Normal Text' color is returned, if M is 1, the 'Listbox text' is color is returned
Properties[edit]
- .color/.colour - return the color for that entry. if no item is found via a nick/address match, the 'Normal Text' color is returned, if the M parameter is 1, the 'Listbox text' is color is returned
- .modes - return the 'Channel modes' field
- .levels - return the 'User levels' field
- .method - return the 'Method' field
- .anymode - return the state of the 'Any mode' checkbox
- .nomode - return the state of the 'No mode' checkbox
- .ignore - return the state of the 'Ignore' checkbox
- .op - return the state of the 'Op' checkbox
- .voice - return the state of the 'Voice' checkbox
- .protect - return the state of the 'Protect' checkbox
- .notify - return the state of the 'notify' checkbox
- .idle - return the 'Idle time' field
- .auto - return the state of the 'Auto color' option (where you can use '*' as a color to enable the option)
Example[edit]
//echo -a $cnick(1).color
Compatibility[edit]
Added: mIRC v5.9
Added on: 26 Apr 2001
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.