Editing mirc/identifiers/$keychar

{{mirc title|$keychar identifier}}'''$keychar''' is filled during an {{mirc|on keydown}}, or an {{mirc|on keyup}} event inside of a {{mirc|custom windows|custom @window}}.


== Synopsis ==
<pre>$keychar</pre>

== Parameters ==
None

== Example ==
Create an alias that launches a custom, [[Picture Windows - 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: $keyval
  drawtext @myWindow 1 3 47 @myWindow Repeating: $keyrpt
}
on *:char:@mywindow:*:{
  drawtext @myWindow 1 3 25 Key character: $keychar
}</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|on char}}
* {{mirc|$keyrpt}}
* {{mirc|$keyval}}
* [[List of identifiers - mIRC]]
{{mIRC identifier list}}
[[Category:mIRC identifiers|keychar]]
@@ Line 1: / Line 1: @@
-{{mirc title|$keychar identifier}}'''$keychar''' is filled during an {{mirc|on keydown}}, {{mirc|on keyup}} or {{mIRC|on char}} event inside of a {{mirc|custom windows|custom @window}}, it returns the characters that was inputted if any.
+{{mirc title|$keychar identifier}}'''$keychar''' is filled during an {{mirc|on keydown}}, or an {{mirc|on keyup}} event inside of a {{mirc|custom windows|custom @window}}.
-'''/!\''' This identifier is broken by design inside the {{mirc|on keydown}} and {{mirc|on keyup}} events.
-These two events have been trying for years to report AND keypresses, AND resulting characters but their implementation was wrong.
-On newer version of mIRC, this was fixed, {{mirc|on keydown}} and {{mirc|on keyup}} only trigger for keypresses.
-To get the resulting character, one should use the {{mirc|on char}} event. $keychar is still filled inside {{mirc|on keydown}} and {{mirc|on keyup}} for backward compatibility purpose. To get an idea, both events will correctly fill $keychar with the character when you press 'A', because it's one keypress corresponding to one character, but the main issue was that some keyboard/language requires you to press two keys to generate a character, sometimes mores.
-To sum up, checking $keychar inside {{mirc|on keydown}} and {{mirc|on keyup}} is incorrect and won't work for any language/keyboard, those two events are to be used to look for keypresses only with $keyval, use $keychar inside {{mirc|on char}} only, to get characters.