From WikiChip
mirc/on events/on keydown
< mirc‎ | on events
Revision as of 14:43, 25 June 2014 by Zmodem (talk | contribs) (Created On keydown event - mIRC)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The On keydown event is triggered when a key is pressed down inside of a custom @window.

This event fills the following identifiers:

$keyvalThe unicode character value of the key pressed
$keycharThe actual character pressed
$keyrptIf the key is being held down/repeating

Synopsis

ON <level>:KEYDOWN:<@>:<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 *:KEYDOWN:@myWindow:38,42,55,78:echo -a $keyval

Examples

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: $iif($keyval,$v1,NA)
  drawtext @myWindow 1 3 25 Key character: $iif($keychar,$v1,NA)
  drawtext @myWindow 1 3 47 @myWindow Repeating: $keyrpt
}

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

/keyDownTest

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

This screenshot shows an example of the ON KEYDOWN event custom example.

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/09/2000

See Also