Project

General

Profile

Scripting Commands » History » Version 127

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