Project

General

Profile

Scripting Commands » History » Version 147

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