Project

General

Profile

Scripting Commands » History » Version 151

Per Amundsen, 12/15/2016 10:10 PM

1 73 Per Amundsen
{{>toc}}
2
3 1 Per Amundsen
h1. Scripting Commands
4
5 2 Per Amundsen
Parameters in [x] means they are optional.
6
Parameters in <x> means they are required.
7
Parameters with a x|y means either x or y can be used.
8
9 3 Per Amundsen
Click on a command to read more about it.
10
11 150 Per Amundsen
Prefixes can also be combined.
12
13 27 Per Amundsen
Commands in bold is AdiIRC only.
14
15 123 Per Amundsen
| [[/abook]]
16
*[[/aclear]]*
17 1 Per Amundsen
[[/action]]
18 27 Per Amundsen
*[[/advertise]]*
19 1 Per Amundsen
[[/ajinvite]]
20
[[/alias]]
21
[[/aline]]
22
[[/amark]]
23
[[/ame]]
24
[[/amsg]]
25 84 Per Amundsen
*[[/allnick]]*
26 1 Per Amundsen
[[/anick]]
27 74 Per Amundsen
[[/auser]]
28 136 Per Amundsen
*[[/autoconnect]]*
29 53 Per Amundsen
[[/autojoin]]
30 27 Per Amundsen
*[[/aquit]]*
31 1 Per Amundsen
[[/away]]
32 27 Per Amundsen
*[[/back]]*
33 1 Per Amundsen
[[/background]]
34
[[/ban]]
35 27 Per Amundsen
*[[/banlist]]*
36 1 Per Amundsen
[[/bcopy]]
37
[[/beep]]
38 27 Per Amundsen
*[[/betaup]]*
39
*[[/bin2txt]]*
40 1 Per Amundsen
[[/bindip]]
41
[[/bread]]
42
[[/break]]
43
[[/breplace]]
44
[[/bset]]
45
[[/btrunc]]
46
[[/bunset]]
47 27 Per Amundsen
*[[/bw]]*
48 1 Per Amundsen
[[/bwrite]]
49
[[/channel]]
50 147 Per Amundsen
*[[/channels]]*
51 27 Per Amundsen
*[[/charset]]*
52 1 Per Amundsen
[[/clear]]
53
[[/clearall]]
54
[[/cline]]
55
[[/clipboard]]
56
[[/close]]
57 141 Per Amundsen
[[/cnick]]
58 1 Per Amundsen
[[/color]]
59
[[/colour]]
60 145 Per Amundsen
 | [[/comclose]]
61
[[/comlist]]
62 123 Per Amundsen
[[/comopen]]
63 84 Per Amundsen
[[/comreg]]
64 74 Per Amundsen
*[[/config]]*
65 32 Per Amundsen
[[/continue]]
66 66 Per Amundsen
[[/copy]]
67 1 Per Amundsen
[[/ctcp]]
68
[[/ctcps]]
69 57 Per Amundsen
[[/ctcpreply]]
70 1 Per Amundsen
*[[/cycle]]*
71 54 Per Amundsen
[[/dcc]]
72 52 Per Amundsen
[[/dde]]
73 41 Per Amundsen
[[/ddeserver]]
74
[[/debug]]
75 32 Per Amundsen
[[/dec]]
76 27 Per Amundsen
*[[/dehalfop]]*
77
*[[/deop]]*
78 1 Per Amundsen
[[/describe]]
79 27 Per Amundsen
*[[/desop]]*
80
*[[/devoice]]*
81 1 Per Amundsen
[[/dialog]]
82
[[/did]]
83
[[/didtok]]
84
[[/disable]]
85
[[/disconnect]]
86 94 Per Amundsen
[[/dlevel]]
87 1 Per Amundsen
[[/dline]]
88
[[/dll]]
89
[[/dns]]
90 27 Per Amundsen
*[[/dock]]*
91
*[[/dockpanels]]*
92 128 Per Amundsen
*[[/download]]*
93 1 Per Amundsen
[[/drawcopy]]
94
[[/drawdot]]
95
[[/drawfill]]
96
[[/drawline]]
97
[[/drawpic]]
98
[[/drawrect]]
99
[[/drawreplace]]
100
[[/drawrot]]
101
[[/drawsave]]
102
[[/drawscroll]]
103 141 Per Amundsen
[[/drawtext]]
104 136 Per Amundsen
[[/ebeeps]]
105 145 Per Amundsen
 | [[/echo]]
106
*[[/echomonitor]]*
107 123 Per Amundsen
*[[/echox]]*
108 97 Per Amundsen
*[[/edit]]*
109 94 Per Amundsen
[[/editbox]]
110 84 Per Amundsen
[[/else]]
111 74 Per Amundsen
[[/elseif]]
112 88 Per Amundsen
[[/emailaddr]]
113 66 Per Amundsen
[[/enable]]
114 1 Per Amundsen
*[[/encoding]]*
115
[[/events]]
116
[[/exit]]
117 60 Per Amundsen
*[[/fakeraw]]*
118 57 Per Amundsen
[[/fclose]]
119 144 Per Amundsen
*[[/fget]]*
120 54 Per Amundsen
[[/filter]]
121 52 Per Amundsen
[[/findtext]]
122 50 Per Amundsen
[[/flash]]
123 1 Per Amundsen
[[/flist]]
124
[[/flushini]]
125 67 Per Amundsen
[[/font]]
126 124 Per Amundsen
[[/fopen]]
127 39 Per Amundsen
[[/fseek]]
128 144 Per Amundsen
[[/fsend]]
129 85 Per Amundsen
[[/fullname]]
130 45 Per Amundsen
*[[/fullscreen]]*
131 36 Per Amundsen
[[/fwrite]]
132 33 Per Amundsen
*[[/gcmem]]*
133 32 Per Amundsen
*[[/google]]*
134 23 Per Amundsen
[[/goto]]
135 143 Per Amundsen
[[/groups]]
136 77 Per Amundsen
[[/guser]]
137 1 Per Amundsen
[[/hadd]]
138 27 Per Amundsen
*[[/halfop]]*
139 1 Per Amundsen
[[/halt]]
140
[[/haltdef]]
141
[[/hdec]]
142
[[/hdel]]
143
[[/help]]
144 48 Per Amundsen
[[/hfree]]
145 1 Per Amundsen
*[[/highlight]]*
146
[[/hinc]]
147 144 Per Amundsen
[[/hload]]
148 143 Per Amundsen
[[/hmake]]
149 141 Per Amundsen
[[/hop]]
150 145 Per Amundsen
 | [[/hsave]]
151
[[/ialmark]]
152 1 Per Amundsen
[[/identd]]
153 128 Per Amundsen
*[[/icon]]*
154 140 Per Amundsen
[[/if]]
155 124 Per Amundsen
[[/ignore]]
156 123 Per Amundsen
[[/iline]]
157 122 Per Amundsen
[[/inc]]
158 141 Per Amundsen
*[[/inick]]*
159 96 Per Amundsen
[[/invite]]
160 94 Per Amundsen
[[/iuser]]
161 89 Per Amundsen
[[/join]]
162 88 Per Amundsen
[[/kick]]
163 85 Per Amundsen
[[/kill]]
164 84 Per Amundsen
*[[/lag]]*
165 126 Per Amundsen
[[/leave]]
166 149 Per Amundsen
*[[/linemarker]]*
167 78 Per Amundsen
[[/linesep]]
168 77 Per Amundsen
[[/list]]
169 74 Per Amundsen
[[/load]]
170 67 Per Amundsen
[[/loadbuf]]
171 66 Per Amundsen
*[[/lock]]*
172 130 Per Amundsen
[[/log]]
173 1 Per Amundsen
*[[/logs]]*
174
[[/logview]]
175
[[/markall]]
176 69 Per Amundsen
[[/mdi]]
177 57 Per Amundsen
[[/me]]
178 1 Per Amundsen
[[/menubar]]
179
[[/mkdir]]
180 85 Per Amundsen
[[/mnick]]
181 52 Per Amundsen
[[/mode]]
182 50 Per Amundsen
[[/msg]]
183 95 Per Amundsen
*[[/msgbox]]*
184 1 Per Amundsen
*[[/mute]]*
185
*[[/nextunread]]*
186
[[/nick]]
187 64 Per Amundsen
[[/nickcolumn]]
188 1 Per Amundsen
[[/nicklist]]
189
[[/nickcolor]]
190 39 Per Amundsen
*[[/nmsg]]*
191 144 Per Amundsen
[[/noop]]
192 143 Per Amundsen
[[/notice]]
193 1 Per Amundsen
[[/notify]]
194
*[[/np]]*
195 149 Per Amundsen
 | *[[/oline]]*
196
[[/omsg]]
197 145 Per Amundsen
[[/onotice]]
198 132 Per Amundsen
[[/op]]
199 130 Per Amundsen
*[[/options]]*
200 128 Per Amundsen
[[/parseline]]
201 126 Per Amundsen
[[/part]]
202 125 Per Amundsen
[[/partall]]
203 123 Per Amundsen
*[[/paths]]*
204 122 Per Amundsen
[[/perform]]
205 121 Per Amundsen
*[[/pgoogle]]*
206 118 Per Amundsen
*[[/plugins]]*
207 99 Per Amundsen
*[[/priv]]*
208 137 Per Amundsen
[[/proxy]]
209 96 Per Amundsen
[[/query]]
210 95 Per Amundsen
[[/queryrn]]
211 94 Per Amundsen
*[[/quickconnect]]*
212 89 Per Amundsen
*[[/quicksave]]*
213 88 Per Amundsen
[[/quit]]
214 1 Per Amundsen
[[/quote]]
215 85 Per Amundsen
[[/raw]]
216 84 Per Amundsen
*[[/rawx]]*
217
*[[/rawlog]]*
218 85 Per Amundsen
*[[/realname]]*
219 77 Per Amundsen
*[[/reconnect]]*
220 74 Per Amundsen
*[[/rejoin]]*
221 69 Per Amundsen
[[/reload]]
222 67 Per Amundsen
[[/remini]]
223 66 Per Amundsen
[[/remote]]
224 1 Per Amundsen
[[/remove]]
225
[[/rename]]
226
[[/renwin]]
227
[[/reseterror]]
228 82 Per Amundsen
[[/resetidle]]
229 1 Per Amundsen
*[[/resolve]]*
230 57 Per Amundsen
*[[/restart]]*
231 54 Per Amundsen
[[/return]]
232 1 Per Amundsen
[[/returnex]]
233 79 Per Amundsen
[[/rlevel]]
234 144 Per Amundsen
[[/rline]]
235 143 Per Amundsen
[[/rmdir]]
236 1 Per Amundsen
[[/run]]
237
[[/ruser]]
238 140 Per Amundsen
[[/say]]
239 139 Per Amundsen
[[/savebuf]]
240 149 Per Amundsen
 |^. [[/saveini]]
241
[[/scid]]
242 145 Per Amundsen
[[/scon]]
243 132 Per Amundsen
*[[/scripts]]*
244 130 Per Amundsen
*[[/search]]*
245 128 Per Amundsen
[[/server]]
246 126 Per Amundsen
*[[/serverlist]]*
247 124 Per Amundsen
[[/set]]
248 123 Per Amundsen
*[[/setconfig]]*
249 122 Per Amundsen
[[/setlayer]]
250 123 Per Amundsen
*[[/setoption]]*
251
*[[/showadiirc]]*
252 148 Per Amundsen
*[[/showmenu]]*
253 98 Per Amundsen
[[/showmirc]]
254 96 Per Amundsen
[[/signal]]
255 95 Per Amundsen
*[[/slap]]*
256 94 Per Amundsen
*[[/sleep]]*
257 89 Per Amundsen
[[/sline]]
258 88 Per Amundsen
[[/sockaccept]]
259 1 Per Amundsen
[[/sockclose]]
260
[[/socklist]]
261 85 Per Amundsen
[[/socklisten]]
262 84 Per Amundsen
[[/sockmark]]
263 82 Per Amundsen
[[/sockopen]]
264 80 Per Amundsen
[[/sockpause]]
265 79 Per Amundsen
[[/sockread]]
266 77 Per Amundsen
[[/sockrename]]
267 1 Per Amundsen
[[/sockudp]]
268
[[/sockwrite]]
269
*[[/sop]]*
270 69 Per Amundsen
[[/splay]]
271 1 Per Amundsen
*[[/statusbar]]*
272 66 Per Amundsen
[[/switchbar]]
273 1 Per Amundsen
*[[/tab]]*
274 63 Per Amundsen
*[[/themes]]*
275 1 Per Amundsen
[[/time]]
276
[[/timestamp]]
277
[[/timer]]
278 144 Per Amundsen
[[/tip]]
279 143 Per Amundsen
[[/tips]]
280 1 Per Amundsen
[[/titlebar]]
281 141 Per Amundsen
[[/tokenize]]
282 140 Per Amundsen
[[/toolbar]]
283 139 Per Amundsen
[[/topic]]
284 137 Per Amundsen
*[[/topicbox]]*
285 149 Per Amundsen
 |^. [[/treebar]]
286
[[/ulist]]
287 148 Per Amundsen
*[[/usernick]]*
288 145 Per Amundsen
*[[/txt2bin]]*
289 128 Per Amundsen
*[[/unban]]*
290 127 Per Amundsen
*[[/unignore]]*
291 126 Per Amundsen
[[/unload]]
292 124 Per Amundsen
*[[/unnotify]]*
293 123 Per Amundsen
[[/unset]]
294 122 Per Amundsen
[[/unsetall]]
295
*[[/update]]*
296 135 Per Amundsen
[[/updatenl]]
297 129 Per Amundsen
[[/url]]
298 123 Per Amundsen
[[/uwho]]
299 118 Per Amundsen
[[/var]]
300 98 Per Amundsen
*[[/vars]]*
301 96 Per Amundsen
*[[/viewlog]]*
302 95 Per Amundsen
*[[/voice]]*
303 94 Per Amundsen
[[/vol]]
304 91 Per Amundsen
*[[/wdown]]*
305 90 Per Amundsen
[[/while]]
306 89 Per Amundsen
[[/window]]
307 88 Per Amundsen
*[[/wjump]]*
308 87 Per Amundsen
*[[/wnext]]*
309 1 Per Amundsen
*[[/wpause]]*
310
*[[/wplay]]*
311 85 Per Amundsen
*[[/wprev]]*
312 84 Per Amundsen
[[/write]]
313 82 Per Amundsen
[[/writeini]]
314 81 Per Amundsen
*[[/wsearch]]*
315 80 Per Amundsen
*[[/wseekf]]*
316 79 Per Amundsen
*[[/wseekr]]*
317 78 Per Amundsen
*[[/wselect]]*
318 77 Per Amundsen
*[[/wstop]]*
319 76 Per Amundsen
*[[/wup]]*
320 16 Per Amundsen
 | 
321 1 Per Amundsen
322 150 Per Amundsen
h2. System information Commands
323 117 Per Amundsen
324 142 Per Amundsen
Output from these are set in [[Options_Dialog|Options]] -> [[Sysinfo Options|Sysinfo]] and are merely convenient aliases.
325 16 Per Amundsen
326
/sysinfo
327 1 Per Amundsen
/gfxinfo
328 31 Per Amundsen
/cpuinfo
329 1 Per Amundsen
/meminfo
330
/diskinfo
331
/audioinfo
332
/uptime
333
/bw
334
335 150 Per Amundsen
h2. Missing Commands
336 1 Per Amundsen
337 138 Per Amundsen
/aop
338 1 Per Amundsen
/avoice
339
/creq
340
/dccserver
341
/dqwindow
342
/firewall
343
/flood
344
/flush
345
/fserve
346
/ghide
347
/gload
348
/gopts
349
/gplay
350
/gpoint
351
/gqreq
352
/gshow
353
/gsize
354
/gstop
355
/gtalk
356 119 Per Amundsen
/gunload
357 1 Per Amundsen
/ial
358
/ialclear
359 30 Per Amundsen
/links
360 1 Per Amundsen
/localinfo
361
/pdcc
362
/play
363
/playctrl
364
/pop
365
/protect
366
/pvoice
367
/qme
368
/qmsg
369
/save
370
/sound
371
/speak
372
/sreq
373
/strip
374
/tnick
375
/tray
376
/vcadd
377
/vcmd
378
/vcrem
379
/winhelp
380
381 150 Per Amundsen
h2. Command prefixes
382
383
/! prefix will execute the internal command, even if there is a alias with the same name.
384
385
Example:
386
387
<pre>
388
; Override the /me command,
389
alias me {
390
  ; use the /! prefix to call the internal command.
391
  /!me $1-
392
}
393
</pre>
394
395
/. prefix can be used to silence the output from many command.
396
397
Example:
398
399
<pre>
400
/.msg ¤channel This message will be hidden from your client, but still sent to the server.
401
</pre>
402
403
Both prefix's can be used at the same time.
404
405
Example:
406
407
<pre>
408
/!.msg ¤channel This message will be hidden from your client, but still sent to the server.
409
</pre>
410
411
h2. Evaluate identifiers from Editbox
412 105 Per Amundsen
413
Typing a command in the Editbox with double slashes// will evaluate $identifiers in the line before running it.
414
E.g //echo -ag My nick is $me
415
416 106 Per Amundsen
You can also [[tabcomplete]] identifiers manually using $me<tab>.
417 107 Per Amundsen
418 151 Per Amundsen
h2. Creating a new command
419 107 Per Amundsen
420 112 Per Amundsen
You can create a new command by opening the menu Tools -> Edit Aliases.
421 107 Per Amundsen
422 108 Per Amundsen
The format for the command is <command> <script to execute>.
423 107 Per Amundsen
424
*Example*
425
426
<pre>
427 108 Per Amundsen
; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'.
428 1 Per Amundsen
/p /part $chan
429 108 Per Amundsen
</pre>
430
431 110 Per Amundsen
You can also add a command from the script editor, the syntax there is alias <command> <script to execute>
432 108 Per Amundsen
433
*Example*
434
435
<pre>
436
; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'.
437
; Same as previous example.
438
alias p /part $chan
439
</pre>
440
441 111 Per Amundsen
If you want to use scripts with multiple lines, you can enclose them with {} brackets in both Edit Aliases and Script Editor.
442 108 Per Amundsen
443
*Example*
444
<pre>
445
; Edit Aliases
446 109 Per Amundsen
/p {
447 108 Per Amundsen
  /echo -ag I am parting $chan
448
  /part $chan
449
}
450
451
; Script editor
452
alias p {
453
  /echo -ag I am parting $chan
454
  /part $chan
455
}
456
</pre>
457
458
Almost all built-in commands can be overridden to execute your own script.
459
460
*Example*
461
462
<pre>
463
; Create your own /part command
464
alias part {
465
  /echo -ag I am parting $chan
466
  raw PART $chan
467
}
468
469 114 Per Amundsen
; Create your own /part command, but execute the built-in /part command after executing your own script.
470 108 Per Amundsen
alias part {
471
  /echo -ag I am parting $chan
472
473
  ; Execute the built-in part command
474
  !part $chan
475
}
476 107 Per Amundsen
</pre>
477 113 Per Amundsen
478
A command can also be called as a $identifier.
479
480
*Example*
481
482
<pre>
483
; Create a command.
484
alias mycommand {
485 115 Per Amundsen
  echo -ag I was called as a $iif($isid,identifier,command)
486 113 Per Amundsen
}
487
488
; Call the command as identifier.
489
//noop $mycommand
490
491 116 Per Amundsen
; Call the command as a command.
492 113 Per Amundsen
/mycommand
493
</pre>