Project

General

Profile

Scripting » History » Version 129

Per Amundsen, 04/04/2012 05:01 PM

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 19 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
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
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 13 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 112 Per Amundsen
*Scripting is now unified completly which means all variables applies to all scripts and:
152 111 Per Amundsen
$file[path] is now $file(path);
153
$frand[path] is now $frand(path);
154 112 Per Amundsen
$floop[path] is now $floop(path);*
155 111 Per Amundsen
156 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.
157
158 119 Per Amundsen
Shorter aliases are added for simplicity.
159
<pre>
160
OnCommand /command { EXECUTE }
161
162 120 Per Amundsen
On EVENT { EXECUTE }
163 119 Per Amundsen
164
OnBefore EVENT { EXECUTE }
165
</pre>
166 118 Per Amundsen
167 50 Per Amundsen
New command /nmsg added for cross network output, and a new event OnSongChanged. 
168 1 Per Amundsen
169 50 Per Amundsen
Combine them and you can automatically announce song changes in a channel or to a user with:
170
171 42 Per Amundsen
<pre>
172 123 Per Amundsen
OnEvent if ($event == OnSongChanged) { /nmsg <network> <channel/Nick> $0-; }
173 42 Per Amundsen
</pre>
174 62 Per Amundsen
175 42 Per Amundsen
Announce to several channels with:
176 62 Per Amundsen
177 42 Per Amundsen
<pre>
178 123 Per Amundsen
OnEvent if ($event == OnSongChanged) { /nmsg <network> <channel/Nick> $0-;/nmsg <network> <channel/Nick> $0-; }
179 42 Per Amundsen
</pre>
180 1 Per Amundsen
181 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.
182 46 Per Amundsen
183
Also added is better escaping, variables and a "null" variable, e.g
184
185
<pre>
186 125 Per Amundsen
OnEvent if ($event == PRIVMSG) { if (%test == null) { %test = SOMETHING;/echo test is %test } }
187 46 Per Amundsen
</pre>
188
189 95 Per Amundsen
New variable $now returns unixtime/ctime from current time.
190 97 Per Amundsen
New variable $active returns the current window Status/#channel/Nick.
191 104 Per Amundsen
New variable $! returns how many $0 $1 etc variables are filled (not sure if final name of it)
192 95 Per Amundsen
193 116 Per Amundsen
These variables are saved into vars.ini unless removed (%var set to null) and reloaded when adiirc starts.
194 89 Per Amundsen
You can change/use them in any script.
195 48 Per Amundsen
196 49 Per Amundsen
Note also that all user set variables starts with % and client variables starts with $.
197
198 91 Per Amundsen
Some commands for manipulate variables:
199
200
<pre>
201 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
202 92 Per Amundsen
203 91 Per Amundsen
/unset [var] / deletes a variable
204 92 Per Amundsen
205 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
206 92 Per Amundsen
207 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
208 92 Per Amundsen
209
/vars shows a list of all variables and their values
210 91 Per Amundsen
</pre>
211
212 126 Per Amundsen
var %variable = 4242, %variable2 = 4343; will create local variables that gets deleted when the script is done.
213
214 1 Per Amundsen
Variables is still work in progress, id love some feedback/ideas of what it can be used for.
215 50 Per Amundsen
216 99 Per Amundsen
halt can now be used instead of .eat all, it will halt immediately, ignoring rest of the script.
217
return will halt immediately, ignoring rest of the script, but not eat anything.
218
219 51 Per Amundsen
<pre>
220 73 Per Amundsen
OnLoad / Called when the script is loaded
221
OnUnload / Called when the script is unloaded
222
OnReload / Called when the script is reloaded
223
OnConnecting / Called when a server is connecting
224
OnLookingUp / Called when a server is looking up the hostname
225
OnConnected / Called when a server is connected
226
OnDisconnect / Called when a server gets disconnected
227 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)
228 99 Per Amundsen
OnCTCPRequest / Called when a user recives a CTCP request
229
OnCTCPReply / Called when a user recives a CTCP reply
230 1 Per Amundsen
ACTION / Called when a user recives a ACTION (/me) message
231 100 Per Amundsen
OnNickChanged / Called when a user's nick changes, will only trigger on the user unlike NICK who triggers for everyone
232 123 Per Amundsen
OnSongChanged / Called when a song is changed in the selected media player
233 51 Per Amundsen
</pre>
234
235
A few examples using these.
236 1 Per Amundsen
237
<pre>
238
OnEvent if ($event == OnLoad) { %myvariable = This was set at startup }
239
OnEvent if ($event == OnUnLoad) { .msgbox varible set at startup was %myvariable }
240
OnEvent if ($event == OnReLoad) { .msgbox Script reloaded }
241 99 Per Amundsen
OnEvent if ($event == OnConnecting) { /echo i r conecting }
242
OnEvent if ($event == OnLookingUp ) { /echo i r looking up hostname }
243
OnEvent if ($event == OnConnected ) { /echo i r connected }
244
OnEvent if ($event == OnDisconnect) { /echo i r disconnected }
245
OnEvent if ($event == OnCommand) { if ($0 == /me) { /echo i typed /me } }
246
OnEvent if ($event == OnCommand) { /echo i typed $0, full command was $0- }
247 100 Per Amundsen
OnEvent if ($event == OnCTCPRequest) { /echo CTCP Request $0- from $nick }
248
OnEvent if ($event == OnCTCPReply) { /echo CTCP Reply $0- from $nick }
249 1 Per Amundsen
OnEvent if ($event == ACTION) { /echo ACTION $0- from $nick }
250 100 Per Amundsen
OnEvent if ($event == OnNickChanged) { /echo My nick is now $0 } 
251 123 Per Amundsen
OnEvent if ($event == OnSongChanged) { /echo Song changed to $0- }
252 52 Per Amundsen
</pre>
253 53 Per Amundsen
254 99 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) etc.
255 65 Per Amundsen
256
<pre>
257 101 Per Amundsen
> / Will try and cast left and right variable to int and try "int1 greater than int2"
258
< / Will try and cast left and right variable to int and try "int1 lower than int2"
259
>= / Will try and cast left and right variable to int and try "int1 greater than or equal to int2"
260
<= / Will try and cast left and right variable to int and try "int1 lower than or equal to int2"
261
isbetween / Will try and cast left variable to int and right variable have to be int-int, e.g "40 isbetween 30-50"
262
ison / check if ($nick ison $channel) nick is the channel
263
isop / check if ($nick isop $channel) is operator on the channel
264
ishop / check if ($nick ishop $channel) is half operator on the channel
265
issop / check if ($nick issop $channel) is special operator on the channel
266
isowner / check if ($nick isowner $channel) is channel owner
267
hasvoice / check if ($nick hasvoice $channel) have voice on the channel
268
inchan / check if i am in chan (#channel inchan) (#channel !inchan)
269
isnum / check something is a number (5 isnum) (5 !isnum)
270 65 Per Amundsen
</pre>
271
272 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:
273
274
<pre>
275 54 Per Amundsen
OnEvent if ($event == PRIVMSG) 
276
{ 
277 55 Per Amundsen
	if (%test == null) { 
278 125 Per Amundsen
		/echo Hello world; 
279 55 Per Amundsen
		if (%test == null) 
280
		{ 
281 125 Per Amundsen
			/echo Hello world; 
282 56 Per Amundsen
		} 
283 1 Per Amundsen
	} 
284
	else if (%test == null) 
285
	{ 
286 125 Per Amundsen
		/echo Hello world
287 1 Per Amundsen
	} 
288 55 Per Amundsen
	else (%test == null) 
289 54 Per Amundsen
	{ 
290 125 Per Amundsen
		/echo Hello world 
291 55 Per Amundsen
	} 
292
	if (%test == null) 
293
	{ 
294 125 Per Amundsen
		/echo Hello world 
295 54 Per Amundsen
	} 
296
}
297 53 Per Amundsen
</pre>
298
299 1 Per Amundsen
also ; is now useable like | for line ending.
300 54 Per Amundsen
301 57 Per Amundsen
Simple kickcounter script:
302
<pre>
303 122 Per Amundsen
OnBeforeEvent if ($event == OnCommand) { 
304 117 Per Amundsen
	if ($0 != /kick) 
305
	{
306
		return; 
307
	}
308
		
309
	if (%kickcount == null) 
310 1 Per Amundsen
	{ 
311 117 Per Amundsen
		%kickcount = 0; 
312
	}
313 68 Per Amundsen
314 117 Per Amundsen
	%kickcount++;
315 68 Per Amundsen
		 
316 117 Per Amundsen
	if ($2 == null) 
317
	{ 
318
		/kick $channel $1 Kick number %kickcount;
319
		halt; 
320 69 Per Amundsen
	} 
321
}
322 85 Per Amundsen
</pre>
323 69 Per Amundsen
324
You can now use "-" on $<number> variables to get all words from $<number> and after.
325
326
<pre>
327
OnEvent if ($event == OnCommand) { /echo $2- }
328 85 Per Amundsen
</pre>
329 69 Per Amundsen
330
When you type "/msg $me this is a test" you will get only "this is a test"
331
332
<pre>
333
OnEvent if ($event == OnCommand) { /echo $3- }
334 85 Per Amundsen
</pre>
335 1 Per Amundsen
336
When you type "/msg $me this is a test" you will get only "is a test"
337
338
<pre>
339 100 Per Amundsen
OnEvent if ($event == OnCommand) { /echo $0- }
340 1 Per Amundsen
</pre>
341
342 73 Per Amundsen
When you type "/msg $me this is a test" you will get "/msg $me this is a test"
343 76 Per Amundsen
344 79 Per Amundsen
$0- is now equal to $params and $msg, and $0 will return the first part e.g the command "/msg"
345 73 Per Amundsen
346 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.
347
348
Several functions are added, they are all recursive and you can use any %variable or $variable as parameters:
349
They are also usable inside if () statements.
350 128 Per Amundsen
All variable numbers are floats and all functions supports floats for precise calculations.
351 74 Per Amundsen
<pre>
352
$replace(text, text2, text3) / replace all occurrences of text2 in text with text3
353
$upper(text) / return text uppercase
354
$lower(text) return text lowercase
355
$mid(text, startpos, endpos) / return part of text from startpos to endpos
356
$substr(text, startpos, endpos) / return part of text from startpos to endpos
357
$left(text, pos) / return pos characters starting from left of the text
358
$right(text, pos) / return pos characters starting from right of the text
359
$remove(text, text2) / replace all occurrences of text2 from text
360
$len(text) / return length of text
361
$count(text, text2) / counts all occurrences of text2 in text
362 77 Per Amundsen
$pos(text, text2) / returns first occurrences position of text2 in text
363
$lastpos(text, text2) / returns last occurrences position of text2 in text
364 96 Per Amundsen
$strip(text) / removes all color and font tags
365 78 Per Amundsen
$repeat(text, times) / repeats text X times
366 87 Per Amundsen
$insert(text, text2, pos) / inserts text2 into pos of text
367 1 Per Amundsen
$calc(formula) / calculate any variation of +-*/
368
$formatdate(date, text) / formats a unix timestamp into date using date variables %d %m %y etc
369
$fdate(date, text) / formats a unix timestamp into date using date variables %d %m %y etc
370 112 Per Amundsen
$char(num) / returns ascii character from the number num
371
$chr(num) / returns ascii character from the number num
372
$host(nick) / returns the hostmask of nick
373
$ident(nick) / returns the ident of nick
374
$(number) / dynamically gets a $0 $1 $2 variable e.g $(1) is same as $1 (not sure if final function name)
375 73 Per Amundsen
$file(path) / reads file to end and returns the entire output without newlines
376 75 Per Amundsen
$fileloop(path) / reads through a file one line at the time, line increases +1 every time the same file is called
377 113 Per Amundsen
$floop(path) / reads through a file one line at the time, line increases +1 every time the same file is called
378 114 Per Amundsen
$filerandom(path) / returns a random line from a file
379 113 Per Amundsen
$frand(path) / returns a random line from a file
380 126 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
381
$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
382
$round(num, decimals) / rounds down a float to X decimals
383 127 Per Amundsen
$regex(text, pattern) / does a regular expression test if text matches pattern, then returns the matched part
384 75 Per Amundsen
</pre>
385
386 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.
387 127 Per Amundsen
All characters that needs to be escaped before used as strings are \ { } | ; #
388
In some cases you might have to escape ( and ) 
389 75 Per Amundsen
390
<pre>
391 125 Per Amundsen
OnEvent if ($event == JOIN) { /echo $replace(this is a test, test, replaced test) }
392 82 Per Amundsen
</pre>
393 1 Per Amundsen
394
Shows "this is a replaced test"
395
396
<pre>
397 125 Per Amundsen
OnEvent if ($event == JOIN) { /echo $replace($replace(this is a test, test, replaced test), replaced test, replaced again test) }
398 106 Per Amundsen
</pre>
399 1 Per Amundsen
400 106 Per Amundsen
Shows "this is a replaced again test"
401
402 1 Per Amundsen
Here is an fullblown kickban example script using the script editor
403 106 Per Amundsen
<pre>
404 117 Per Amundsen
OnCommand /kb {
405
	if ($1 == null) {
406
		/echo /kb - Nick missing;
407
		return;
408
	}
409
410 126 Per Amundsen
	var %msg = $iif($channel, $2-, $3-);
411
	var %chan = $iif($channel, $channel, $2);
412 117 Per Amundsen
		
413 106 Per Amundsen
	# Set this for default ban reason, or remove for no default reason
414 126 Per Amundsen
	# Can be shortened to %msg = $iif(%msg, %msg, GTFO);
415 117 Per Amundsen
	if (%msg == null) {
416
		%msg = GTFO;
417
	}
418
419
	if ($me isop %chan) {
420
		/raw MODE %chan +b *!$ident($1)@$host($1);
421 106 Per Amundsen
		/raw KICK %chan $1 %msg;
422
	} else {
423 117 Per Amundsen
		/echo You are not oper on %chan;
424
	}
425 106 Per Amundsen
}
426
</pre>
427
428
Simple calculator script:
429 1 Per Amundsen
<pre>
430 117 Per Amundsen
OnCommand /calc {
431 106 Per Amundsen
	if ($1 == null) {
432 1 Per Amundsen
		/echo /calc - Parameters missing;
433 117 Per Amundsen
		return;
434 106 Per Amundsen
	}
435 87 Per Amundsen
		
436
	# typing /calc -p <expression> sends output to channel
437 1 Per Amundsen
	if ($1 == -p) {
438 87 Per Amundsen
		/msg $channel Calculating : $2-;
439
		/msg $channel Result is : $calc($2-);
440 102 Per Amundsen
	} else {
441 87 Per Amundsen
		/echo Calculating : $1-;
442 106 Per Amundsen
		/echo Result is : $calc($1-);
443
	}
444
}
445
</pre>
446
447
Colored version
448
<pre>
449 117 Per Amundsen
OnCommand /calc {
450 106 Per Amundsen
	if ($1 == null) {
451
		/echo /calc - Parameters missing;
452 117 Per Amundsen
		return;
453 106 Per Amundsen
	}
454 98 Per Amundsen
	
455
	# typing /calc -p <expression> sends output to channel
456
	if ($1 == -p) {
457
		/msg $channel $chr(3)4Calculating : $2-;
458
		/msg $channel $chr(3)4Result is : $calc($2-);
459 106 Per Amundsen
	} else {
460
		/echo $chr(3)4Calculating : 4$1-;
461
		/echo $chr(3)4Result is : $calc($1-);
462
	}
463
}
464 104 Per Amundsen
</pre>
465 106 Per Amundsen
466
CTCP flood detection example
467
468 103 Per Amundsen
<pre>
469
OnEvent if ($event == OnCTCPRequest) {
470
	if (%count == null) {
471
		/set -u 10 %count 1;
472
	} else {
473
		/inc -u 10 %count 1;
474
	}
475 105 Per Amundsen
			
476 103 Per Amundsen
	if (%count > 4) {
477
		/ignore -u 30 -t $nick!$ident@$host;
478
	}
479
}
480
</pre>
481
482
while (CONDITION) { EXECUTE } is now useable for a loop
483
484
Mass mode example
485
486
<pre>
487 117 Per Amundsen
OnCommand /mass {
488 109 Per Amundsen
	if ($2 == null) {
489 103 Per Amundsen
		/echo /mass - Parameters missing [+/-<mode> <nick> <nick> <nick>];
490 117 Per Amundsen
		return;
491 103 Per Amundsen
	}
492
493 1 Per Amundsen
	%len = 2;
494
	
495 117 Per Amundsen
	# equal to while (%len <= $count(%len, $chr(32)))
496 1 Per Amundsen
	while (%len <= $!) {
497
		if ($(%len) ison $channel) {
498
			/mode $channel $1 $(%len);
499
		}
500
501
		/inc %len;
502
	}
503
}
504
</pre>
505 121 Per Amundsen
506
It is now possible to use custom commands as functions, lets say you make a /calc like this.
507
508
<pre>
509
OnCommand /mycalc {
510
	return $calc($0+$1);
511
}
512
</pre>
513
514
Then you can call this function with eiter /mycalc <number> <number> the normal way or $mycalc(<number, <number>) like this
515
<pre>
516
OnCommand /testcalc {
517
	/echo $0 + $1 is $mycalc($0, $1);
518
	/echo 5 + 4 is $mycalc(5, 4);
519
}
520
</pre>
521
522
Typing /testcalc will show the result. These custom functions are fully nested like the client functions.
523 129 Per Amundsen
524
Simple convert temperature C to F or F to C
525
<pre>
526
OnCommand /temp {
527
	if ($1 == C) {
528
		/echo $calc(($2 * 9/5) + 32) F;
529
	} elseif ($1 == F) {
530
		/echo $round($calc(($2 - 32) * 5/9), 1) C;
531
	}
532
}
533
</pre>
534
/temp C 20 will print 68 F