Project

General

Profile

Scripting Commands » History » Version 130

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