Project

General

Profile

Scripting Commands » History » Version 161

Per Amundsen, 02/18/2017 06:56 AM

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