$nick » History » Version 15
Per Amundsen, 02/23/2023 06:27 PM
1 | 1 | Per Amundsen | _Added in 1.5_ |
---|---|---|---|
2 | |||
3 | *$nick* |
||
4 | |||
5 | Returns the nickname of the user associated with an [[Scripting_Events|event]]. |
||
6 | |||
7 | 12 | Per Amundsen | _=$nick can be used to evaluate a nick for use in dcc chat windows._ |
8 | 11 | Per Amundsen | |
9 | 1 | Per Amundsen | *Example* |
10 | |||
11 | <pre> |
||
12 | ; Prrint the user associated with this event. |
||
13 | on *:TEXT:*:*:echo -ag The user associated with this event is $nick |
||
14 | </pre> |
||
15 | 2 | Per Amundsen | |
16 | ----------------------------------------------------------------------------- |
||
17 | |||
18 | 13 | Per Amundsen | *$nick(#,N/nick,[qaohvr],[qaohvr])* |
19 | 2 | Per Amundsen | |
20 | 4 | Per Amundsen | Returns the Nth nickname in the channels nickname listbox on channel <notextile>#</notextile>. |
21 | 2 | Per Amundsen | |
22 | *Parameters* |
||
23 | |||
24 | 15 | Per Amundsen | table(ktable). |
25 | |*Parameter*|*Description*| |
||
26 | | <notextile>#</notextile> | The channel where the Nicklist is. | |
||
27 | | N/nick | The nick to get, if N = 0 number of nicks, otherwise the Nth nick. | |
||
28 | | [qaohvr] | Only include nicks with these channel modes. (optional) | |
||
29 | | [qaohvr] | Exclude nicks with these channel modes. (optional) | |
||
30 | 1 | Per Amundsen | |
31 | 13 | Per Amundsen | *Properties* |
32 | 2 | Per Amundsen | |
33 | 15 | Per Amundsen | table(ktable). |
34 | |*Property*|*Description*| |
||
35 | | .color | Returns the Nicklist color for this nick. | |
||
36 | | .rgbcolor | Returns the Nicklist [[$rgb]] color for this nick. *(AdiIRC only)* | |
||
37 | | .pnick | Returns the nick in .@%+nick format. (This include every channel prefix this user has, not just the highest) | |
||
38 | | .cnick | <notextile>Returns the nick in .@%+nick format. (Only the highest channel prefix is returned)</notextile> *(AdiIRC only)* | |
||
39 | | .cmode | Returns the highest channel prefix for this nick. *(AdiIRC only)* | |
||
40 | | .idle | Returns the number of seconds this nick has been idle on this channel. | |
||
41 | | .joined | Returns number of seconds since this user (or you) joined this channel. *(AdiIRC only)* | |
||
42 | 6 | Per Amundsen | |
43 | *Example* |
||
44 | |||
45 | <pre> |
||
46 | 10 | Per Amundsen | ; Print number of nicks in the channel '#test'. |
47 | 6 | Per Amundsen | //echo -ag $nick(#test, 0) |
48 | |||
49 | 10 | Per Amundsen | ; Print the 5th nick in the channel '#test'. |
50 | 6 | Per Amundsen | //echo -ag $nick(#test, 5) |
51 | </pre> |