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

(Parameters)
Line 6: Line 6:
  
 
== Parameters ==
 
== Parameters ==
 +
 +
* '''<level>''' - The corresponding {{mIRC|access levels}} for the event to trigger.
 +
* '''<matchtext>''' - The corresponding {{mIRC|on text|matchtext}} for the event to trigger.
 +
* '''<*><?><#[,#]>''' - The place, or places where the event listens, you can seperate them by comma.
 +
** '''*''' - Any query/channel window
 +
** '''?''' - Any query windows
 +
** '''#''' - Any channel window
 +
** '''#channel[,#]''' - one or more specific channels, seperate them by comma
 +
* '''<commands>''' - The commands to be performed when the event triggers
 +
 +
 
<span style="display: inline-block; width: 105px;">'''<level>'''</span>The level for the event to trigger.
 
<span style="display: inline-block; width: 105px;">'''<level>'''</span>The level for the event to trigger.
  

Revision as of 07:16, 22 January 2016

Template:mIRC Guide 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 corresponding access levels for the event to trigger.
  • <matchtext> - The corresponding matchtext for the event to trigger.
  • <*><?><#[,#]> - The place, or places where the event listens, you can seperate them by comma.
    • * - Any query/channel window
    • ? - Any query windows
    • # - Any channel window
    • #channel[,#] - one or more specific channels, seperate them by comma
  • <commands> - The commands to be performed when the event triggers


<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) $+ .

Compatibility

Added: mIRC v4.5
Added on: 30 Jun 1996
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See Also