Revision as of 07:21, 13 December 2018

Local identifiers are identifiers which only function inside specific events. Attempting to call such identifiers from outside of their designed scope might have undesired results or might simply return $null.

Below is a list of all the local identifiers for all events.

All events

• $event - returns the name of the event
• $halted - returns $true if the default actions for this event has been halted

IRC related events which involve an user

• $address - returns the address of the user triggering the event in the format user@host
• $fulladdress - returns the full address of the user triggering the event in the format nick!user@host
• $nick - returns the nickname of the user triggering the event
• $rawmsg - returns the raw server line message
• $site - return the part after the @ in $address
• $wildsite - returns the address of the user triggering the event in the format *!*@host

They apply to:

• on action
• on ban
• on ctcpreply
• on dehelp
• on devoice
• on deop
• on deowner
• on error
• on filercvd
• on filesent
• on getfail
• on help
• on invite
• on kick
• on logon
• on mode
• on nick
• on nosound
• on notice
• on notify
• on op
• on open
• on owner
• on part
• on quit
• on rawmode
• on sendfail
• on servermode
• on serverop
• on snotice
• on text
• on topic
• on unban
• on unotify
• on voice
• on wallops
• ctcp event

There a few more local identifier related to IRC which exists only in specific events:

• $banmask - used inside on ban and on unban, returns the mask that is being banned/unbanned
• $bnick - used inside on ban and on unban, returns the nickname that is being banned/unbanned, if any
• $chan - used inside events which trigger for channel window
• $hnick - used inside on help and on dehelp, returns the nickname being given +h/-h
• $knick - used inside on kick, returns the nickname being kicked
• $newnick - used inside on nick, returns the new nickname
• $opnick - used inside on op, on deop, on owner and on deowner, returns the nickname being opped/deopped/owner'd/deowner'd
• $vnick - used inside the on voice and on devoice event, returns the name of the voiced/devoiced nickname

Non IRC events

Here is a list for non IRC events:

• $filename - used inside on filesent, on getfail, on midiend, on waveend, on songend, on nosound, on playend, on mp3end, returns the filename that was involved
• $hotline - used inside on hotlink
• $hotlink - used inside on hotlink
• $hotlinepos - used inside on hotlink
• $parseline - used inside on parseline, returns the line being parsed
• $parsetype - used inside on parseline, returns the type of message, in/out
• $parseutf - used inside on parseline, returns $true if the line is going to be utf8 encoded/decoded after the event
• $signal - used inside on signal, returns the name of the signal
• $target - used inside events which accept a window parameter, returns the name of the window
• $agentname - used inside on agent, returns the name of the agent.

$1-

Additionally $1- is filled with a message, applicable in the following events:

• on text, on action, on chat, on snotice, on notice on serv, on open, on ctcpreply, ctcp returns the text that was sent by the user
• on input - returns the text in the editbox
• on kick - returns the kick message
• on connectfail - returns the error message
• on error - returns the error message
• on hotlink - returns the word you hovered (stripped from control code).
• on mode, on rawmode and on servermode - returns the new modes
• on quit & on part, returns the quit/part message if any
• on ping & on pong, returns the ping/pong value
• on signal - returns the parameters of the signal
• on tabcomp - returns the line in which you pressed the tab key in the editbox
• on topic - returns the new topic
• on usermode - returns the new usermode
• on vcmd - returns the recognized word