Latest revision as of 14:36, 12 August 2022

$keychar is filled during an on keydown, on keyup or on char event inside of a custom @window, it returns the characters that was inputted if any.

/!\ This identifier is broken by design inside the on keydown and 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, on keydown and on keyup only trigger for keypresses.

To get the resulting character, one should use the on char event. $keychar is still filled inside on keydown and 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 on keydown and 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 on char only, to get characters.

Synopsis[edit]

$keychar

Parameters[edit]

None

Example[edit]

Create an alias that launches a custom, picture window which listens for key presses and displays the key value pressed, the key character pressed, and if it is repeating:

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
}

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

/keyDownTest

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

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[edit]

Added: mIRC v5.5
Added on: 08 Jan 1999
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.

See Also[edit]

• on char
• $keyrpt
• $keyval
• List of identifiers - mIRC