Project

General

Profile

Scripting Commands » History » Version 156

Per Amundsen, 12/15/2016 10:13 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 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 1 Per Amundsen
*[[/cycle]]*
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 50 Per Amundsen
[[/flash]]
121 1 Per Amundsen
[[/flist]]
122
[[/flushini]]
123 67 Per Amundsen
[[/font]]
124 124 Per Amundsen
[[/fopen]]
125 39 Per Amundsen
[[/fseek]]
126 144 Per Amundsen
[[/fsend]]
127 85 Per Amundsen
[[/fullname]]
128 45 Per Amundsen
*[[/fullscreen]]*
129 36 Per Amundsen
[[/fwrite]]
130 33 Per Amundsen
*[[/gcmem]]*
131 32 Per Amundsen
*[[/google]]*
132 23 Per Amundsen
[[/goto]]
133 143 Per Amundsen
[[/groups]]
134 77 Per Amundsen
[[/guser]]
135 1 Per Amundsen
[[/hadd]]
136 27 Per Amundsen
*[[/halfop]]*
137 1 Per Amundsen
[[/halt]]
138
[[/haltdef]]
139
[[/hdec]]
140
[[/hdel]]
141
[[/help]]
142 48 Per Amundsen
[[/hfree]]
143 1 Per Amundsen
*[[/highlight]]*
144
[[/hinc]]
145 144 Per Amundsen
[[/hload]]
146 143 Per Amundsen
[[/hmake]]
147 141 Per Amundsen
[[/hop]]
148 145 Per Amundsen
 | [[/hsave]]
149
[[/ialmark]]
150 1 Per Amundsen
[[/identd]]
151 128 Per Amundsen
*[[/icon]]*
152 140 Per Amundsen
[[/if]]
153 124 Per Amundsen
[[/ignore]]
154 123 Per Amundsen
[[/iline]]
155 122 Per Amundsen
[[/inc]]
156 141 Per Amundsen
*[[/inick]]*
157 96 Per Amundsen
[[/invite]]
158 94 Per Amundsen
[[/iuser]]
159 89 Per Amundsen
[[/join]]
160 88 Per Amundsen
[[/kick]]
161 85 Per Amundsen
[[/kill]]
162 84 Per Amundsen
*[[/lag]]*
163 126 Per Amundsen
[[/leave]]
164 149 Per Amundsen
*[[/linemarker]]*
165 78 Per Amundsen
[[/linesep]]
166 77 Per Amundsen
[[/list]]
167 74 Per Amundsen
[[/load]]
168 67 Per Amundsen
[[/loadbuf]]
169 66 Per Amundsen
*[[/lock]]*
170 130 Per Amundsen
[[/log]]
171 1 Per Amundsen
*[[/logs]]*
172
[[/logview]]
173
[[/markall]]
174 69 Per Amundsen
[[/mdi]]
175 57 Per Amundsen
[[/me]]
176 1 Per Amundsen
[[/menubar]]
177
[[/mkdir]]
178 85 Per Amundsen
[[/mnick]]
179 52 Per Amundsen
[[/mode]]
180 50 Per Amundsen
[[/msg]]
181 95 Per Amundsen
*[[/msgbox]]*
182 1 Per Amundsen
*[[/mute]]*
183
*[[/nextunread]]*
184
[[/nick]]
185 64 Per Amundsen
[[/nickcolumn]]
186 1 Per Amundsen
[[/nicklist]]
187
[[/nickcolor]]
188 39 Per Amundsen
*[[/nmsg]]*
189 144 Per Amundsen
[[/noop]]
190 143 Per Amundsen
[[/notice]]
191 1 Per Amundsen
[[/notify]]
192
*[[/np]]*
193 149 Per Amundsen
 | *[[/oline]]*
194
[[/omsg]]
195 145 Per Amundsen
[[/onotice]]
196 132 Per Amundsen
[[/op]]
197 130 Per Amundsen
*[[/options]]*
198 128 Per Amundsen
[[/parseline]]
199 126 Per Amundsen
[[/part]]
200 125 Per Amundsen
[[/partall]]
201 123 Per Amundsen
*[[/paths]]*
202 122 Per Amundsen
[[/perform]]
203 121 Per Amundsen
*[[/pgoogle]]*
204 118 Per Amundsen
*[[/plugins]]*
205 99 Per Amundsen
*[[/priv]]*
206 137 Per Amundsen
[[/proxy]]
207 96 Per Amundsen
[[/query]]
208 95 Per Amundsen
[[/queryrn]]
209 94 Per Amundsen
*[[/quickconnect]]*
210 89 Per Amundsen
*[[/quicksave]]*
211 88 Per Amundsen
[[/quit]]
212 1 Per Amundsen
[[/quote]]
213 85 Per Amundsen
[[/raw]]
214 84 Per Amundsen
*[[/rawx]]*
215
*[[/rawlog]]*
216 85 Per Amundsen
*[[/realname]]*
217 77 Per Amundsen
*[[/reconnect]]*
218 74 Per Amundsen
*[[/rejoin]]*
219 69 Per Amundsen
[[/reload]]
220 67 Per Amundsen
[[/remini]]
221 66 Per Amundsen
[[/remote]]
222 1 Per Amundsen
[[/remove]]
223
[[/rename]]
224
[[/renwin]]
225
[[/reseterror]]
226 82 Per Amundsen
[[/resetidle]]
227 1 Per Amundsen
*[[/resolve]]*
228 57 Per Amundsen
*[[/restart]]*
229 54 Per Amundsen
[[/return]]
230 1 Per Amundsen
[[/returnex]]
231 79 Per Amundsen
[[/rlevel]]
232 144 Per Amundsen
[[/rline]]
233 143 Per Amundsen
[[/rmdir]]
234 1 Per Amundsen
[[/run]]
235
[[/ruser]]
236 140 Per Amundsen
[[/say]]
237 139 Per Amundsen
[[/savebuf]]
238 149 Per Amundsen
 |^. [[/saveini]]
239
[[/scid]]
240 145 Per Amundsen
[[/scon]]
241 132 Per Amundsen
*[[/scripts]]*
242 130 Per Amundsen
*[[/search]]*
243 128 Per Amundsen
[[/server]]
244 126 Per Amundsen
*[[/serverlist]]*
245 124 Per Amundsen
[[/set]]
246 123 Per Amundsen
*[[/setconfig]]*
247 122 Per Amundsen
[[/setlayer]]
248 123 Per Amundsen
*[[/setoption]]*
249
*[[/showadiirc]]*
250 148 Per Amundsen
*[[/showmenu]]*
251 98 Per Amundsen
[[/showmirc]]
252 96 Per Amundsen
[[/signal]]
253 95 Per Amundsen
*[[/slap]]*
254 94 Per Amundsen
*[[/sleep]]*
255 89 Per Amundsen
[[/sline]]
256 88 Per Amundsen
[[/sockaccept]]
257 1 Per Amundsen
[[/sockclose]]
258
[[/socklist]]
259 85 Per Amundsen
[[/socklisten]]
260 84 Per Amundsen
[[/sockmark]]
261 82 Per Amundsen
[[/sockopen]]
262 80 Per Amundsen
[[/sockpause]]
263 79 Per Amundsen
[[/sockread]]
264 77 Per Amundsen
[[/sockrename]]
265 1 Per Amundsen
[[/sockudp]]
266
[[/sockwrite]]
267
*[[/sop]]*
268 69 Per Amundsen
[[/splay]]
269 1 Per Amundsen
*[[/statusbar]]*
270 66 Per Amundsen
[[/switchbar]]
271 1 Per Amundsen
*[[/tab]]*
272 63 Per Amundsen
*[[/themes]]*
273 1 Per Amundsen
[[/time]]
274
[[/timestamp]]
275
[[/timer]]
276 144 Per Amundsen
[[/tip]]
277 143 Per Amundsen
[[/tips]]
278 1 Per Amundsen
[[/titlebar]]
279 141 Per Amundsen
[[/tokenize]]
280 140 Per Amundsen
[[/toolbar]]
281 139 Per Amundsen
[[/topic]]
282 137 Per Amundsen
*[[/topicbox]]*
283 149 Per Amundsen
 |^. [[/treebar]]
284
[[/ulist]]
285 148 Per Amundsen
*[[/usernick]]*
286 145 Per Amundsen
*[[/txt2bin]]*
287 128 Per Amundsen
*[[/unban]]*
288 127 Per Amundsen
*[[/unignore]]*
289 126 Per Amundsen
[[/unload]]
290 124 Per Amundsen
*[[/unnotify]]*
291 123 Per Amundsen
[[/unset]]
292 122 Per Amundsen
[[/unsetall]]
293
*[[/update]]*
294 135 Per Amundsen
[[/updatenl]]
295 129 Per Amundsen
[[/url]]
296 123 Per Amundsen
[[/uwho]]
297 118 Per Amundsen
[[/var]]
298 98 Per Amundsen
*[[/vars]]*
299 96 Per Amundsen
*[[/viewlog]]*
300 95 Per Amundsen
*[[/voice]]*
301 94 Per Amundsen
[[/vol]]
302 91 Per Amundsen
*[[/wdown]]*
303 90 Per Amundsen
[[/while]]
304 89 Per Amundsen
[[/window]]
305 88 Per Amundsen
*[[/wjump]]*
306 87 Per Amundsen
*[[/wnext]]*
307 1 Per Amundsen
*[[/wpause]]*
308
*[[/wplay]]*
309 85 Per Amundsen
*[[/wprev]]*
310 84 Per Amundsen
[[/write]]
311 82 Per Amundsen
[[/writeini]]
312 81 Per Amundsen
*[[/wsearch]]*
313 80 Per Amundsen
*[[/wseekf]]*
314 79 Per Amundsen
*[[/wseekr]]*
315 78 Per Amundsen
*[[/wselect]]*
316 77 Per Amundsen
*[[/wstop]]*
317 76 Per Amundsen
*[[/wup]]*
318 16 Per Amundsen
 | 
319 1 Per Amundsen
320 150 Per Amundsen
h2. System information Commands
321 117 Per Amundsen
322 142 Per Amundsen
Output from these are set in [[Options_Dialog|Options]] -> [[Sysinfo Options|Sysinfo]] and are merely convenient aliases.
323 16 Per Amundsen
324
/sysinfo
325 1 Per Amundsen
/gfxinfo
326 31 Per Amundsen
/cpuinfo
327 1 Per Amundsen
/meminfo
328
/diskinfo
329
/audioinfo
330
/uptime
331
/bw
332
333 150 Per Amundsen
h2. Missing Commands
334 1 Per Amundsen
335 138 Per Amundsen
/aop
336 1 Per Amundsen
/avoice
337
/creq
338
/dccserver
339
/dqwindow
340
/firewall
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>