Project

General

Profile

Scripting Commands » History » Version 141

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