Project

General

Profile

Scripting Commands » History » Version 118

Per Amundsen, 10/16/2015 11:15 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 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 118 Per Amundsen
 | *[[/pgoogle]]*
186
*[[/plugins]]*
187 99 Per Amundsen
*[[/priv]]*
188 96 Per Amundsen
[[/query]]
189 95 Per Amundsen
[[/queryrn]]
190 94 Per Amundsen
*[[/quickconnect]]*
191 89 Per Amundsen
*[[/quicksave]]*
192 88 Per Amundsen
[[/quit]]
193 1 Per Amundsen
[[/quote]]
194 85 Per Amundsen
[[/raw]]
195 84 Per Amundsen
*[[/rawx]]*
196
*[[/rawlog]]*
197 85 Per Amundsen
*[[/realname]]*
198 77 Per Amundsen
*[[/reconnect]]*
199 74 Per Amundsen
*[[/rejoin]]*
200 69 Per Amundsen
[[/reload]]
201 67 Per Amundsen
[[/remini]]
202 66 Per Amundsen
[[/remote]]
203 65 Per Amundsen
[[/remove]]
204 63 Per Amundsen
[[/rename]]
205 1 Per Amundsen
[[/renwin]]
206
[[/reseterror]]
207 82 Per Amundsen
[[/resetidle]]
208 27 Per Amundsen
*[[/resolve]]*
209 57 Per Amundsen
*[[/restart]]*
210 1 Per Amundsen
[[/return]]
211 54 Per Amundsen
[[/returnex]]
212 79 Per Amundsen
[[/rlevel]]
213 52 Per Amundsen
[[/rline]]
214 50 Per Amundsen
[[/rmdir]]
215 49 Per Amundsen
[[/run]]
216 80 Per Amundsen
[[/ruser]]
217 45 Per Amundsen
[[/say]]
218 51 Per Amundsen
[[/savebuf]]
219 44 Per Amundsen
[[/scid]]
220 42 Per Amundsen
[[/scon]]
221 1 Per Amundsen
*[[/scripts]]*
222 39 Per Amundsen
*[[/search]]*
223 1 Per Amundsen
[[/server]]
224 37 Per Amundsen
*[[/serverlist]]*
225 1 Per Amundsen
[[/set]]
226 35 Per Amundsen
*[[/setconfig]]*
227 34 Per Amundsen
[[/setlayer]]
228 118 Per Amundsen
 |^. **[[/setoption]]*
229
[[/showadiirc]]*
230 98 Per Amundsen
[[/showmirc]]
231 96 Per Amundsen
[[/signal]]
232 95 Per Amundsen
*[[/slap]]*
233 94 Per Amundsen
*[[/sleep]]*
234 89 Per Amundsen
[[/sline]]
235 88 Per Amundsen
[[/sockaccept]]
236 1 Per Amundsen
[[/sockclose]]
237
[[/socklist]]
238 85 Per Amundsen
[[/socklisten]]
239 84 Per Amundsen
[[/sockmark]]
240 82 Per Amundsen
[[/sockopen]]
241 80 Per Amundsen
[[/sockpause]]
242 79 Per Amundsen
[[/sockread]]
243 78 Per Amundsen
[[/sockrename]]
244 77 Per Amundsen
[[/sockwrite]]
245 75 Per Amundsen
*[[/sop]]*
246 69 Per Amundsen
[[/splay]]
247 67 Per Amundsen
*[[/statusbar]]*
248 66 Per Amundsen
[[/switchbar]]
249 65 Per Amundsen
*[[/tab]]*
250 63 Per Amundsen
*[[/themes]]*
251 1 Per Amundsen
[[/time]]
252 93 Per Amundsen
[[/timestamp]]
253 1 Per Amundsen
[[/timer]]
254 90 Per Amundsen
[[/tip]]
255
[[/tips]]
256 1 Per Amundsen
[[/titlebar]]
257 54 Per Amundsen
[[/tokenize]]
258 52 Per Amundsen
[[/toolbar]]
259 51 Per Amundsen
[[/topic]]
260 50 Per Amundsen
*[[/topicbox]]*
261 49 Per Amundsen
[[/treebar]]
262 81 Per Amundsen
[[/ulist]]
263 87 Per Amundsen
*[[/usernick]]*
264 1 Per Amundsen
*[[/txt2bin]]*
265 46 Per Amundsen
*[[/unban]]*
266 1 Per Amundsen
*[[/unignore]]*
267 44 Per Amundsen
[[/unload]]
268 42 Per Amundsen
*[[/unnotify]]*
269 1 Per Amundsen
[[/unset]]
270 39 Per Amundsen
[[/unsetall]]
271 118 Per Amundsen
 |^. *[[/update]]*
272
[[/var]]
273 98 Per Amundsen
*[[/vars]]*
274 96 Per Amundsen
*[[/viewlog]]*
275 95 Per Amundsen
*[[/voice]]*
276 94 Per Amundsen
[[/vol]]
277 91 Per Amundsen
*[[/wdown]]*
278 90 Per Amundsen
[[/while]]
279 89 Per Amundsen
[[/window]]
280 88 Per Amundsen
*[[/wjump]]*
281 87 Per Amundsen
*[[/wnext]]*
282 1 Per Amundsen
*[[/wpause]]*
283
*[[/wplay]]*
284 85 Per Amundsen
*[[/wprev]]*
285 84 Per Amundsen
[[/write]]
286 82 Per Amundsen
[[/writeini]]
287 81 Per Amundsen
*[[/wsearch]]*
288 80 Per Amundsen
*[[/wseekf]]*
289 79 Per Amundsen
*[[/wseekr]]*
290 78 Per Amundsen
*[[/wselect]]*
291 77 Per Amundsen
*[[/wstop]]*
292 76 Per Amundsen
*[[/wup]]*
293 70 Per Amundsen
 | 
294 16 Per Amundsen
295
h1. System information Commands
296
297 117 Per Amundsen
Output from these are set in [[Options_Dialog|Options]] -> [[Options_Sysinfo|Sysinfo]] and are merely convenient aliases.
298 16 Per Amundsen
299
/sysinfo
300
/gfxinfo
301
/cpuinfo
302 1 Per Amundsen
/meminfo
303 31 Per Amundsen
/diskinfo
304 1 Per Amundsen
/audioinfo
305
/uptime
306
/bw
307
308
h1. Missing Commands
309
310
/abook
311
/aop
312
/avoice
313
/creq
314
/dccserver
315
/dqwindow
316
/firewall
317
/flood
318
/flush
319
/font
320
/fsend
321
/fserve
322
/ghide
323
/gload
324
/gopts
325
/gplay
326
/gpoint
327
/gqreq
328
/groups
329
/gshow
330
/gsize
331
/gstop
332
/gtalk
333
/gunload
334
/ialclear
335
/ialmark
336
/iline
337
/links
338 30 Per Amundsen
/localinfo
339 1 Per Amundsen
/log
340
/pdcc
341
/perform
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>