Latest revision |
Your text |
Line 1: |
Line 1: |
− | {{mirc title|Local Identifiers}}
| + | Local identifiers are all the identifiers which may only return a value inside an event. |
− | '''Local identifiers''' are {{mirc|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 {{mirc|$null}}.
| |
| | | |
− | Below is a list of all the local identifiers for all events.
| + | Here is a list of all the local identifiers for all events |
| | | |
− | === All events === | + | == IRC related events == |
| | | |
− | * {{mirc|$event}} - returns the name of the event
| + | The following are considered IRC events: |
− | * {{mirc|$halted}} - returns $true if the default actions for this event has been halted
| + | {{mIRC|on action}}, {{mIRC|on ban}}, {{mIRC|on connect}}, {{mIRC|on disconnect}}, {{mIRC|on connectfail}}, {{mIRC|on ctcpreply}}, {{mIRC|on dehelp}}, {{mIRC|on devoice}}, {{mIRC|on deop}}, {{mIRC|on deowner}}, {{mIRC|on error}}, {{mIRC|on filercvd}}, {{mIRC|on filesent}}, {{mIRC|on getfail}}, {{mIRC|on help}}, {{mIRC|on invite}}, {{mIRC|on kick}}, {{mIRC|on logon}}, {{mIRC|on mode}}, {{mIRC|on nick}}, {{mIRC|on nosound}}, {{mIRC|on notice}}, {{mIRC|on notify}}, {{mIRC|on op}}, {{mIRC|on open}}, {{mIRC|on owner}}, {{mIRC|on part}}, {{mIRC|on quit}}, {{mIRC|on rawmode}}, {{mIRC|on sendfail}}, {{mIRC|on servermode}}, {{mIRC|on serverop}}, {{mIRC|on snotice}}, {{mIRC|on text}}, {{mIRC|on topic}}, {{mIRC|on unban}}, {{mIRC|on unotify}}, {{mIRC|on voice}}, {{mIRC|on wallops}}, {{mIRC|ctcp event}} |
− | * {{mirc|$eventid}} - returns an ID so that dll can evaluate local identifiers during events.
| |
− | * {{mirc|$eventparms}} - if the event has a matchtext, returns the value of the matchtext with spaces preserved
| |
− | * {{mirc|$matchkey}} - if the event has a matchtext, returns the value of the matchtext, with spaces lost.
| |
| | | |
− | === IRC related events which involve an user ===
| + | * '''$1-''' - filled with a message, applicable in all events above except for {{mIRC|on ban}}, {{mIRC|on connect}}, {{mIRC|on disconnect}}, {{mIRC|on dehelp}}, {{mIRC|on devoice}}, {{mIRC|on deop}}, {{mIRC|on deowner}}, {{mIRC|on filercvd}}, {{mIRC|on filesent}}, {{mIRC|on action}}, {{mIRC|on action}}, {{mIRC|on action}}, {{mIRC|on action}}, {{mIRC|on action}}, {{mIRC|on action}}, {{mIRC|on action}}, {{mIRC|on action}} |
| | | |
− | * {{mirc|$address}} - returns the address of the user triggering the event in the format user@host
| + | -- need more work. |
− | * {{mirc|$maddress}} - returns the address of the user for that event, as provided by the server
| |
− | * {{mirc|$fulladdress}} - returns the full address of the user triggering the event in the format nick!user@host
| |
− | * {{mirc|$nick}} - returns the nickname of the user triggering the event
| |
− | * {{mirc|$rawmsg}} - returns the raw server line message
| |
− | * {{mIRC|$rawbytes}} - returns the undecoded raw line message.
| |
− | * {{mirc|$site}} - return the part after the @ in $address
| |
− | * {{mirc|$wildsite}} - returns the address of the user triggering the event in the format *!*@host
| |
− | * {{mIRC|$ulevel}} - returns the level of the user that was matched for the triggered event.
| |
− | * {{mirc|$clevel}} - returns the matching event level for a triggered event
| |
− | | |
− | | |
− | They apply to:
| |
− | | |
− | * {{mIRC|on action}}
| |
− | * {{mIRC|on ban}}
| |
− | * {{mIRC|on ctcpreply}}
| |
− | * {{mIRC|on dehelp}}
| |
− | * {{mIRC|on devoice}}
| |
− | * {{mIRC|on deop}}
| |
− | * {{mIRC|on deowner}}
| |
− | * {{mIRC|on error}}
| |
− | * {{mIRC|on filercvd}}
| |
− | * {{mIRC|on filesent}}
| |
− | * {{mIRC|on getfail}}
| |
− | * {{mIRC|on help}}
| |
− | * {{mIRC|on invite}}
| |
− | * {{mIRC|on kick}}
| |
− | * {{mIRC|on logon}}
| |
− | * {{mIRC|on mode}}
| |
− | * {{mIRC|on nick}}
| |
− | * {{mIRC|on nosound}}
| |
− | * {{mIRC|on notice}}
| |
− | * {{mIRC|on notify}}
| |
− | * {{mIRC|on op}}
| |
− | * {{mIRC|on open}}
| |
− | * {{mIRC|on owner}}
| |
− | * {{mIRC|on part}}
| |
− | * {{mIRC|on quit}}
| |
− | * {{mIRC|on rawmode}}
| |
− | * {{mIRC|on sendfail}}
| |
− | * {{mIRC|on servermode}}
| |
− | * {{mIRC|on serverop}}
| |
− | * {{mIRC|on snotice}}
| |
− | * {{mIRC|on text}}
| |
− | * {{mIRC|on topic}}
| |
− | * {{mIRC|on unban}}
| |
− | * {{mIRC|on unotify}}
| |
− | * {{mIRC|on voice}}
| |
− | * {{mIRC|on wallops}}
| |
− | * {{mIRC|ctcp event}}
| |
− | | |
− | There a few more local identifier related to IRC which exists only in specific IRC events/case:
| |
− | | |
− | * {{mirc|$banmask}} - used inside {{mIRC|on ban}} and {{mIRC|on unban}}, returns the mask that is being banned/unbanned
| |
− | * {{mirc|$bnick}} - used inside {{mIRC|on ban}} and {{mIRC|on unban}}, returns the nickname that is being banned/unbanned, if any
| |
− | * {{mirc|$chan}} - used inside events which trigger for channel window
| |
− | * {{mirc|$hnick}} - used inside {{mIRC|on help}} and {{mIRC|on dehelp}}, returns the nickname being given +h/-h
| |
− | * {{mirc|$knick}} - used inside {{mIRC|on kick}}, returns the nickname being kicked
| |
− | * {{mirc|$newnick}} - used inside {{mIRC|on nick}}, returns the new nickname
| |
− | * {{mirc|$opnick}} - used inside {{mIRC|on op}}, {{mIRC|on deop}}, {{mIRC|on owner}} and {{mIRC|on deowner}}, returns the nickname being opped/deopped/owner'd/deowner'd
| |
− | * {{mirc|$vnick}} - used inside the {{mIRC|on voice}} and {{mIRC|on devoice}} events, returns the name of the voiced/devoiced nickname
| |
− | * {{mirc|$cd}} - used inside the {{mIRC|on chat}} and {{mIRC|on serv}} events, returns the current directory of the connected user
| |
− | * {{mIRC|$parseline}} {{mIRC|$parsetype}} {{mIRC|$parseutf}} - available in the {{mIRC|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.
| |
− | * {{mirc|$msgstamp}} - returns UTC timestamp for a irc server message that has an IRCv3 @time prefix tag
| |
− | | |
− | === Non IRC events ===
| |
− | | |
− | Here is a list for non IRC events:
| |
− | | |
− | * {{mirc|$filename}} - used inside {{mIRC|on filesent}}, {{mIRC|on getfail}}, {{mIRC|on midiend}}, {{mIRC|on waveend}}, {{mIRC|on songend}}, {{mIRC|on nosound}}, {{mIRC|on playend}}, {{mIRC|on mp3end}}, returns the filename that was involved
| |
− | * {{mirc|$hotline}} - used inside {{mIRC|on hotlink}}, returns the full line containing the word which made the event triggers.
| |
− | * {{mirc|$hotlink}} - used inside {{mIRC|on hotlink}}, returns information about the context in which the on hotlink event triggered
| |
− | * {{mirc|$hotlinepos}} - used inside {{mIRC|on hotlink}}, returns line number and word position of the matched word
| |
− | * {{mirc|$parseline}} - used inside {{mIRC|on parseline}}, returns the line being parsed
| |
− | * {{mirc|$parsetype}} - used inside {{mIRC|on parseline}}, returns the type of message, in/out
| |
− | * {{mirc|$parseutf}} - used inside {{mIRC|on parseline}}, returns $true if the line is going to be utf8 encoded/decoded after the event
| |
− | * {{mirc|$target}} - used inside events which accept a window parameter, returns the name of the window
| |
− | * {{mIRC|$agentname}} - used inside {{mIRC|on agent}}, returns the name of the agent.
| |
− | * {{mirc|$window}} - returns the name of the window that was left in a 'leave' menu {} event, whereas $leftwin is not a local identifier
| |
− | * {{mirc|$ctrlenter}} - used inside {{mirc|on input}}, returns $true if keys control+enter have been used to trigger the event.
| |
− | * {{mirc|$inpaste}} - used inside {{mirc|on input}}, returns $true if the event is triggering because you are pasting (multiple lines usually), not because you pressed enter.
| |
− | * {{mirc|$did}} - used inside {{mirc|on dialog}}, returns the ID of the control that is triggering the event
| |
− | * {{mirc|$dname}} - used inside {{mirc|on dialog}}, returns the name of the dialog that is triggering the event
| |
− | * {{mirc|$devent}} - used inside {{mirc|on dialog}}, returns the name of the event that is triggering the on dialog event.
| |
− | * {{mirc|$keyval}} - used inside {{mirc|on keydown}} and {{mirc|on keyup}}, returns the value of the keypress, always a number.
| |
− | * {{mirc|$keychar}} - used inside {{mirc|on keydown}} and {{mirc|on keyup}}, returns the character of the keypress.
| |
− | * {{mirc|$keyrpt}} - used inside {{mirc|on keydown}}, returns $true if the event triggers because the key is held down.
| |
− | * {{mirc|$menu}} - used inside menu { } event, returns the name of the menu
| |
− | * {{mirc|$menutype}} - used inside menu { } event, returns the type of the menu
| |
− | * {{mirc|$menucontext}} - used inside menu { } event, returns the context in which the popup was created
| |
− | * {{mirc|$sockbr}} - used inside socket events where /sockread is allowed, returns the number of bytes read
| |
− | * {{mirc|$sockname}} - used inside socket events, returns the name of the socket
| |
− | * {{mirc|$signal}} - used inside {{mirc|on signal}} event, returns the name of the signal.
| |
− | * {{mirc|$iaddress}} - used inside {{mirc|on dns}}, returns the ip address, if available
| |
− | * {{mirc|$raddress}} - used inside {{mirc|on dns}}, returns the resolved address
| |
− | * {{mirc|$naddress}} - used inside {{mirc|on dns}}, returns the address being resolved
| |
− | * {{mirc|$modefirst}} - used inside any channel specific mode event (on op, on dehelp, but not on rawmode or on mode), returns $true if the mode you're dealing with is the first
| |
− | * {{mirc|$modelast}} - used inside any channel specific mode event (on op, on dehelp, but not on rawmode or on mode), returns $true if the mode you're dealing with is the last
| |
− | * {{mirc|$mode}} - used typically inside {{mirc|on rawmode}}, returns the Nth nick affected by a mode.
| |
− | | |
− | === $1- ===
| |
− | | |
− | Additionally '''$1-''' is filled with a message, applicable in the following events:
| |
− | | |
− | * {{mIRC|on text}}, {{mIRC|on action}}, {{mIRC|on chat}}, {{mIRC|on snotice}}, {{mIRC|on notice}} {{mIRC|on serv}}, {{mIRC|on open}}, {{mIRC|on ctcpreply}}, {{mIRC|ctcp_events|ctcp}} returns the text that was sent by the user
| |
− | * {{mIRC|on input}} - returns the text in the editbox
| |
− | * {{mIRC|on kick}} - returns the kick message
| |
− | * {{mIRC|on connectfail}} - returns the error message
| |
− | * {{mIRC|on error}} - returns the error message
| |
− | * {{mIRC|on hotlink}} - returns the word you hovered (stripped from control code).
| |
− | * {{mIRC|on mode}}, {{mIRC|on rawmode}} and {{mIRC|on servermode}} - returns the new modes
| |
− | * {{mIRC|on quit}} & {{mIRC|on part}}, returns the quit/part message if any
| |
− | * {{mIRC|on ping}} & {{mIRC|on pong}}, returns the ping/pong value
| |
− | * {{mIRC|on signal}} - returns the parameters of the signal
| |
− | * {{mIRC|on tabcomp}} - returns the line in which you pressed the tab key in the editbox
| |
− | * {{mIRC|on topic}} - returns the new topic
| |
− | * {{mIRC|on usermode}} - returns the new usermode
| |
− | * {{mIRC|on vcmd}} - returns the recognized word
| |