Project

General

Profile

Scripting Commands » History » Version 139

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