Project

General

Profile

Scripting Commands » History » Version 140

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