Project

General

Profile

$nick » History » Revision 7

Revision 6 (Per Amundsen, 10/04/2015 07:00 PM) → Revision 7/15 (Per Amundsen, 10/27/2015 01:39 AM)

_Added in 1.5_ 

 *$nick* 

 Returns the nickname of the user associated with an [[Scripting_Events|event]]. 

 *Example* 

 <pre> 
 ; Prrint the user associated with this event. 
 on *:TEXT:*:*:echo -ag The user associated with this event is $nick 
 </pre> 

 ----------------------------------------------------------------------------- 

 *$nick(#,N/nick,[aohvr],[aohvr])* 

 Returns the Nth nickname in the channels nickname listbox on channel <notextile>#</notextile>. 

 *Parameters* 

 <notextile># - The channel where the Nicklist is.</notextile> 
 N/nick - The nick to get, if N = 0 number of nicks, otherwise the Nth nick. 
 [aohvr] - Only include nicks with these channel modes. (optional) 
 [aohvr] - Exclude nicks with these channel modes. (optional) 

 *Properties* 

 .color - Returns the Nicklist color for this nick. 
 .color - Returns the Nicklist [[$rgb]]color for this nick. 
 .pnick - Returns the nick in .@%+nick format. (This include every channel prefix this user has, not just the highest) 
 <notextile>.cnick - Returns the nick in .@%+nick format. (Only the highest channel prefix is returned, AdiIRC only)</notextile> 
 .cmode - Returns the highest channel prefix for this nick. (AdiIRC only) 
 .idle - Returns the number of seconds this nick has been idle on this channel. 
 .joined - Returns number of seconds since this user (or you) joined this channel. (AdiIRC only) 

 *Example* 

 <pre> 
 ; Print number of nicks in the channel '#test' 
 //echo -ag $nick(#test, 0) 

 ; Print the 5th nick in the channel '#test' 
 //echo -ag $nick(#test, 5) 
 </pre>