Project

General

Profile

Scripting Commands » History » Version 160

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

1 73 Per Amundsen
{{>toc}}
2 73 Per Amundsen
3 1 Per Amundsen
h1. Scripting Commands
4 1 Per Amundsen
5 2 Per Amundsen
Parameters in [x] means they are optional.
6 2 Per Amundsen
Parameters in <x> means they are required.
7 2 Per Amundsen
Parameters with a x|y means either x or y can be used.
8 2 Per Amundsen
9 3 Per Amundsen
Click on a command to read more about it.
10 3 Per Amundsen
11 154 Per Amundsen
_Commands in bold is AdiIRC only._
12 27 Per Amundsen
13 123 Per Amundsen
| [[/abook]]
14 123 Per Amundsen
*[[/aclear]]*
15 1 Per Amundsen
[[/action]]
16 27 Per Amundsen
*[[/advertise]]*
17 1 Per Amundsen
[[/ajinvite]]
18 1 Per Amundsen
[[/alias]]
19 1 Per Amundsen
[[/aline]]
20 1 Per Amundsen
[[/amark]]
21 1 Per Amundsen
[[/ame]]
22 1 Per Amundsen
[[/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 1 Per Amundsen
[[/ban]]
33 27 Per Amundsen
*[[/banlist]]*
34 1 Per Amundsen
[[/bcopy]]
35 1 Per Amundsen
[[/beep]]
36 27 Per Amundsen
*[[/betaup]]*
37 27 Per Amundsen
*[[/bin2txt]]*
38 1 Per Amundsen
[[/bindip]]
39 1 Per Amundsen
[[/bread]]
40 1 Per Amundsen
[[/break]]
41 1 Per Amundsen
[[/breplace]]
42 1 Per Amundsen
[[/bset]]
43 1 Per Amundsen
[[/btrunc]]
44 1 Per Amundsen
[[/bunset]]
45 27 Per Amundsen
*[[/bw]]*
46 1 Per Amundsen
[[/bwrite]]
47 1 Per Amundsen
[[/channel]]
48 147 Per Amundsen
*[[/channels]]*
49 27 Per Amundsen
*[[/charset]]*
50 1 Per Amundsen
[[/clear]]
51 1 Per Amundsen
[[/clearall]]
52 1 Per Amundsen
[[/cline]]
53 1 Per Amundsen
[[/clipboard]]
54 1 Per Amundsen
[[/close]]
55 141 Per Amundsen
[[/cnick]]
56 1 Per Amundsen
[[/color]]
57 1 Per Amundsen
[[/colour]]
58 145 Per Amundsen
 | [[/comclose]]
59 145 Per Amundsen
[[/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 1 Per Amundsen
[[/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 41 Per Amundsen
[[/debug]]
73 32 Per Amundsen
[[/dec]]
74 27 Per Amundsen
*[[/dehalfop]]*
75 27 Per Amundsen
*[[/deop]]*
76 1 Per Amundsen
[[/describe]]
77 27 Per Amundsen
*[[/desop]]*
78 27 Per Amundsen
*[[/devoice]]*
79 1 Per Amundsen
[[/dialog]]
80 1 Per Amundsen
[[/did]]
81 1 Per Amundsen
[[/didtok]]
82 1 Per Amundsen
[[/disable]]
83 1 Per Amundsen
[[/disconnect]]
84 94 Per Amundsen
[[/dlevel]]
85 1 Per Amundsen
[[/dline]]
86 1 Per Amundsen
[[/dll]]
87 1 Per Amundsen
[[/dns]]
88 27 Per Amundsen
*[[/dock]]*
89 27 Per Amundsen
*[[/dockpanels]]*
90 128 Per Amundsen
*[[/download]]*
91 1 Per Amundsen
[[/drawcopy]]
92 1 Per Amundsen
[[/drawdot]]
93 1 Per Amundsen
[[/drawfill]]
94 1 Per Amundsen
[[/drawline]]
95 1 Per Amundsen
[[/drawpic]]
96 1 Per Amundsen
[[/drawrect]]
97 1 Per Amundsen
[[/drawreplace]]
98 1 Per Amundsen
[[/drawrot]]
99 1 Per Amundsen
[[/drawsave]]
100 1 Per Amundsen
[[/drawscroll]]
101 141 Per Amundsen
[[/drawtext]]
102 136 Per Amundsen
[[/ebeeps]]
103 145 Per Amundsen
 | [[/echo]]
104 145 Per Amundsen
*[[/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 1 Per Amundsen
[[/events]]
114 1 Per Amundsen
[[/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 1 Per Amundsen
[[/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 1 Per Amundsen
[[/haltdef]]
140 1 Per Amundsen
[[/hdec]]
141 1 Per Amundsen
[[/hdel]]
142 1 Per Amundsen
[[/help]]
143 48 Per Amundsen
[[/hfree]]
144 1 Per Amundsen
*[[/highlight]]*
145 1 Per Amundsen
[[/hinc]]
146 144 Per Amundsen
[[/hload]]
147 1 Per Amundsen
[[/hmake]]
148 160 Per Amundsen
 | [[/hop]]
149 160 Per Amundsen
[[/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 1 Per Amundsen
[[/logview]]
175 1 Per Amundsen
[[/markall]]
176 69 Per Amundsen
[[/mdi]]
177 57 Per Amundsen
[[/me]]
178 1 Per Amundsen
[[/menubar]]
179 1 Per Amundsen
[[/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 1 Per Amundsen
*[[/nextunread]]*
186 1 Per Amundsen
[[/nick]]
187 64 Per Amundsen
[[/nickcolumn]]
188 1 Per Amundsen
[[/nicklist]]
189 39 Per Amundsen
*[[/nmsg]]*
190 1 Per Amundsen
[[/noop]]
191 1 Per Amundsen
[[/notice]]
192 1 Per Amundsen
[[/notify]]
193 160 Per Amundsen
 | *[[/np]]*
194 160 Per Amundsen
*[[/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 84 Per Amundsen
*[[/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 1 Per Amundsen
[[/rename]]
225 1 Per Amundsen
[[/renwin]]
226 1 Per Amundsen
[[/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 1 Per Amundsen
[[/rmdir]]
235 1 Per Amundsen
[[/run]]
236 1 Per Amundsen
[[/ruser]]
237 140 Per Amundsen
[[/say]]
238 160 Per Amundsen
 |^. [[/savebuf]]
239 160 Per Amundsen
[[/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 123 Per Amundsen
*[[/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 1 Per Amundsen
[[/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 1 Per Amundsen
[[/sockwrite]]
268 1 Per Amundsen
*[[/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 1 Per Amundsen
[[/timestamp]]
276 1 Per Amundsen
[[/timer]]
277 1 Per Amundsen
[[/tip]]
278 1 Per Amundsen
[[/tips]]
279 1 Per Amundsen
[[/titlebar]]
280 141 Per Amundsen
[[/tokenize]]
281 140 Per Amundsen
[[/toolbar]]
282 139 Per Amundsen
[[/topic]]
283 160 Per Amundsen
 |^. *[[/topicbox]]*
284 160 Per Amundsen
[[/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 122 Per Amundsen
*[[/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 1 Per Amundsen
*[[/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 16 Per Amundsen
/sysinfo
326 1 Per Amundsen
/gfxinfo
327 31 Per Amundsen
/cpuinfo
328 1 Per Amundsen
/meminfo
329 1 Per Amundsen
/diskinfo
330 1 Per Amundsen
/audioinfo
331 1 Per Amundsen
/uptime
332 1 Per Amundsen
/bw
333 1 Per Amundsen
334 150 Per Amundsen
h2. Missing Commands
335 1 Per Amundsen
336 138 Per Amundsen
/aop
337 1 Per Amundsen
/avoice
338 1 Per Amundsen
/creq
339 1 Per Amundsen
/dccserver
340 1 Per Amundsen
/dqwindow
341 1 Per Amundsen
/firewall
342 1 Per Amundsen
/flood
343 1 Per Amundsen
/flush
344 1 Per Amundsen
/fserve
345 1 Per Amundsen
/ghide
346 1 Per Amundsen
/gload
347 1 Per Amundsen
/gopts
348 1 Per Amundsen
/gplay
349 1 Per Amundsen
/gpoint
350 1 Per Amundsen
/gqreq
351 1 Per Amundsen
/gshow
352 1 Per Amundsen
/gsize
353 1 Per Amundsen
/gstop
354 1 Per Amundsen
/gtalk
355 119 Per Amundsen
/gunload
356 1 Per Amundsen
/ial
357 1 Per Amundsen
/ialclear
358 30 Per Amundsen
/links
359 1 Per Amundsen
/localinfo
360 1 Per Amundsen
/pdcc
361 1 Per Amundsen
/play
362 1 Per Amundsen
/playctrl
363 1 Per Amundsen
/pop
364 1 Per Amundsen
/protect
365 1 Per Amundsen
/pvoice
366 1 Per Amundsen
/qme
367 1 Per Amundsen
/qmsg
368 1 Per Amundsen
/save
369 1 Per Amundsen
/sound
370 1 Per Amundsen
/speak
371 1 Per Amundsen
/sreq
372 1 Per Amundsen
/strip
373 1 Per Amundsen
/tnick
374 1 Per Amundsen
/tray
375 1 Per Amundsen
/vcadd
376 1 Per Amundsen
/vcmd
377 1 Per Amundsen
/vcrem
378 1 Per Amundsen
/winhelp
379 1 Per Amundsen
380 150 Per Amundsen
h2. Command prefixes
381 150 Per Amundsen
382 150 Per Amundsen
/! prefix will execute the internal command, even if there is a alias with the same name.
383 150 Per Amundsen
384 150 Per Amundsen
Example:
385 150 Per Amundsen
386 150 Per Amundsen
<pre>
387 150 Per Amundsen
; Override the /me command,
388 150 Per Amundsen
alias me {
389 150 Per Amundsen
  ; use the /! prefix to call the internal command.
390 150 Per Amundsen
  /!me $1-
391 150 Per Amundsen
}
392 150 Per Amundsen
</pre>
393 150 Per Amundsen
394 150 Per Amundsen
/. prefix can be used to silence the output from many command.
395 150 Per Amundsen
396 150 Per Amundsen
Example:
397 150 Per Amundsen
398 150 Per Amundsen
<pre>
399 155 Per Amundsen
/.msg #channel This message will be hidden from your client, but still sent to the server.
400 150 Per Amundsen
</pre>
401 150 Per Amundsen
402 150 Per Amundsen
Both prefix's can be used at the same time.
403 150 Per Amundsen
404 150 Per Amundsen
Example:
405 150 Per Amundsen
406 150 Per Amundsen
<pre>
407 155 Per Amundsen
/!.msg #channel This message will be hidden from your client, but still sent to the server.
408 150 Per Amundsen
</pre>
409 150 Per Amundsen
410 150 Per Amundsen
h2. Evaluate identifiers from Editbox
411 105 Per Amundsen
412 156 Per Amundsen
Typing a command in the Editbox with double slashes// will evaluate [[Scripting Identifiers|$identifiers]] in the line before running it.
413 105 Per Amundsen
E.g //echo -ag My nick is $me
414 105 Per Amundsen
415 156 Per Amundsen
You can also [[tabcomplete]] [[Scripting Identifiers|$identifiers]] manually using $me<tab>.
416 107 Per Amundsen
417 151 Per Amundsen
h2. Creating a new command
418 107 Per Amundsen
419 112 Per Amundsen
You can create a new command by opening the menu Tools -> Edit Aliases.
420 107 Per Amundsen
421 108 Per Amundsen
The format for the command is <command> <script to execute>.
422 107 Per Amundsen
423 107 Per Amundsen
*Example*
424 107 Per Amundsen
425 107 Per Amundsen
<pre>
426 108 Per Amundsen
; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'.
427 1 Per Amundsen
/p /part $chan
428 108 Per Amundsen
</pre>
429 108 Per Amundsen
430 110 Per Amundsen
You can also add a command from the script editor, the syntax there is alias <command> <script to execute>
431 108 Per Amundsen
432 108 Per Amundsen
*Example*
433 108 Per Amundsen
434 108 Per Amundsen
<pre>
435 108 Per Amundsen
; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'.
436 108 Per Amundsen
; Same as previous example.
437 108 Per Amundsen
alias p /part $chan
438 108 Per Amundsen
</pre>
439 108 Per Amundsen
440 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.
441 108 Per Amundsen
442 108 Per Amundsen
*Example*
443 108 Per Amundsen
<pre>
444 108 Per Amundsen
; Edit Aliases
445 109 Per Amundsen
/p {
446 108 Per Amundsen
  /echo -ag I am parting $chan
447 108 Per Amundsen
  /part $chan
448 108 Per Amundsen
}
449 108 Per Amundsen
450 108 Per Amundsen
; Script editor
451 108 Per Amundsen
alias p {
452 108 Per Amundsen
  /echo -ag I am parting $chan
453 108 Per Amundsen
  /part $chan
454 108 Per Amundsen
}
455 108 Per Amundsen
</pre>
456 108 Per Amundsen
457 108 Per Amundsen
Almost all built-in commands can be overridden to execute your own script.
458 108 Per Amundsen
459 108 Per Amundsen
*Example*
460 108 Per Amundsen
461 108 Per Amundsen
<pre>
462 108 Per Amundsen
; Create your own /part command
463 108 Per Amundsen
alias part {
464 108 Per Amundsen
  /echo -ag I am parting $chan
465 108 Per Amundsen
  raw PART $chan
466 108 Per Amundsen
}
467 108 Per Amundsen
468 114 Per Amundsen
; Create your own /part command, but execute the built-in /part command after executing your own script.
469 108 Per Amundsen
alias part {
470 108 Per Amundsen
  /echo -ag I am parting $chan
471 108 Per Amundsen
472 108 Per Amundsen
  ; Execute the built-in part command
473 108 Per Amundsen
  !part $chan
474 108 Per Amundsen
}
475 107 Per Amundsen
</pre>
476 113 Per Amundsen
477 113 Per Amundsen
A command can also be called as a $identifier.
478 113 Per Amundsen
479 113 Per Amundsen
*Example*
480 113 Per Amundsen
481 113 Per Amundsen
<pre>
482 113 Per Amundsen
; Create a command.
483 113 Per Amundsen
alias mycommand {
484 115 Per Amundsen
  echo -ag I was called as a $iif($isid,identifier,command)
485 113 Per Amundsen
}
486 113 Per Amundsen
487 113 Per Amundsen
; Call the command as identifier.
488 113 Per Amundsen
//noop $mycommand
489 113 Per Amundsen
490 116 Per Amundsen
; Call the command as a command.
491 113 Per Amundsen
/mycommand
492 113 Per Amundsen
</pre>