Project

General

Profile

Scripting Commands » History » Version 135

Per Amundsen, 04/20/2016 09:21 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 135 Per Amundsen
[[/updatenl]]
283 129 Per Amundsen
[[/url]]
284 123 Per Amundsen
[[/uwho]]
285 118 Per Amundsen
[[/var]]
286 98 Per Amundsen
*[[/vars]]*
287 96 Per Amundsen
*[[/viewlog]]*
288 95 Per Amundsen
*[[/voice]]*
289 94 Per Amundsen
[[/vol]]
290 91 Per Amundsen
*[[/wdown]]*
291 90 Per Amundsen
[[/while]]
292 89 Per Amundsen
[[/window]]
293 88 Per Amundsen
*[[/wjump]]*
294 87 Per Amundsen
*[[/wnext]]*
295 1 Per Amundsen
*[[/wpause]]*
296
*[[/wplay]]*
297 85 Per Amundsen
*[[/wprev]]*
298 84 Per Amundsen
[[/write]]
299 82 Per Amundsen
[[/writeini]]
300 81 Per Amundsen
*[[/wsearch]]*
301 80 Per Amundsen
*[[/wseekf]]*
302 79 Per Amundsen
*[[/wseekr]]*
303 78 Per Amundsen
*[[/wselect]]*
304 77 Per Amundsen
*[[/wstop]]*
305 76 Per Amundsen
*[[/wup]]*
306 16 Per Amundsen
 | 
307
308
h1. System information Commands
309 117 Per Amundsen
310 16 Per Amundsen
Output from these are set in [[Options_Dialog|Options]] -> [[Options_Sysinfo|Sysinfo]] and are merely convenient aliases.
311
312
/sysinfo
313
/gfxinfo
314 1 Per Amundsen
/cpuinfo
315 31 Per Amundsen
/meminfo
316 1 Per Amundsen
/diskinfo
317
/audioinfo
318
/uptime
319
/bw
320
321
h1. Missing Commands
322
323
/aop
324
/avoice
325
/creq
326
/dccserver
327
/dqwindow
328
/firewall
329
/flood
330
/flush
331
/fsend
332
/fserve
333
/ghide
334
/gload
335
/gopts
336
/gplay
337
/gpoint
338
/gqreq
339
/groups
340
/gshow
341
/gsize
342
/gstop
343
/gtalk
344 119 Per Amundsen
/gunload
345 1 Per Amundsen
/ial
346
/ialclear
347 30 Per Amundsen
/links
348 1 Per Amundsen
/localinfo
349
/pdcc
350
/play
351
/playctrl
352
/pop
353
/protect
354
/proxy
355
/pvoice
356
/qme
357
/qmsg
358
/save
359
/sound
360
/speak
361
/sreq
362
/strip
363
/tnick
364
/tray
365
/vcadd
366
/vcmd
367
/vcrem
368
/winhelp
369 105 Per Amundsen
370
h1. Evaluate identifiers from Editbox
371
372
Typing a command in the Editbox with double slashes// will evaluate $identifiers in the line before running it.
373
E.g //echo -ag My nick is $me
374
375 106 Per Amundsen
You can also [[tabcomplete]] identifiers manually using $me<tab>.
376 107 Per Amundsen
377
h1. Creating a new command
378
379 112 Per Amundsen
You can create a new command by opening the menu Tools -> Edit Aliases.
380 107 Per Amundsen
381 108 Per Amundsen
The format for the command is <command> <script to execute>.
382 107 Per Amundsen
383
*Example*
384
385
<pre>
386 108 Per Amundsen
; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'.
387 1 Per Amundsen
/p /part $chan
388 108 Per Amundsen
</pre>
389
390 110 Per Amundsen
You can also add a command from the script editor, the syntax there is alias <command> <script to execute>
391 108 Per Amundsen
392
*Example*
393
394
<pre>
395
; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'.
396
; Same as previous example.
397
alias p /part $chan
398
</pre>
399
400 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.
401 108 Per Amundsen
402
*Example*
403
<pre>
404
; Edit Aliases
405 109 Per Amundsen
/p {
406 108 Per Amundsen
  /echo -ag I am parting $chan
407
  /part $chan
408
}
409
410
; Script editor
411
alias p {
412
  /echo -ag I am parting $chan
413
  /part $chan
414
}
415
</pre>
416
417
Almost all built-in commands can be overridden to execute your own script.
418
419
*Example*
420
421
<pre>
422
; Create your own /part command
423
alias part {
424
  /echo -ag I am parting $chan
425
  raw PART $chan
426
}
427
428 114 Per Amundsen
; Create your own /part command, but execute the built-in /part command after executing your own script.
429 108 Per Amundsen
alias part {
430
  /echo -ag I am parting $chan
431
432
  ; Execute the built-in part command
433
  !part $chan
434
}
435 107 Per Amundsen
</pre>
436 113 Per Amundsen
437
A command can also be called as a $identifier.
438
439
*Example*
440
441
<pre>
442
; Create a command.
443
alias mycommand {
444 115 Per Amundsen
  echo -ag I was called as a $iif($isid,identifier,command)
445 113 Per Amundsen
}
446
447
; Call the command as identifier.
448
//noop $mycommand
449
450 116 Per Amundsen
; Call the command as a command.
451 113 Per Amundsen
/mycommand
452
</pre>