Project

General

Profile

Scripting » History » Version 134

Per Amundsen, 04/07/2012 12:09 AM

1 42 Per Amundsen
h1. Notice: this is info for 1.8.8 and higher.
2 39 Per Amundsen
3 1 Per Amundsen
h1. Scripting
4
5
In the latest beta's, I am experimenting with a little more advanced scripting features and I will use this wiki to track progress and features.
6
7 8 Per Amundsen
Syntax, variables and functions will probably change a lot, so don't except previous scripts to still work in the next beta and so forth.
8 1 Per Amundsen
9 30 Per Amundsen
There are 2 types of scripting at the moment, one that have been here for a long time, and a new system.
10 16 Per Amundsen
11 38 Per Amundsen
All scripting is done in Commands -> Edit Commands where one line represent a script or a custom command and its trigger is one of 3 ways:
12
13
/something<whitespace> 
14 37 Per Amundsen
keys<whitespace>
15
OnEvent<whitespace>
16 16 Per Amundsen
17 1 Per Amundsen
Please note that variables and functions are *different* for these 2 types of scripts.
18 37 Per Amundsen
19
You can comment out a command by putting a # in front of it.
20 17 Per Amundsen
21 1 Per Amundsen
h1. Normal custom commands:
22 26 Per Amundsen
23 25 Per Amundsen
<pre>Syntax = /something<whitespace>/somethingelse</pre>
24 16 Per Amundsen
25 23 Per Amundsen
Here are some variables which can be used in Custom Commands, its like creating aliases of already available commands, e.g <pre>/hi /me says hi to $chan</pre> will show <pre>* kr0n says hi to #adiirc</pre> when typing <pre>/hi</pre>
26 16 Per Amundsen
27 32 Per Amundsen
Current variables are $1 to $9, $params, $chan and $me. $1 to $9 represents what you type after /yourcommand e.g <pre>/sup /say whats up $1</pre> when typing <pre>/sup kr0n</pre> it will show like this <pre>User: whats up kr0n</pre>
28 16 Per Amundsen
29 29 Per Amundsen
$params represents everything written after /yourcommand, $chan replaces itself with current channel and $me replaces itself with your current usernick. 
30 16 Per Amundsen
31 131 Per Amundsen
You can make combo commands by using | as a seperator, e.g <pre>/hi /me says hi to $chan | /me says hi again to $chan</pre>
32 16 Per Amundsen
33 1 Per Amundsen
$file[path] returns data from a file, $frand[path] fetchs a random line from a file and $floop[path] gets one line increasingly (line1, then line2, then line3 etc).
34 23 Per Amundsen
35 27 Per Amundsen
h1. Custom Commands by hotkeys
36 1 Per Amundsen
37 25 Per Amundsen
<pre>Syntax = key&key<whitespace>/something</pre>
38 1 Per Amundsen
39 27 Per Amundsen
In addition to making a custom command trigger by typing a /slash command, you make it trigger with a hotkey instead (note, these commmands will not be useable from the new scripting engine)
40
41 23 Per Amundsen
Useable modifies are ctrl, alt and shift and any character or number or F key.
42
43
An example
44
45 24 Per Amundsen
<pre>ctrl&o /msg $chan ohai i just pressed ctrl and o</pre>
46 23 Per Amundsen
47 1 Per Amundsen
Everytime you press ctrl and 'o' now, this command will be fired off.
48 24 Per Amundsen
49
<pre>ctrl&alt&o /msg $chan ohai i just pressed ctrl and alt and o</pre>
50
51 1 Per Amundsen
Everytime you press ctrl and alt and 'o' now, this command will be fired off.
52 16 Per Amundsen
53 27 Per Amundsen
h1. Unified Scripting
54 1 Per Amundsen
55 27 Per Amundsen
<pre>Syntax = OnEvent<whitespace>code</pre>
56
57 1 Per Amundsen
The new scripting tries to combine normal client commands, your custom commands, functions and events into one scripting language.
58
59 25 Per Amundsen
In Commands -> Edit Commands you can enter a scripting line with the following syntax:
60 1 Per Amundsen
61
Followed by either an expression like this (works recursivly)
62
63
<pre>
64
if (SOMETING == SOMETHINGELSE) { EXECUTE HERE }
65
if (SOMETING != SOMETHINGELSE) { EXECUTE HERE }
66 13 Per Amundsen
if (SOMETING ismatch SOMETHINGELSE) { EXECUTE HERE }</pre>
67 1 Per Amundsen
or by an executed command or function
68
69 2 Per Amundsen
You can now combine expressions with && (AND) and || (OR) like this
70 1 Per Amundsen
<pre>
71 2 Per Amundsen
if (SOMETHING == SOMETHING && SOMETHINGELSE != SOMETHINGELSE) { EXECUTE HERE }
72 13 Per Amundsen
if (SOMETHING == SOMETHING || SOMETHINGELSE != SOMETHINGELSE) { EXECUTE HERE }</pre>
73 1 Per Amundsen
The logic behind these expressions is not fully tested, id love any feedback on this.
74 33 Per Amundsen
75
It is also possible to use else if like this
76
<pre>if (SOMETHING == SOMETHING) { EXECUTE HERE } else if (SOMETHINGELSE == SOMETHINGELSE) { EXECUTE HERE }</pre>
77
In the future just "else" will be possible to.
78 12 Per Amundsen
79
(note: ismatch will check if SOMETHING exist inside SOMETHINGELSE e.g if something is "hello" and something else is "hello world" it would return True because "hello" exist)
80 2 Per Amundsen
81 1 Per Amundsen
Executed commands are /slash commands already in the client e.g /msg #channel hello world.
82
Executed functions are predefined functions in the client, only two exists for now.
83
84 131 Per Amundsen
An execution block can consist of both commands and functions if seperated by | (pipe) character like this <pre>/msg #channel hello world | .function bla bla | /msg #channel2 hello world</pre>
85 1 Per Amundsen
86
Furthermore there is a lot of predefined variables for use with these functions, for now they are:
87
88
$event / current event, e.g PRIVMSG 001 MODE and so forth
89
$channel / the channel the event occurred on, if any
90
$msg / the message to the channel/user or the message in a raw irc line e.g whois [kr0n] is a registered nick
91
$nick / the nick the event was sent from, can be a irc.server.com, a nick or null
92
$me / my current nick
93
$network / the network the event occured on e.g Quakenet
94
$ident / the from user ident if any
95
$host / the from user hostname if any
96
$myident / my ident
97
$myhost / my host
98 14 Per Amundsen
$server / host from the server e.g irc.server.com
99 1 Per Amundsen
100
Currently predefined functions are:
101
<pre>
102 36 Per Amundsen
.insert <nick (use null for nonick)> 
103
<where (a channel or $channel, a nick or $nick, or status)> 
104
<MsgType (MsgServer/MsgUser/MsgEmote/MsgCTCP/MsgNotice/MsgClient/MsgLog)> 
105
<$msg or message></pre>
106 1 Per Amundsen
107
<pre>
108 13 Per Amundsen
.eat <what (text or all)></pre>
109 1 Per Amundsen
.insert is used for inserting a specific message type into a chat window, its intended for use in cases where you want to override how adiirc shows a given event, but can also be used for adding additional messages.
110
111
.eat is used to tell adiirc to either "eat" the text output from an event or "eat" everything and don't act on this event at all.
112
113
Putting it all togheter, here are a few examples:
114
115
<pre>
116 131 Per Amundsen
OnEvent if ($event == NOTICE) { if ($msg ismatch hi there) { .insert $nick status MsgNotice $msg | .eat text } }</pre>
117 1 Per Amundsen
118
insert the notice into the server window and tells adiirc to "eat" its own text output from this notice
119
120
<pre>
121 41 Per Amundsen
OnEvent if ($event == PRIVMSG && $msg == herp) { /msg $channel derp }</pre>
122 7 Per Amundsen
123 1 Per Amundsen
if the event is a PRIVMSG AND the $msg equals "herp", then show "derp" in the channel
124
125 6 Per Amundsen
<pre>
126 13 Per Amundsen
OnEvent if ($event == PRIVMSG) { if ($nick == Q || $nick == $me) { /msg $channel Q or $me is speaking! } }</pre>
127 1 Per Amundsen
128
if the event is a PRIVMSG and the $nick equals "Q" OR $me then show "Q or $me is speaking" in the channel
129 9 Per Amundsen
130 34 Per Amundsen
<pre>OnEvent if ($event == OnOp && $nick == $me) { /msg $channel Thx for op! }</pre>
131
132 35 Per Amundsen
if the event is OnOp and the target nick is me, then show "Thx for op!" in the channel
133
134 3 Per Amundsen
A list of custom events that is also usable as $event ==
135 4 Per Amundsen
<pre>
136 3 Per Amundsen
OnOwner
137
OnDeOwner
138
OnSpecialOp
139
OnSpecialDeOp
140
OnOp
141
OnDeOp
142
OnHop
143
OnDeHop
144 1 Per Amundsen
OnVoice
145 42 Per Amundsen
OnDeVoice
146 46 Per Amundsen
</pre>
147 1 Per Amundsen
148 46 Per Amundsen
h1. Scripting changes in latest beta
149
This does not apply to the latest stable release!
150 1 Per Amundsen
151
*Scripting is now unified completly which means all variables applies to all scripts and:
152 112 Per Amundsen
$file[path] is now $file(path);
153 111 Per Amundsen
$frand[path] is now $frand(path);
154 131 Per Amundsen
$floop[path] is now $floop(path);
155
COMMAND|COMMAND must now be COMMAND | COMMAND for parsing simplicity, please update your scripts to this format*
156 111 Per Amundsen
157 60 Per Amundsen
*OnEvent* is now executed *AFTER* the event, use *OnBeforeEvent* for events where you want to .eat or in other ways manipulate the event.
158
159 119 Per Amundsen
Shorter aliases are added for simplicity.
160
<pre>
161
OnCommand /command { EXECUTE }
162
163 120 Per Amundsen
On EVENT { EXECUTE }
164 119 Per Amundsen
165
OnBefore EVENT { EXECUTE }
166
</pre>
167 118 Per Amundsen
168 50 Per Amundsen
New command /nmsg added for cross network output, and a new event OnSongChanged. 
169 1 Per Amundsen
170 50 Per Amundsen
Combine them and you can automatically announce song changes in a channel or to a user with:
171
172 42 Per Amundsen
<pre>
173 123 Per Amundsen
OnEvent if ($event == OnSongChanged) { /nmsg <network> <channel/Nick> $0-; }
174 42 Per Amundsen
</pre>
175 62 Per Amundsen
176 42 Per Amundsen
Announce to several channels with:
177 62 Per Amundsen
178 42 Per Amundsen
<pre>
179 123 Per Amundsen
OnEvent if ($event == OnSongChanged) { /nmsg <network> <channel/Nick> $0-;/nmsg <network> <channel/Nick> $0-; }
180 42 Per Amundsen
</pre>
181 1 Per Amundsen
182 61 Per Amundsen
Network is the network name where the channel is, e.g NordicIRC, freenode, Quakenet, look at the name of the server window you are connected on to find it.
183 46 Per Amundsen
184
Also added is better escaping, variables and a "null" variable, e.g
185
186
<pre>
187 125 Per Amundsen
OnEvent if ($event == PRIVMSG) { if (%test == null) { %test = SOMETHING;/echo test is %test } }
188 46 Per Amundsen
</pre>
189
190 95 Per Amundsen
New variable $now returns unixtime/ctime from current time.
191 97 Per Amundsen
New variable $active returns the current window Status/#channel/Nick.
192 104 Per Amundsen
New variable $! returns how many $0 $1 etc variables are filled (not sure if final name of it)
193 132 Per Amundsen
New variable $r! returns how many $raw0 $raw1 etc variables are filled (not sure if final name of it)
194
New variable $activeserver returns an id for current server
195
New variable $status returns current server status
196 95 Per Amundsen
197 116 Per Amundsen
These variables are saved into vars.ini unless removed (%var set to null) and reloaded when adiirc starts.
198 89 Per Amundsen
You can change/use them in any script.
199 48 Per Amundsen
200 49 Per Amundsen
Note also that all user set variables starts with % and client variables starts with $.
201
202 91 Per Amundsen
Some commands for manipulate variables:
203
204
<pre>
205 93 Per Amundsen
/set {-u seconds/-d] [%var] [value] / create or update a variable with value -u seconds, will delete the variable after X seconds, -d will decrease its value by 1 every second, then remove it
206 92 Per Amundsen
207 91 Per Amundsen
/unset [var] / deletes a variable
208 92 Per Amundsen
209 93 Per Amundsen
/inc {-u seconds/-d] [%var] [value] / increases a variable with value (only if value and var is ints) -u seconds, will delete the variable after X seconds, -d will decrease its value by 1 every second, then remove it
210 92 Per Amundsen
211 93 Per Amundsen
/dec {-u seconds/-d] [%var] [value] / decreases a variable with value (only if value and var is ints) -u seconds, will delete the variable after X seconds, -d will decrease its value by 1 every second, then remove it
212 92 Per Amundsen
213
/vars shows a list of all variables and their values
214 91 Per Amundsen
</pre>
215
216 126 Per Amundsen
var %variable = 4242, %variable2 = 4343; will create local variables that gets deleted when the script is done.
217 134 Per Amundsen
using += instead of = will append to the variable, if both variable and new value is numbers it will combine them to a new number %variable += 4242.
218 126 Per Amundsen
219 1 Per Amundsen
Variables is still work in progress, id love some feedback/ideas of what it can be used for.
220 50 Per Amundsen
221 99 Per Amundsen
halt can now be used instead of .eat all, it will halt immediately, ignoring rest of the script.
222
return will halt immediately, ignoring rest of the script, but not eat anything.
223
224 51 Per Amundsen
<pre>
225 73 Per Amundsen
OnLoad / Called when the script is loaded
226
OnUnload / Called when the script is unloaded
227
OnReload / Called when the script is reloaded
228
OnConnecting / Called when a server is connecting
229
OnLookingUp / Called when a server is looking up the hostname
230
OnConnected / Called when a server is connected
231
OnDisconnect / Called when a server gets disconnected
232 124 Per Amundsen
OnCommand / Called whenever a user types a /slash command in the client ($0- will hold the full command, $0 will be the first word, $1 the second and so on)
233 99 Per Amundsen
OnCTCPRequest / Called when a user recives a CTCP request
234
OnCTCPReply / Called when a user recives a CTCP reply
235 1 Per Amundsen
ACTION / Called when a user recives a ACTION (/me) message
236 100 Per Amundsen
OnNickChanged / Called when a user's nick changes, will only trigger on the user unlike NICK who triggers for everyone
237 123 Per Amundsen
OnSongChanged / Called when a song is changed in the selected media player
238 51 Per Amundsen
</pre>
239
240
A few examples using these.
241 1 Per Amundsen
242
<pre>
243
OnEvent if ($event == OnLoad) { %myvariable = This was set at startup }
244
OnEvent if ($event == OnUnLoad) { .msgbox varible set at startup was %myvariable }
245
OnEvent if ($event == OnReLoad) { .msgbox Script reloaded }
246 99 Per Amundsen
OnEvent if ($event == OnConnecting) { /echo i r conecting }
247
OnEvent if ($event == OnLookingUp ) { /echo i r looking up hostname }
248
OnEvent if ($event == OnConnected ) { /echo i r connected }
249
OnEvent if ($event == OnDisconnect) { /echo i r disconnected }
250
OnEvent if ($event == OnCommand) { if ($0 == /me) { /echo i typed /me } }
251
OnEvent if ($event == OnCommand) { /echo i typed $0, full command was $0- }
252 100 Per Amundsen
OnEvent if ($event == OnCTCPRequest) { /echo CTCP Request $0- from $nick }
253
OnEvent if ($event == OnCTCPReply) { /echo CTCP Reply $0- from $nick }
254 1 Per Amundsen
OnEvent if ($event == ACTION) { /echo ACTION $0- from $nick }
255 123 Per Amundsen
OnEvent if ($event == OnNickChanged) { /echo My nick is now $0 } 
256 52 Per Amundsen
OnEvent if ($event == OnSongChanged) { /echo Song changed to $0- }
257 53 Per Amundsen
</pre>
258 1 Per Amundsen
259 132 Per Amundsen
New Operators, all operators can now use ! to reverse the logic e.g !ison. If no operators are added it will test if remaining text is not null if (%test), if ($channel) or if (!$channel) etc.
260 65 Per Amundsen
261
<pre>
262 101 Per Amundsen
> / Will try and cast left and right variable to int and try "int1 greater than int2"
263
< / Will try and cast left and right variable to int and try "int1 lower than int2"
264
>= / Will try and cast left and right variable to int and try "int1 greater than or equal to int2"
265
<= / Will try and cast left and right variable to int and try "int1 lower than or equal to int2"
266
isbetween / Will try and cast left variable to int and right variable have to be int-int, e.g "40 isbetween 30-50"
267
ison / check if ($nick ison $channel) nick is the channel
268
isop / check if ($nick isop $channel) is operator on the channel
269
ishop / check if ($nick ishop $channel) is half operator on the channel
270
issop / check if ($nick issop $channel) is special operator on the channel
271
isowner / check if ($nick isowner $channel) is channel owner
272
hasvoice / check if ($nick hasvoice $channel) have voice on the channel
273
inchan / check if i am in chan (#channel inchan) (#channel !inchan)
274
isnum / check something is a number (5 isnum) (5 !isnum)
275 65 Per Amundsen
</pre>
276
277 53 Per Amundsen
A complete rewrite of the parser logic is done, introducing the "else" keyword, and you can now use any nested length of "if" "else if" and "else" e.g:
278
279
<pre>
280 54 Per Amundsen
OnEvent if ($event == PRIVMSG) 
281
{ 
282 55 Per Amundsen
	if (%test == null) { 
283 125 Per Amundsen
		/echo Hello world; 
284 55 Per Amundsen
		if (%test == null) 
285
		{ 
286 125 Per Amundsen
			/echo Hello world; 
287 56 Per Amundsen
		} 
288 1 Per Amundsen
	} 
289
	else if (%test == null) 
290
	{ 
291 125 Per Amundsen
		/echo Hello world
292 1 Per Amundsen
	} 
293 55 Per Amundsen
	else (%test == null) 
294 54 Per Amundsen
	{ 
295 125 Per Amundsen
		/echo Hello world 
296 55 Per Amundsen
	} 
297
	if (%test == null) 
298
	{ 
299 125 Per Amundsen
		/echo Hello world 
300 54 Per Amundsen
	} 
301
}
302 53 Per Amundsen
</pre>
303
304 1 Per Amundsen
also ; is now useable like | for line ending.
305 54 Per Amundsen
306 57 Per Amundsen
Simple kickcounter script:
307
<pre>
308 122 Per Amundsen
OnBeforeEvent if ($event == OnCommand) { 
309 117 Per Amundsen
	if ($0 != /kick) 
310
	{
311
		return; 
312
	}
313
		
314
	if (%kickcount == null) 
315 1 Per Amundsen
	{ 
316 117 Per Amundsen
		%kickcount = 0; 
317
	}
318 68 Per Amundsen
319 117 Per Amundsen
	%kickcount++;
320 68 Per Amundsen
		 
321 133 Per Amundsen
	if (!$2) 
322 117 Per Amundsen
	{ 
323
		/kick $channel $1 Kick number %kickcount;
324
		halt; 
325 69 Per Amundsen
	} 
326
}
327 85 Per Amundsen
</pre>
328 69 Per Amundsen
329
You can now use "-" on $<number> variables to get all words from $<number> and after.
330
331
<pre>
332
OnEvent if ($event == OnCommand) { /echo $2- }
333 85 Per Amundsen
</pre>
334 69 Per Amundsen
335
When you type "/msg $me this is a test" you will get only "this is a test"
336
337
<pre>
338
OnEvent if ($event == OnCommand) { /echo $3- }
339 85 Per Amundsen
</pre>
340 1 Per Amundsen
341
When you type "/msg $me this is a test" you will get only "is a test"
342
343
<pre>
344 100 Per Amundsen
OnEvent if ($event == OnCommand) { /echo $0- }
345 1 Per Amundsen
</pre>
346
347 73 Per Amundsen
When you type "/msg $me this is a test" you will get "/msg $me this is a test"
348 76 Per Amundsen
349 79 Per Amundsen
$0- is now equal to $params and $msg, and $0 will return the first part e.g the command "/msg"
350 73 Per Amundsen
351 74 Per Amundsen
Also you can use $raw<number> like $raw0 $raw1 $raw0- to get parts of the raw irc message. This will likely be the default way when better parsing functions are added.
352
353
Several functions are added, they are all recursive and you can use any %variable or $variable as parameters:
354
They are also usable inside if () statements.
355 128 Per Amundsen
All variable numbers are floats and all functions supports floats for precise calculations.
356 74 Per Amundsen
<pre>
357
$replace(text, text2, text3) / replace all occurrences of text2 in text with text3
358
$upper(text) / return text uppercase
359
$lower(text) return text lowercase
360
$mid(text, startpos, endpos) / return part of text from startpos to endpos
361
$substr(text, startpos, endpos) / return part of text from startpos to endpos
362
$left(text, pos) / return pos characters starting from left of the text
363
$right(text, pos) / return pos characters starting from right of the text
364
$remove(text, text2) / replace all occurrences of text2 from text
365
$len(text) / return length of text
366
$count(text, text2) / counts all occurrences of text2 in text
367 77 Per Amundsen
$pos(text, text2) / returns first occurrences position of text2 in text
368
$lastpos(text, text2) / returns last occurrences position of text2 in text
369 96 Per Amundsen
$strip(text) / removes all color and font tags
370 1 Per Amundsen
$repeat(text, times) / repeats text X times
371
$insert(text, text2, pos) / inserts text2 into pos of text
372 132 Per Amundsen
$chr(num) / returns ascii character from the number num
373
$char(num) / returns ascii character from the number num
374
375 1 Per Amundsen
$calc(formula) / calculate any variation of +-*/
376 112 Per Amundsen
$formatdate(date, text) / formats a unix timestamp into date using date variables %d %m %y etc
377
$fdate(date, text) / formats a unix timestamp into date using date variables %d %m %y etc
378 1 Per Amundsen
$host(nick) / returns the hostmask of nick
379
$ident(nick) / returns the ident of nick
380
$(number) / dynamically gets a $0 $1 $2 variable e.g $(1) is same as $1 (not sure if final function name)
381 132 Per Amundsen
$cond(cond, execute1, execute2) / checks if cond is true then executes execute1, else executes execute2, will return string if not at the begining of the line
382
$iif(cond, execute1, execute2) / checks if cond is true then executes execute1, else executes execute2, will return string if not at the begining of the line
383
$round(num, decimals) / rounds down a float to X decimals
384
$regex(text, pattern) / does a regular expression test if text matches pattern, then returns the matched part
385
386 1 Per Amundsen
$file(path) / reads file to end and returns the entire output without newlines
387
$fileloop(path) / reads through a file one line at the time, line increases +1 every time the same file is called
388
$floop(path) / reads through a file one line at the time, line increases +1 every time the same file is called
389 113 Per Amundsen
$filerandom(path) / returns a random line from a file
390 1 Per Amundsen
$frand(path) / returns a random line from a file
391 132 Per Amundsen
392
$chan(num) / if num is 0 returns how many channels you are joined on this server else returns channel name in position num
393
$user(#chan, num) / if num is 0 returns how many users are on this #chan else returns nick in position num
394
$nick(#chan, num) / if num is 0 returns how many users are on this #chan else returns nick in position num
395
$server(num) / if num is 0 returns how many servers you are connected to else returns server id in position num
396 75 Per Amundsen
</pre>
397
398 1 Per Amundsen
All paths needs to be escaped e.g c:\\users\\kr0n\\file.txt if only a filename is entered, the script directory will be used.
399
All characters that needs to be escaped before used as strings are \ { } ;
400 134 Per Amundsen
In some cases you might have to escape ( ) | , # $ %
401
/* and */ needs to be escaped if you want to display them together\/* and \*/
402 75 Per Amundsen
403
<pre>
404 125 Per Amundsen
OnEvent if ($event == JOIN) { /echo $replace(this is a test, test, replaced test) }
405 82 Per Amundsen
</pre>
406 1 Per Amundsen
407
Shows "this is a replaced test"
408
409
<pre>
410 125 Per Amundsen
OnEvent if ($event == JOIN) { /echo $replace($replace(this is a test, test, replaced test), replaced test, replaced again test) }
411 106 Per Amundsen
</pre>
412 1 Per Amundsen
413 106 Per Amundsen
Shows "this is a replaced again test"
414
415 1 Per Amundsen
Here is an fullblown kickban example script using the script editor
416 106 Per Amundsen
<pre>
417 117 Per Amundsen
OnCommand /kb {
418 133 Per Amundsen
	if (!$1) {
419 117 Per Amundsen
		/echo /kb - Nick missing;
420
		return;
421
	}
422
423 126 Per Amundsen
	var %msg = $iif($channel, $2-, $3-);
424
	var %chan = $iif($channel, $channel, $2);
425 117 Per Amundsen
		
426 106 Per Amundsen
	# Set this for default ban reason, or remove for no default reason
427 126 Per Amundsen
	# Can be shortened to %msg = $iif(%msg, %msg, GTFO);
428 133 Per Amundsen
	if (!%msg) {
429 117 Per Amundsen
		%msg = GTFO;
430
	}
431
432
	if ($me isop %chan) {
433
		/raw MODE %chan +b *!$ident($1)@$host($1);
434 106 Per Amundsen
		/raw KICK %chan $1 %msg;
435
	} else {
436 117 Per Amundsen
		/echo You are not oper on %chan;
437
	}
438 106 Per Amundsen
}
439
</pre>
440
441
Simple calculator script:
442 1 Per Amundsen
<pre>
443 117 Per Amundsen
OnCommand /calc {
444 133 Per Amundsen
	if (!$1) {
445 1 Per Amundsen
		/echo /calc - Parameters missing;
446 117 Per Amundsen
		return;
447 106 Per Amundsen
	}
448 87 Per Amundsen
		
449
	# typing /calc -p <expression> sends output to channel
450 1 Per Amundsen
	if ($1 == -p) {
451 87 Per Amundsen
		/msg $channel Calculating : $2-;
452
		/msg $channel Result is : $calc($2-);
453 102 Per Amundsen
	} else {
454 87 Per Amundsen
		/echo Calculating : $1-;
455 106 Per Amundsen
		/echo Result is : $calc($1-);
456
	}
457
}
458
</pre>
459
460
Colored version
461
<pre>
462 117 Per Amundsen
OnCommand /calc {
463 133 Per Amundsen
	if (!$1) {
464 106 Per Amundsen
		/echo /calc - Parameters missing;
465 117 Per Amundsen
		return;
466 106 Per Amundsen
	}
467 98 Per Amundsen
	
468
	# typing /calc -p <expression> sends output to channel
469
	if ($1 == -p) {
470
		/msg $channel $chr(3)4Calculating : $2-;
471
		/msg $channel $chr(3)4Result is : $calc($2-);
472 106 Per Amundsen
	} else {
473
		/echo $chr(3)4Calculating : 4$1-;
474
		/echo $chr(3)4Result is : $calc($1-);
475
	}
476
}
477 104 Per Amundsen
</pre>
478 106 Per Amundsen
479
CTCP flood detection example
480
481 103 Per Amundsen
<pre>
482
OnEvent if ($event == OnCTCPRequest) {
483 133 Per Amundsen
	if (!%count) {
484 103 Per Amundsen
		/set -u 10 %count 1;
485
	} else {
486
		/inc -u 10 %count 1;
487
	}
488 105 Per Amundsen
			
489 103 Per Amundsen
	if (%count > 4) {
490
		/ignore -u 30 -t $nick!$ident@$host;
491
	}
492
}
493
</pre>
494
495
while (CONDITION) { EXECUTE } is now useable for a loop
496
497
Mass mode example
498
499
<pre>
500 117 Per Amundsen
OnCommand /mass {
501 133 Per Amundsen
	if (!$2) {
502 103 Per Amundsen
		/echo /mass - Parameters missing [+/-<mode> <nick> <nick> <nick>];
503 117 Per Amundsen
		return;
504 103 Per Amundsen
	}
505
506 1 Per Amundsen
	%len = 2;
507
	
508 117 Per Amundsen
	# equal to while (%len <= $count(%len, $chr(32)))
509 1 Per Amundsen
	while (%len <= $!) {
510
		if ($(%len) ison $channel) {
511
			/mode $channel $1 $(%len);
512
		}
513
514
		/inc %len;
515
	}
516
}
517
</pre>
518 121 Per Amundsen
519
It is now possible to use custom commands as functions, lets say you make a /calc like this.
520
521
<pre>
522
OnCommand /mycalc {
523
	return $calc($0+$1);
524
}
525
</pre>
526
527
Then you can call this function with eiter /mycalc <number> <number> the normal way or $mycalc(<number, <number>) like this
528
<pre>
529
OnCommand /testcalc {
530
	/echo $0 + $1 is $mycalc($0, $1);
531
	/echo 5 + 4 is $mycalc(5, 4);
532
}
533
</pre>
534
535
Typing /testcalc will show the result. These custom functions are fully nested like the client functions.
536 129 Per Amundsen
537
Simple convert temperature C to F or F to C
538
<pre>
539 1 Per Amundsen
OnCommand /temp {
540
	if ($1 == C) {
541
		/echo $round($calc(($2 * 9/5) + 32), 1) F;
542
	} elseif ($1 == F) {
543
		/echo $round($calc(($2 - 32) * 5/9), 1) C;
544
	}
545
}
546
</pre>
547
/temp C 20 will print 68 F
548 132 Per Amundsen
549
Shows info about users on a channel
550
<pre>
551
On JOIN {
552
	var %t = 0;
553
	/echo There are ($user($chan, 0)) users in ($chan);
554
	
555
	while (%t < $user($chan, 0)) {
556
		%t++;
557
		var %nick = $user($chan, %t);
558
		/echo User (%t) is (%nick) and is $iif(%nick isop $chan, opped, not opped);
559
	}
560
}
561
</pre>
562
563
Shows info about servers, channels and users
564
<pre>
565
On JOIN {
566
	var %s = $server(0), %c = 0, %u = 0, %t = 0, %c2 = 0;
567
	
568
	while (%t < %s) {
569
		%t++;
570
		/setserver $server(%t);
571
		%c += $chan(0);
572
	
573
		%c2 = 0;
574
		while (%c2 < $chan(0)) {
575
			%c2++;
576
			%u += $user($chan(%c2), 0);
577
		}
578
	}
579
	
580
	/echo You are on (%s) servers, (%c) channels with (%u) users;	
581
}
582
</pre>