Project

General

Profile

Scripting Commands » History » Version 133

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