Project

General

Profile

Scripting Commands » History » Version 121

Per Amundsen, 10/22/2015 03:18 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 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 118 Per Amundsen
[[/ialmark]]
140 89 Per Amundsen
[[/identd]]
141 1 Per Amundsen
[[/if]]
142 118 Per Amundsen
 | [[/ignore]]
143
[[/inc]]
144 96 Per Amundsen
[[/invite]]
145 94 Per Amundsen
[[/iuser]]
146 89 Per Amundsen
[[/join]]
147 88 Per Amundsen
[[/kick]]
148 85 Per Amundsen
[[/kill]]
149 84 Per Amundsen
*[[/lag]]*
150 78 Per Amundsen
[[/linesep]]
151 77 Per Amundsen
[[/list]]
152 74 Per Amundsen
[[/load]]
153 67 Per Amundsen
[[/loadbuf]]
154 66 Per Amundsen
*[[/lock]]*
155 1 Per Amundsen
*[[/logs]]*
156
[[/logview]]
157
[[/markall]]
158 69 Per Amundsen
[[/mdi]]
159 57 Per Amundsen
[[/me]]
160 1 Per Amundsen
[[/menubar]]
161
[[/mkdir]]
162 85 Per Amundsen
[[/mnick]]
163 52 Per Amundsen
[[/mode]]
164 50 Per Amundsen
[[/msg]]
165 49 Per Amundsen
*[[/msgbox]]*
166 65 Per Amundsen
*[[/mute]]*
167 95 Per Amundsen
*[[/nextunread]]*
168 45 Per Amundsen
[[/nick]]
169 64 Per Amundsen
[[/nickcolumn]]
170 44 Per Amundsen
[[/nicklist]]
171 1 Per Amundsen
[[/nickcolor]]
172 39 Per Amundsen
*[[/nmsg]]*
173 37 Per Amundsen
[[/noop]]
174 36 Per Amundsen
[[/notice]]
175 35 Per Amundsen
[[/notify]]
176 33 Per Amundsen
*[[/np]]*
177 32 Per Amundsen
[[/omsg]]
178 23 Per Amundsen
[[/onotice]]
179 19 Per Amundsen
[[/op]]
180 27 Per Amundsen
*[[/options]]*
181 98 Per Amundsen
[[/parseline]]
182 1 Per Amundsen
[[/part]]
183
[[/partall]]
184
*[[/paths]]*
185 121 Per Amundsen
 | [[/perform]]
186
*[[/pgoogle]]*
187 118 Per Amundsen
*[[/plugins]]*
188 99 Per Amundsen
*[[/priv]]*
189 96 Per Amundsen
[[/query]]
190 95 Per Amundsen
[[/queryrn]]
191 94 Per Amundsen
*[[/quickconnect]]*
192 89 Per Amundsen
*[[/quicksave]]*
193 88 Per Amundsen
[[/quit]]
194 1 Per Amundsen
[[/quote]]
195 85 Per Amundsen
[[/raw]]
196 84 Per Amundsen
*[[/rawx]]*
197
*[[/rawlog]]*
198 85 Per Amundsen
*[[/realname]]*
199 77 Per Amundsen
*[[/reconnect]]*
200 74 Per Amundsen
*[[/rejoin]]*
201 69 Per Amundsen
[[/reload]]
202 67 Per Amundsen
[[/remini]]
203 66 Per Amundsen
[[/remote]]
204 65 Per Amundsen
[[/remove]]
205 63 Per Amundsen
[[/rename]]
206 1 Per Amundsen
[[/renwin]]
207
[[/reseterror]]
208 82 Per Amundsen
[[/resetidle]]
209 27 Per Amundsen
*[[/resolve]]*
210 57 Per Amundsen
*[[/restart]]*
211 1 Per Amundsen
[[/return]]
212 54 Per Amundsen
[[/returnex]]
213 79 Per Amundsen
[[/rlevel]]
214 52 Per Amundsen
[[/rline]]
215 50 Per Amundsen
[[/rmdir]]
216 49 Per Amundsen
[[/run]]
217 80 Per Amundsen
[[/ruser]]
218 45 Per Amundsen
[[/say]]
219 51 Per Amundsen
[[/savebuf]]
220 44 Per Amundsen
[[/scid]]
221 42 Per Amundsen
[[/scon]]
222 1 Per Amundsen
*[[/scripts]]*
223 39 Per Amundsen
*[[/search]]*
224 1 Per Amundsen
[[/server]]
225 37 Per Amundsen
*[[/serverlist]]*
226 1 Per Amundsen
[[/set]]
227
*[[/setconfig]]*
228 120 Per Amundsen
 |^. [[/setlayer]]
229
**[[/setoption]]*
230 118 Per Amundsen
[[/showadiirc]]*
231 98 Per Amundsen
[[/showmirc]]
232 96 Per Amundsen
[[/signal]]
233 95 Per Amundsen
*[[/slap]]*
234 94 Per Amundsen
*[[/sleep]]*
235 89 Per Amundsen
[[/sline]]
236 88 Per Amundsen
[[/sockaccept]]
237 1 Per Amundsen
[[/sockclose]]
238
[[/socklist]]
239 85 Per Amundsen
[[/socklisten]]
240 84 Per Amundsen
[[/sockmark]]
241 82 Per Amundsen
[[/sockopen]]
242 80 Per Amundsen
[[/sockpause]]
243 79 Per Amundsen
[[/sockread]]
244 78 Per Amundsen
[[/sockrename]]
245 77 Per Amundsen
[[/sockwrite]]
246 75 Per Amundsen
*[[/sop]]*
247 69 Per Amundsen
[[/splay]]
248 67 Per Amundsen
*[[/statusbar]]*
249 66 Per Amundsen
[[/switchbar]]
250 65 Per Amundsen
*[[/tab]]*
251 63 Per Amundsen
*[[/themes]]*
252 1 Per Amundsen
[[/time]]
253 93 Per Amundsen
[[/timestamp]]
254 1 Per Amundsen
[[/timer]]
255 90 Per Amundsen
[[/tip]]
256
[[/tips]]
257 1 Per Amundsen
[[/titlebar]]
258 54 Per Amundsen
[[/tokenize]]
259 52 Per Amundsen
[[/toolbar]]
260 51 Per Amundsen
[[/topic]]
261 50 Per Amundsen
*[[/topicbox]]*
262 49 Per Amundsen
[[/treebar]]
263 81 Per Amundsen
[[/ulist]]
264 87 Per Amundsen
*[[/usernick]]*
265 1 Per Amundsen
*[[/txt2bin]]*
266 46 Per Amundsen
*[[/unban]]*
267 1 Per Amundsen
*[[/unignore]]*
268
[[/unload]]
269 42 Per Amundsen
*[[/unnotify]]*
270 1 Per Amundsen
[[/unset]]
271 120 Per Amundsen
 |^. [[/unsetall]]
272
*[[/update]]*
273 118 Per Amundsen
[[/var]]
274 98 Per Amundsen
*[[/vars]]*
275 96 Per Amundsen
*[[/viewlog]]*
276 95 Per Amundsen
*[[/voice]]*
277 94 Per Amundsen
[[/vol]]
278 91 Per Amundsen
*[[/wdown]]*
279 90 Per Amundsen
[[/while]]
280 89 Per Amundsen
[[/window]]
281 88 Per Amundsen
*[[/wjump]]*
282 87 Per Amundsen
*[[/wnext]]*
283 1 Per Amundsen
*[[/wpause]]*
284
*[[/wplay]]*
285 85 Per Amundsen
*[[/wprev]]*
286 84 Per Amundsen
[[/write]]
287 82 Per Amundsen
[[/writeini]]
288 81 Per Amundsen
*[[/wsearch]]*
289 80 Per Amundsen
*[[/wseekf]]*
290 79 Per Amundsen
*[[/wseekr]]*
291 78 Per Amundsen
*[[/wselect]]*
292 77 Per Amundsen
*[[/wstop]]*
293 76 Per Amundsen
*[[/wup]]*
294 70 Per Amundsen
 | 
295 16 Per Amundsen
296
h1. System information Commands
297
298 117 Per Amundsen
Output from these are set in [[Options_Dialog|Options]] -> [[Options_Sysinfo|Sysinfo]] and are merely convenient aliases.
299 16 Per Amundsen
300
/sysinfo
301
/gfxinfo
302
/cpuinfo
303 1 Per Amundsen
/meminfo
304 31 Per Amundsen
/diskinfo
305 1 Per Amundsen
/audioinfo
306
/uptime
307
/bw
308
309
h1. Missing Commands
310
311
/abook
312
/aop
313
/avoice
314
/creq
315
/dccserver
316
/dqwindow
317
/firewall
318
/flood
319
/flush
320
/font
321
/fsend
322
/fserve
323
/ghide
324
/gload
325
/gopts
326
/gplay
327
/gpoint
328
/gqreq
329
/groups
330
/gshow
331
/gsize
332
/gstop
333
/gtalk
334
/gunload
335 119 Per Amundsen
/ial
336 1 Per Amundsen
/ialclear
337
/iline
338 30 Per Amundsen
/links
339 1 Per Amundsen
/localinfo
340
/log
341
/pdcc
342
/play
343
/playctrl
344
/pop
345
/protect
346
/proxy
347
/pvoice
348
/qme
349
/qmsg
350
/save
351
/saveini
352
/sockudp
353
/sound
354
/speak
355
/sreq
356
/strip
357
/tnick
358
/tray
359
/updatenl
360
/url
361
/uwho
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>