Project

General

Profile

Scripting Commands » History » Version 128

Per Amundsen, 02/25/2016 12:02 PM

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