Project

General

Profile

Scripting » History » Version 23

Per Amundsen, 04/02/2011 09:14 PM

1 1 Per Amundsen
h1. Scripting
2
3
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.
4
5 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.
6 1 Per Amundsen
7 15 Per Amundsen
As of build 020411.
8 1 Per Amundsen
9 16 Per Amundsen
There are 2 types of scripting atm, one that have been here for a long time, and a new system.
10
11
All scripting is done in Commands -> Edit Commands where one line represent a script or a custom command.
12
13 17 Per Amundsen
Please note that variables and functions are *different* for these 2 types of scripts.
14
15 16 Per Amundsen
h1. Normal custom commands:
16
17 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>
18 16 Per Amundsen
19 19 Per Amundsen
Current variables are $1 to $9, $pagearams, $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>
20 16 Per Amundsen
21
$pagearam represents everything written after /yourcommand, $chan replaces itself with current channel and $me replaces itself with your current usernick. 
22
23 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>
24 16 Per Amundsen
25 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).
26 23 Per Amundsen
27
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)
28
29
Useable modifies are ctrl, alt and shift and any character or number or F key.
30
31
An example
32
33
<pre>ctrl&o /msg $chan ohai i just pressed ctrl o</pre>
34
35
Everytime you press ctrl and 'o' now, this command will be fired off.
36 16 Per Amundsen
37
h1. New Scripting
38 21 Per Amundsen
39 22 Per Amundsen
The new scripting tries to combine normal client commands, your custom commands, functions and events into one scripting language.
40 16 Per Amundsen
41 1 Per Amundsen
In Commands -> Edit Commands you can enter a scripting line with the following syntax:
42
43
The line must start with <pre>OnEvent<whitespace></pre>
44
45
Followed by either an expression like this (works recursivly)
46
47
<pre>
48
if (SOMETING == SOMETHINGELSE) { EXECUTE HERE }
49
if (SOMETING != SOMETHINGELSE) { EXECUTE HERE }
50 13 Per Amundsen
if (SOMETING ismatch SOMETHINGELSE) { EXECUTE HERE }</pre>
51 1 Per Amundsen
or by an executed command or function
52
53 2 Per Amundsen
You can now combine expressions with && (AND) and || (OR) like this
54 1 Per Amundsen
<pre>
55 2 Per Amundsen
if (SOMETHING == SOMETHING && SOMETHINGELSE != SOMETHINGELSE) { EXECUTE HERE }
56 13 Per Amundsen
if (SOMETHING == SOMETHING || SOMETHINGELSE != SOMETHINGELSE) { EXECUTE HERE }</pre>
57 1 Per Amundsen
The logic behind these expressions is not fully tested, id love any feedback on this.
58 12 Per Amundsen
59
(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)
60 2 Per Amundsen
61 1 Per Amundsen
Executed commands are /slash commands already in the client e.g /msg #channel hello world.
62
Executed functions are predefined functions in the client, only two exists for now.
63
64
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>
65
66
Furthermore there is a lot of predefined variables for use with these functions, for now they are:
67
68
$event / current event, e.g PRIVMSG 001 MODE and so forth
69
$channel / the channel the event occurred on, if any
70
$msg / the message to the channel/user or the message in a raw irc line e.g whois [kr0n] is a registered nick
71
$nick / the nick the event was sent from, can be a irc.server.com, a nick or null
72
$me / my current nick
73
$network / the network the event occured on e.g Quakenet
74
$ident / the from user ident if any
75
$host / the from user hostname if any
76
$myident / my ident
77
$myhost / my host
78 14 Per Amundsen
$server / host from the server e.g irc.server.com
79 1 Per Amundsen
80
Currently predefined functions are:
81
<pre>
82 13 Per Amundsen
.insert requires .insert <nick (use null for nonick)> <where (a channel or $channel, a nick or $nick, or status)> <MsgType (MsgServer/MsgUser/MsgEmote/MsgCTCP/MsgNotice/MsgClient/MsgLog)> <$msg or message></pre>
83 1 Per Amundsen
84
<pre>
85 13 Per Amundsen
.eat <what (text or all)></pre>
86 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.
87
88
.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.
89
90
Putting it all togheter, here are a few examples:
91
92
<pre>
93 13 Per Amundsen
OnEvent if ($event == NOTICE) { if ($msg ismatch hi there) { .insert $nick status MsgNotice $msg|.eat text } }</pre>
94 1 Per Amundsen
95
insert the notice into the server window and tells adiirc to "eat" its own text output from this notice
96
97
<pre>
98 13 Per Amundsen
OnEvent if ($event == PRIVMSG && $msg == herp) { /msg $channel derp } }</pre>
99 7 Per Amundsen
100 1 Per Amundsen
if the event is a PRIVMSG AND the $msg equals "herp", then show "derp" in the channel
101
102 6 Per Amundsen
<pre>
103 13 Per Amundsen
OnEvent if ($event == PRIVMSG) { if ($nick == Q || $nick == $me) { /msg $channel Q or $me is speaking! } }</pre>
104 1 Per Amundsen
105
if the event is a PRIVMSG and the $nick equals "Q" OR $me then show "Q or $me is speaking" in the channel
106 9 Per Amundsen
107 3 Per Amundsen
A list of custom events that is also usable as $event ==
108 4 Per Amundsen
<pre>
109 3 Per Amundsen
OnOwner
110
OnDeOwner
111
OnSpecialOp
112
OnSpecialDeOp
113
OnOp
114
OnDeOp
115
OnHop
116
OnDeHop
117
OnVoice
118 13 Per Amundsen
OnDeVoice</pre>