Project

General

Profile

Scripting Commands » History » Version 123

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