keyboard_get_numlock

Get the status of the numberlock key on the keypad.

Syntax:

keyboard_get_numlock();


Returns: Boolean


Description

You can use this function to find the status of the keypad number lock with true being returned for on, and false returned for off.

NOTE: This functionality is only available in the Windows exe builds and will not function on any other device.


Example:

if keyboard_get_numlock()
   {
   keyboard_set_numlock(0);
   }
else
   {
   keyboard_set_numlock(1);
   }

The above example code will get the state of the numberlock key and if it is on (true) it will set it to off (false) and vice-versa.


Back: Keyboard Input
Next: keyboard_set_numlock
© Copyright YoYo Games Ltd. 2018 All Rights Reserved