Project

General

Profile

Scripting Commands » History » Version 115

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