From WikiChip
Editing mirc/local identifiers

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

This page supports semantic in-text annotations (e.g. "[[Is specified as::World Heritage Site]]") to build structured and queryable content provided by Semantic MediaWiki. For a comprehensive description on how to use annotations or the #ask parser function, please have a look at the getting started, in-text annotation, or inline queries help pages.

Latest revision Your text
Line 8: Line 8:
 
* {{mirc|$event}} - returns the name of the event
 
* {{mirc|$event}} - returns the name of the event
 
* {{mirc|$halted}} - returns $true if the default actions for this event has been halted
 
* {{mirc|$halted}} - returns $true if the default actions for this event has been halted
−
* {{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 ===
 
=== IRC related events which involve an user ===
  
 
* {{mirc|$address}} - returns the address of the user triggering the event in the format user@host
 
* {{mirc|$address}} - returns the address of the user triggering the event in the format user@host
−
* {{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|$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|$nick}} - returns the nickname of the user triggering the event
 
* {{mirc|$rawmsg}} - returns the raw server line message
 
* {{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|$site}} - return the part after the @ in $address
 
* {{mirc|$wildsite}} - returns the address of the user triggering the event in the format *!*@host
 
* {{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:
 
They apply to:
Line 66: Line 58:
 
* {{mIRC|ctcp event}}
 
* {{mIRC|ctcp event}}
  
−
There a few more local identifier related to IRC which exists only in specific IRC events/case:
+
There a few more local identifier related to IRC which exists only in specific events:
  
 
* {{mirc|$banmask}} - used inside {{mIRC|on ban}} and {{mIRC|on unban}}, returns the mask that is being banned/unbanned
 
* {{mirc|$banmask}} - used inside {{mIRC|on ban}} and {{mIRC|on unban}}, returns the mask that is being banned/unbanned
Line 74: Line 66:
 
* {{mirc|$knick}} - used inside {{mIRC|on kick}}, returns the nickname being kicked
 
* {{mirc|$knick}} - used inside {{mIRC|on kick}}, returns the nickname being kicked
 
* {{mirc|$newnick}} - used inside {{mIRC|on nick}}, returns the new nickname
 
* {{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|$opnick}} - used inside {{mIRC|on op}} and {{mIRC|on deop}}, returns the nickname being opped/deopped
−
* {{mirc|$vnick}} - used inside the {{mIRC|on voice}} and {{mIRC|on devoice}} events, returns the name of the voiced/devoiced nickname
+
* {{mirc|$vnick}} - used inside the {{mIRC|on voice}} and {{mIRC|on devoice}} event, 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 ===
 
=== Non IRC events ===
Line 84: Line 73:
 
Here is a list for 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|$filename}} - used inside {{mIRC|on filesent}}, {{mIRC|on getfail}}, {{mIRC|on midiend}}, {{mIRC|on waveend}}, {{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|$hotline}} - used inside {{mIRC|on hotlink}}
−
* {{mirc|$hotlink}} - used inside {{mIRC|on hotlink}}, returns information about the context in which the on hotlink event triggered
+
* {{mirc|$hotlink}} - used inside {{mIRC|on hotlink}}
−
* {{mirc|$hotlinepos}} - used inside {{mIRC|on hotlink}}, returns line number and word position of the matched word
+
* {{mirc|$hotlinepos}} - used inside {{mIRC|on hotlink}}
 
* {{mirc|$parseline}} - used inside {{mIRC|on parseline}}, returns the line being parsed
 
* {{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|$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|$parseutf}} - used inside {{mIRC|on parseline}}, returns $true if the line is going to be utf8 encoded/decoded after the event
 +
* {{mirc|$signal}} - used inside {{mIRC|on signal}}, returns the name of the signal
 
* {{mirc|$target}} - used inside events which accept a window parameter, returns the name of the window
 
* {{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- ===
 
=== $1- ===
Line 119: Line 87:
 
Additionally '''$1-''' is filled with a message, applicable in the following events:
 
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
+
 
 +
{{stub}}

Please note that all contributions to WikiChip may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see WikiChip:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://en.wikichip.org/wiki/mirc/local_identifiers"