Index
LOAD()
Description:
This handler get called right after the /load command
Variables:
None
Extra info:
None
Index
UNLOAD()
Description:
This handler get called right after the /unload command
Variables:
None
Extra info:
Return TRUE tells ircle to save all properties in the script!!!
Index
NOTIFY(theConnection, theString, signon)
Description:
This handler get called when someone of your notifylist (dis)connects.
Variables:
- theConnection : connection number (1..10) NUMBER
- theString: the list of nicks
- signon: true if signon, false if signoff boolean
Extra info:
Return TRUE tells ircle not to process this event.
Index
INPUT(theConnection, theTarget, theString)
Description:
Input handler, when you type something..
Variables:
- theConnection : connection number (1..10) NUMBER
- theTarget: the 'talking to' name
- theString: the line typed
Extra info:
Return TRUE tells ircle to not process this event.
Wich means your typed text will not be send to the connection.
Index
CTCP(theConnection, theSource, theSourcehost, theTarget, theCommand, theString, isreply)
Description:
This handler get called when you receive a CTCP command.
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource: the nick where the ctcp comes from
- theSourcehost: the host name where the ctcp comes from
- theTarget: the target of the ctcp
- theCommand: the ctcp command (VERSION, FINGER etc)
- theString: the rest of the ctcp command
isreply: the call is a reply from another user (true) (a NOTICE normally), or a request (false) boolean
Extra Info:
Return TRUE tells ircle not to process this event.
Wich means ircle won't reply any CTCP event.
Standaard CTCP commands are:
VERSION
FINGER
TIME
PING
CLIENTINFO
XDCC
DCC (CHAT, SEND, GET)
ACTION (this is the same as /me !!!!!)
Ircle has a few special CTCP commands as well:
VIDEOSTREAM (GET, SEND)
VIDEO (GET, SEND)
AUDIO (GET, SEND)
GESTALT
DCC (FSERVE)
FACE (GET, SEND)
Index
PUBMSG(theConnection, theSource, theSourcehost, theTarget, theString)
Description:
Everything that is said by others in a channel is processed here.
Keep in mind that an action (/me) is an CTCP command and not processed here.
Everything what you type is not processed here, but in the INPUT handler (!).
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource: the nick pubmsg comes from
- theSourcehost: the host name where the pubmsg comes from
- theTarget: channel
- theString: the channel msg
Extra info:
Return TRUE tells ircle not to process this event.
Index
PRIVMSG(theConnection, theSource, theSourcehost, theTarget, theString)
Description:
This handler gets called when someone sends you a /msg.
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource: the nick privmsg comes from
- theSourcehost: the host name where the privmsg comes from
- theTarget: your nick
- theString: the msg
Extra info:
Return TRUE tells ircle not to process this event.
This means it won't show in your window and the nick will not be added to the nick buffer.
Index
JOIN(theConnection, theNick, theUserhost, theChannel)
Description:
This handler gets called when you or someone else joins a channel.
Variables:
- theConnection : connection number (1..10) NUMBER
- theNick: the nick that is joining
- theUserhost: the host name from that nick
- theChannel: channel being joined
Extra info:
Return TRUE tells ircle not to process this event.
Wich means ircle won't open the channel window when you join a channel yourself!!!
When you use Return TRUE and someone joins the channel you are in then the userlist won't be updated and the join msg will not appear.
So in general it's NOT a good idea to use Return TRUE in this handler.
Index
PART(theConnection, theNick, theUserhost, theChannel, theString)
Description:
This handler gets called when you or someone else parts a channel.
Variables:
- theConnection : connection number (1..10) NUMBER
- theNick: the nick that is leaving
- theUserhost: the host name from that nick
- theChannel is channel
- theString contains a part message on some servers
Extra info:
Return TRUE tells ircle NOT to process this event.
This means the userlist won't be updated and when you did leave the channel and Ircle won't close the window...
So not a good idea to use Return TRUE in this handler.
Index
SIGNOFF(theConnection, theNick, theUserhost, theString)
Description:
This handler gets called when you or someone else signs off from IRC.
It will only be triggered when you are in the same channel as the person who signed off.
Ofcourse when you signoff yourself it will be triggered. (duh)
Variables:
- theConnection : connection number (1..10) NUMBER
- theNick: the nick that is signing off (quit)
- theUserhost: the host name from that nick
- theString: contains a part message
Extra info:
Return TRUE tells ircle not to process this event.
Index
TOPIC(theConnection, theNick, theUserhost, theChannel, theString)
Description:
This handler gets called when you or someone else sets a topic in a channel.
This handler WON'T be triggered when you enter a channel.
To make a script 'see' the topic when you enter channel I suggest you use the Numeric handler.
Variables:
- theConnection : connection number (1..10) NUMBER
- theNick: the nick that is changing the topic
- theUserhost: the host name from that nick
- theChannel: the channelname
- theString: the topic text
Extra info:
Return TRUE tells ircle not to process this event.
This means Ircle WON'T show the topic in the topic bar in your channel window.
Index
INVITE(theConnection, theNick, theUserhost, myNick, theChannel)
Description:
When you receive an invite from someone then this handler gets called.
Variables:
- theConnection : connection number (1..10) NUMBER
- theNick: the nick that is inviting you
- theUserhost: the host name from that nick
- myNick: your nick
- theChannel: the channel being invited to
Extra info:
Return TRUE tells ircle not to process this event.
Index
NICK(theConnection, theOldNick, theUserhost, theNewNick)
Description:
This handler gets called when you or someone else changes nicknames.
Ofcourse you have to be in the same channel as the person who changes the nick to 'see' it.
Variables:
- theConnection : connection number (1..10) NUMBER
- theOldNick: old nick
- theUserhost: the host name from that nick
- theNewNick: the new nick
Extra info:
Return TRUE tells ircle not to process this event.
Index
MODE(theConnection, theSource, theSourcehost, theChannel, theString)
Description:
This handler gets called when a user or channel gets a mode change.
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource: the nick/server that is doing the mode change
- theSourcehost: the host name from that nick
- theChannel is channel or user that gets the mode change
- theString: the mode string
Extra info:
Standard channel modes are :
t | topic locked for non-chanops |
n | no msg from outside the channel |
i | Invite only |
p | Private |
s | Secret |
m | Moderated |
l | Limited users.
Syntax: +l 20 for a channellimit of 20 users. |
k | Password protected channel.
Syntax: +k mypassword to protect the channel with the password "mypassword". |
Some networks might have their own , non-RFC1459 compliant, channelmodes as well.
Standard user modes are :
Some networks might have their own , non-RFC1459 compliant, usermodes as well.
Return TRUE tells ircle not to process this event.
This means that the userlist of Ircle won't show the correct channelmode or usermode (voice/op).
So using Return TRUE is not suggested in this handler.
Index
KICK(theConnection, theNick, theUserhost, theChannel, theKickedNick, theString)
Description:
This handlet gets called when you or someone else in the channel gets kicked.
Variables:
- theConnection : connection number (1..10) NUMBER
- theNick: the nick that is doing the kick
- theUserhost: the host name from that nick
- theChannel: the channel where the kick occurs
- theKickedNick: the nick being kicked
- theString: the kick message
Extra info:
Return TRUE tells ircle not to process this event.
Index
IRCNAME(theConnection, theSource, theSourcehost, theString)
Description:
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource:
- theSourcehost: the host name
- theString: the new ircname (whois info)
Extra info:
Return TRUE tells ircle not to process this event.
Index
NOTICE(theConnection, theSource, theSourcehost, theTarget, theString)
Description:
This handler currently only gets server notices
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource: the nick notice comes from
- theSourcehost: the host name of that nick
- theTarget: channel/nick
- theString: the notice msg
Extra info:
Return TRUE tells ircle not to process this event.
Index
KILL(theConnection, theSource, theSourcehost, theString)
Description:
This handler gets called when you or someone in the channel gets /kill'ed.
Variables:
- theConnection : connection number (1..10) NUMBER
- theSouce: the nick/server that is killed you
- theSourcehost: the hostname from that nick/server
- theString: the kill message
Extra info:
Return TRUE tells ircle not to process this event.
Index
WALLOPS(theconnection, theSource, theSourcehost, theString)
Description:
This handler gets called when a /wallop is send.
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource: the nick/server writing the wallop
- theSourcehost: the host name from that nick/server
- theString contains the wallop message
Extra info:
Return TRUE tells ircle not to process this event.
Index
SILENTIO(theConnection, theSource, theSourcehost, theString)
Description:
This handler is triggered when a server sends you a silence event.
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource: ???
- theSourcehost: the host name from theSource
- theString: ????
Extra info:
Return TRUE tells ircle not to process this event.
Index
NUMERIC(theConnection, theCommand, theString)
Description:
This handler gets called when the server sends numeric replies.
Most of the server replies will appear here
The Variable theCommand ranges from 0 to 999 NUMBER.
Consult RFC1459 for all possible replies.
Variables:
- theConnection : connection number (1..10) NUMBER
- theCommand : the server reply code
- theString : the message (if any)
Extra info:
Return TRUE tells ircle not to process this event.
Index
IRCERROR(theConnection, theSource, theSourcehost, theString)
Description:
??
Variables:
- theConnection : connection number (1..10) NUMBER
- theSource: ???
- theSourcehost: the host name
- theString: the error string
Extra info:
Return TRUE tells ircle not to process this event.
Index
DNS(theIP, theHostname, dnsevent) Index
Description:
This handler gets called when you receive the /dns reply.
Variables:
- theIP: ip # found or being looked up
- theHostname: hostname found or being looked up
- dnseevent: one of namesearchfailed, ipsearchfailed,namefound,ipfound
Extra info:
Return TRUE tells ircle not to process this event.
Index
CONNECTIONEVENT(theConnection, connectionEvent)
Description:
This handler gets called when you connect/disconnect/etc to a server.
Variables:
- theConnection : connection number (1..10) NUMBER
- connectionEvent: one of namesearchfailed, ipsearchfailed,namefound,
- ipfound,openfailed,established,closing,pleaseclose,closed
Extra info:
Return TRUE tells ircle not to process this event.
