From WikiChip
Difference between revisions of "mirc/local identifiers"
< mirc

(→‎IRC related events)
Line 2: Line 2:
 
'''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}}.
 
'''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}}.
  
−
== local identifiers ==
+
Below is a list of all the local identifiers for all events.
−
Below is a list of all the local identifiers for all events:
 
  
−
=== IRC related events ===
+
=== All events ===
−
The following are considered IRC events:
 
  
−
{{collist
+
* {{mirc|$event}} - returns the name of the event
−
|count = 3
+
* {{mirc|$halted}} - returns $true if the default actions for this event has been halted
−
|* {{mIRC|on action}}
+
 
−
* {{mIRC|on ban}}
+
=== IRC related events which involve an user ===
−
* {{mIRC|on connect}}
+
 
−
* {{mIRC|on disconnect}}
+
* {{mirc|$address}} - returns the address of the user triggering the event in the format user@host
−
* {{mIRC|on connectfail}}
+
* {{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|$site}} - return the part after the @ in $address
 +
* {{mirc|$wildsite}} - returns the address of the user triggering the event in the format *!*@host
 +
 
 +
They apply to:
 +
 
 +
* {{mIRC|on action}}
 +
* {{mIRC|on ban}}  
 
* {{mIRC|on ctcpreply}}
 
* {{mIRC|on ctcpreply}}
 
* {{mIRC|on dehelp}}
 
* {{mIRC|on dehelp}}
Line 50: Line 57:
 
* {{mIRC|on wallops}}
 
* {{mIRC|on wallops}}
 
* {{mIRC|ctcp event}}
 
* {{mIRC|ctcp event}}
−
}}
 
  
−
Additionally '''$1-''' is 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 op}}, {{mIRC|on help}}, {{mIRC|on voice}}, {{mIRC|on owner}}, {{mIRC|on unban}}, {{mIRC|on serverop}}
+
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|$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}} and {{mIRC|on deop}}, returns the nickname being opped/deopped
 +
* {{mirc|$vnick}} - used inside the {{mIRC|on voice}} and {{mIRC|on devoice}} event, returns the name of the voiced/devoiced nickname
 +
 
 +
=== 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 wavend}}, {{mIRC|on playend}}, {{mIRC|on mp3end}}, returns the filename that was involved
 +
* {{mirc|$hotline}} - used inside {{mIRC|on hotlink}}
 +
* {{mirc|$hotlink}} - used inside {{mIRC|on hotlink}}
 +
* {{mirc|$hotlinepos}} - used inside {{mIRC|on hotlink}}
 +
* {{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|$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
  
−
=== Local Identifiers ===
+
=== $1- ===
−
Below is a list of local identifiers:
 
  
−
{{collist
+
Additionally '''$1-''' is filled with a message, applicable in the following events:
−
|count = 4
 
−
|
 
−
* {{mirc|$address}}
 
−
* {{mirc|$agentname}}
 
−
* {{mirc|$banmask}}
 
−
* {{mirc|$bnick}}
 
−
* {{mirc|$chan}}
 
−
* {{mirc|$event}}
 
−
* {{mirc|$filename}}
 
−
* {{mirc|$fulladdress}}
 
−
* {{mirc|$halted}}
 
−
* {{mirc|$hotline}}
 
−
* {{mirc|$hotlink}}
 
−
* {{mirc|$hotlinepos}}
 
−
* {{mirc|$hnick}}
 
−
* {{mirc|$knick}}
 
−
* {{mirc|$newnick}}
 
−
* {{mirc|$nick}}
 
−
* {{mirc|$opnick}}
 
−
* {{mirc|$parseline}}
 
−
* {{mirc|$parsetype}}
 
−
* {{mirc|$parseutf}}
 
−
* {{mirc|$rawmsg}}
 
−
* {{mirc|$signal}}
 
−
* {{mirc|$site}}
 
−
* {{mirc|$target}}
 
−
* {{mirc|$vnick}}
 
−
* {{mirc|$wildsite}}
 
−
}}
 
  
 +
*
 +
*
 +
*
 +
*
 +
*
 +
*
 +
*
 +
*
 +
*
 +
*
 +
*
 +
*
 +
*
  
 
{{stub}}
 
{{stub}}

Revision as of 16:10, 28 November 2018

Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
v · d · e

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:

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

Non IRC events

Here is a list for non IRC events:

$1-

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

Text document with shapes.svg This article is still a stub and needs your attention. You can help improve this article by editing this page and adding the missing information.
Retrieved from "https://en.wikichip.org/w/index.php?title=mirc/local_identifiers&oldid=84507"