Project

General

Profile

Scripting Commands » History » Version 143

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