Project

General

Profile

Scripting » History » Version 31

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