Revision as of 15:40, 27 April 2019

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
• $eventid - returns an ID so that dll can evaluate local identifiers during events.
• $eventparms - if the event has a matchtext, returns the value of the matchtext with spacee preserved
• $matchkey - if the event has a matchtext, returns the value of the matchtext, with spaces lost.

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
• $rawbytes - returns the undecoded raw line message.
• $site - return the part after the @ in $address
• $wildsite - returns the address of the user triggering the event in the format *!*@host
• $ulevel - returns the level of the user that was matched for the triggered event.
• $clevel - returns the matching event level for a triggered event

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 events, returns the name of the voiced/devoiced nickname
• $cd - used inside the on chat and on serv events, returns the current directory of the connected user
• $parseline $parsetype $parseutf - available in the on parseline event, returns the raw line, the in/out type of direction, and whether or not mIRC is going to decode to utf8 respectively.

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, returns the full line containing the word which made the event triggers.
• $hotlink - used inside on hotlink, returns informations about the context in which the on hotlink event triggered
• $hotlinepos - used inside on hotlink, returns line number and word position of the matched word
• $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.
• $window - returns the name of the window that was left in a 'leave' menu {} event, whereas $leftwin is not a local identifier
• $ctrlenter - used inside on input, returns $true if keys control+enter have been used to trigger the event.
• $inpaste - used inside on input, returns $true if the event is triggering because you are pasting (multiple lines usually), not because you pressed enter.
• $did - used inside on dialog, returns the ID of the control that is triggering the event
• $dname - used inside on dialog, returns the name of the dialog that is triggering the event
• $devent - used inside on dialog, returns the name of the event that is triggering the on dialog event.
• $keyval - used inside on keydown and on keyup, returns the value of the keypress, always a number.
• $keychar - used inside on keydown and on keyup, returns the character of the keypress.
• $keyrpt - used inside on keydown, returns $true if the event triggers because the key is held down.
• $menu - used inside menu { } event, returns the name of the menu
• $menutype - used inside menu { } event, returns the type of the menu
• $menucontext - used inside menu { } event, returns the context in which the popup was created
• $sockbr - used inside socket events where /sockread is allowed, returns the number of bytes read
• $sockname - used inside socket events, returns the name of the socket
• $signal - used inside on signal event, returns the name of the signal.
• $iaddress - used inside on dns, returns the ip address, if available
• $raddress - used inside on dns, returns the resolved address
• $naddress - used inside on dns, returns the ip address, if available

mode msgtags socket

$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