GetKeyState

<< Click to Display Table of Contents >>

Manual > Control Reference > Route > Route Methods >

GetKeyState

 

Whether a key is pressed.

 

syntax

GetKeyState(

         virtKey

         )

 

Parameters

 

virtKey

 

Type:

Number

 

Virtual key code. If you want to check a letter or number key, specify the ASCII code of that character.

 

Return Value

 

 

Type:

Boolean

 

FALSE - Not pressed. TRUE - Pressed.

 

hmtoggle_plus1Explanation

Checks whether the key specified by virtKey is currently pressed.

 

Furthermore, if you specify the following in the arguments, the value will be TRUE when the lock is on (when the indicator light is lit, if there is one), rather than being TRUE while the keyboard key is being pressed.

・20 (Caps Lock key)

・144 (Num Lock key)

・145 (Scroll Lock key)

 

 

hmtoggle_plus1Example

 

 

 

var bLeftKey = ::GetKeyState(37);
var bTopKey = ::GetKeyState(38);
var bRightKey = ::GetKeyState(39);
var bBottomKey = ::GetKeyState(40);

 

 

Supported

×

Script Action

Can be used in server script Ver2 actions

○

Browser script

Can be used in browser scripts

×

Calculation Expression Syntax

Can be used in expression syntax (e.g. bind syntax)

 

 

reference

 

GetKeyState

SendKey

RegisterHotKey

UnregisterHotKey

GetIMEState

SetIMEState