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

m (bot: sort-key added to category)
m (Bot: adding missing title)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{mirc title|On Exit - Events}}
 
The '''ON EXIT''' event triggers specifically when mIRC is exiting. This event can allow scripts to essentially clean themselves up, including removing unnecessary variables and other stored value types.
 
The '''ON EXIT''' event triggers specifically when mIRC is exiting. This event can allow scripts to essentially clean themselves up, including removing unnecessary variables and other stored value types.
  
Line 5: Line 6:
  
 
== Parameters ==
 
== Parameters ==
<span style="display: inline-block; width: 105px;">'''<level>'''</span>The level for the event to trigger.
+
* '''<level>''' - The corresponding {{mIRC|access levels}} for the event to trigger.
 +
* '''<commands>''' - The commands to be performed when the event listener's criteria is met.
  
<span style="display: inline-block; width: 105px;">'''<commands>'''</span>The commands to be performed when the event listener's criteria is met.
+
== Identifiers ==
 +
 
 +
=== {{mIRC|$exiting}} ===
 +
 
 +
Returns 1 if mIRC is in the process of exiting, 2 if mIRC is exiting and restarting, 0 otherwise.
  
 
== Example ==
 
== Example ==
This example will popup an [[$input identifier - mIRC|$input window]] before you exit mIRC:
+
This example will popup an {{mIRC|$input}} window before you exit mIRC:
 
<source lang="mIRC">ON *:EXIT:noop $input(Goodbye!,o,Bye Window)</source>
 
<source lang="mIRC">ON *:EXIT:noop $input(Goodbye!,o,Bye Window)</source>
  
Line 23: Line 29:
 
{{mIRC on event list}}
 
{{mIRC on event list}}
  
[[Category:MIRC on events|exit]]
+
[[Category:mIRC on events|exit]]

Latest revision as of 20:16, 15 June 2017

The ON EXIT event triggers specifically when mIRC is exiting. This event can allow scripts to essentially clean themselves up, including removing unnecessary variables and other stored value types.

Synopsis[edit]

ON <level>:EXIT:<commands>

Parameters[edit]

  • <level> - The corresponding access levels for the event to trigger.
  • <commands> - The commands to be performed when the event listener's criteria is met.

Identifiers[edit]

$exiting[edit]

Returns 1 if mIRC is in the process of exiting, 2 if mIRC is exiting and restarting, 0 otherwise.

Example[edit]

This example will popup an $input window before you exit mIRC:

ON *:EXIT:noop $input(Goodbye!,o,Bye Window)

Compatibility[edit]

Added: mIRC v5.81
Added on: 09 Nov 2000
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See Also[edit]