Editing mirc/identifiers/$keyval

{{mirc title|$keyval Identifier}}'''$keyval''' return the key code of the key being pressed inside an {{mIRC|on keydown}}/{{mIRC|on keyup}} event.

This identifier is usually used over {{mIRC|$keychar}} because $keychar returns the character itself: this is unreliable, you can't track some keys such as alt, control, non-printable character etc, they don't have a character representation.
== Synopsis ==
<pre>$keyval</pre>

== Parameters ==
None

== Example ==
Create an alias that launches a custom, {{mirc|picture window}} which listens for key presses and displays the key value pressed, the key character pressed, and if it is repeating:
<source lang="mIRC">alias keyDownTest {
  window -p $+ $iif($window(@myWindow),ra) @myWindow 550 300 250 105
}
ON *:KEYDOWN:@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)
  drawtext @myWindow 1 3 47 @myWindow Repeating: $keyrpt
}</source>

The following command can now be typed into any mIRC command prompt:
<pre>/keyDownTest</pre>

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

[[File:Keyup event.png|This screenshot shows an example of the ON KEYDOWN event custom example.]]

Note that this makes use of a {{mirc|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 ==
{{mirc compatibility|5.5}}
== See Also ==
* {{mirc|custom windows}}
* {{mirc|/drawtext}}
* {{mirc|on keyup}}
* {{mirc|$keychar}}
* {{mirc|$keyrpt}}