From WikiChip
Difference between revisions of "mirc/on events/on ban"
< mirc‎ | on events

m (Bot: Fixing links)
m (Bot: Fixing links)
Line 1: Line 1:
The '''ON BAN''' event is triggered whenever a user on a channel has been banned. When the ban occurs, the two identifiers that are most closely associated with the event are the [[$banmask identifier - mIRC|$banmask]] identifier, and the [[$bnick identifier - mIRC|$bnick]] identifier. It is important to note that [[$bnick identifier - mIRC|$bnick]] is not always filled, as some bans don't always contain the nickname, but rather a [[wildcard]] in the form of a [[banmask]].
+
The '''ON BAN''' event is triggered whenever a user on a channel has been banned. When the ban occurs, the two identifiers that are most closely associated with the event are the {{mIRC|$banmask}} identifier, and the {{mIRC|$bnick}} identifier. It is important to note that {{mIRC|$bnick}} is not always filled, as some bans don't always contain the nickname, but rather a [[wildcard]] in the form of a [[banmask]].
  
 
== Synopsis ==
 
== Synopsis ==
Line 36: Line 36:
  
 
== See Also ==
 
== See Also ==
* [[$banmask identifier - mIRC|$banmask]]
+
* {{mIRC|$banmask}}
* [[$bnick identifier - mIRC|$bnick]]
+
* {{mIRC|$bnick}}
 
* [[$ibl identifer - mIRC|$ibl]]
 
* [[$ibl identifer - mIRC|$ibl]]
 
* {{mIRC|/ban}}
 
* {{mIRC|/ban}}

Revision as of 21:03, 5 July 2014

The ON BAN event is triggered whenever a user on a channel has been banned. When the ban occurs, the two identifiers that are most closely associated with the event are the $banmask identifier, and the $bnick identifier. It is important to note that $bnick is not always filled, as some bans don't always contain the nickname, but rather a wildcard in the form of a banmask.

Synopsis

ON <level>:BAN:<#[,#]>:<commands>

Parameters

<level>The level for the event to trigger.

<#[,#]>The channel or channels for which the ban occurred.

#If no channel mentioned, targets all channels; otherwise, a specific channel.
[,#]Can be used to specify multiple, literal channel targets.

<commands>The commands to be performed when the event listener's criteria is met.

Examples

; This ban event listens for a ban
; on all channels, and responds by messaging the channel.
 
ON *:BAN:#:msg # Looks like the address $banmask has just been added to this channel's ban list.
; This example will watch for a ban on two
; specific channels: #myChannel and #myOtherChannel. When a ban is
; noticed, the script will also attempt to find out if a $bnick was set.
; If it was not, it will use it, otherwise it will use $banmask.
 
ON *:BAN:#myChannel,#myOtherChannel:msg # Wow, so $iif($bnick,$bnick just got in trouble,$banmask was just added to the channel's ban list) $+ .

The above script utilizes the $iif() identifier, which is a very powerful inline comparison tool within mIRC.

Compatibility

Added: mIRC v4.5

Added On: 30/06/96

See Also