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

m
Line 1: Line 1:
 
{{mIRC Guide}}
 
{{mIRC Guide}}
The '''ON KEYUP''' event is triggered when a key has been pressed, but subsequently released, inside of a custom [[custom windows - mIRC|@window]].
+
The '''ON KEYUP''' event is triggered when a key has been pressed, but subsequently released, inside of a custom {{mirc|custom windows|@window}}.
  
 
This event fills the following identifiers:
 
This event fills the following identifiers:
Line 15: Line 15:
 
<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.
  
<span style="display: inline-block; width: 105px;">'''<@>'''</span>The [[custom windows - mIRC|custom window]] where this event should listen. Can be '''@''' for all windows.
+
<span style="display: inline-block; width: 105px;">'''<@>'''</span>The {{mirc|custom windows|custom window}} where this event should listen. Can be '''@''' for all windows.
  
 
<span style="display: inline-block; width: 105px;">'''<commands>'''</span>The specific key, or keys to listen for. Can specify multiple keys, such as:
 
<span style="display: inline-block; width: 105px;">'''<commands>'''</span>The specific key, or keys to listen for. Can specify multiple keys, such as:
Line 21: Line 21:
  
 
== Example ==
 
== Example ==
Create an alias that launches a custom, [[Picture Windows - mIRC|picture window]] which listens for key releases and displays the key value released, and the key character released:
+
Create an alias that launches a custom, {{mirc|picture windows|picture window}} which listens for key releases and displays the key value released, and the key character released:
 
<source lang="mIRC">alias keyUpTest {
 
<source lang="mIRC">alias keyUpTest {
 
   window -p $+ $iif($window(@myWindow),ra) @myWindow 550 300 250 83
 
   window -p $+ $iif($window(@myWindow),ra) @myWindow 550 300 250 83
Line 38: Line 38:
 
[[File:On keyup event - mIRC (fixed).png|This screenshot depicts the On Keyup event in mIRC.]]
 
[[File:On keyup event - mIRC (fixed).png|This screenshot depicts the On Keyup event in mIRC.]]
  
Note that this makes use of a [[Picture Windows - mIRC|picture window]], as well as the [[/drawtext command - mIRC|drawtext command]]. These types of [[Picture Windows - mIRC|windows]] and their tools can be very powerful in creating some amazing graphical layouts, as well as mIRC games.
+
Note that this makes use of a {{mirc|picture windows|picture window}}, as well as the {{mirc|/drawtext|drawtext command}}. These types of {{mirc|picture windows|windows}} and their tools can be very powerful in creating some amazing graphical layouts, as well as mIRC games.
  
 
== Compatibility ==
 
== Compatibility ==
Line 44: Line 44:
  
 
== See Also ==
 
== See Also ==
* [[custom windows - mIRC|Custom Windows]]
+
* {{mirc|custom windows}}
 
* {{mIRC|/drawtext}}
 
* {{mIRC|/drawtext}}
* [[on keydown - mIRC|ON KEYDOWN]]
+
* {{mirc|on keydown}}
 
* {{mIRC|$keyval}}
 
* {{mIRC|$keyval}}
 
* {{mIRC|$keychar}}
 
* {{mIRC|$keychar}}

Revision as of 13:39, 15 February 2016

Template:mIRC Guide The ON KEYUP event is triggered when a key has been pressed, but subsequently released, inside of a custom @window.

This event fills the following identifiers:

$keyvalThe unicode character value of the key being released
$keycharThe actual character released
$keyrptDuring this ON KEYUP event, the $keyrpt identifier always returns $true

Synopsis

ON <level>:KEYUP:<@>:<key,...,keyN>:<commands>

Parameters

<level>The level for the event to trigger.

<@>The custom window where this event should listen. Can be @ for all windows.

<commands>The specific key, or keys to listen for. Can specify multiple keys, such as:

ON *:KEYUP:@myWindow:38,42,55,78:echo -a $keyval

Example

Create an alias that launches a custom, picture window which listens for key releases and displays the key value released, and the key character released:

alias keyUpTest {
  window -p $+ $iif($window(@myWindow),ra) @myWindow 550 300 250 83
}
ON *:KEYUP:@myWindow:*: {
  clear @myWindow
  drawtext @myWindow 1 3 3 Key value: $iif($keyval,$v1,NA)
  drawtext @myWindow 1 3 25 Key character: $iif($keychar,$v1,NA)
}

The following command can now be typed into any mIRC command prompt:

/keyUpTest

Below is an image reflecting what this example will look like:

This screenshot depicts the On Keyup event in mIRC.

Note that this makes use of a picture window, as well as the drawtext command. These types of windows and their tools can be very powerful in creating some amazing graphical layouts, as well as mIRC games.

Compatibility

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


See Also