Keyboard Functions

Function Name	Description
get_keyboard	Checks if a chosen keyboard key is held down.
get_modifiers	Checks if a chosen keyboard modifier is held down (ALT, SHIFT, CTRL, etc.).

Keyboard functions for Core Keyboard Functions can be found here: Core Keyboard Functions

---

get_keyboard

get_keyboard checks to see if a chosen keyboard key is pressed.

Code-Snippet

main {
    if(get_keyboard(KEY_A)){
        combo_run(jump);
    }
}

combo jump {
    wait(20);
    set_val(XB1_A, 100);
    wait(20);
}

Syntax

get_keyboard( <key_constant> );

Parameters

<key_constant> : any defined keyboard constant.

Returns

True if the key is pressed, False if it is not.

---

get_modifiers

get_modifiers checks if a chosen keyboard modifier is held down (ALT, SHIFT, CTRL, etc.).

Code-Snippet

main {
    if (get_modifiers(MOD_LCTRL | MOD_LALT) == (MOD_LCTRL | MOD_LALT)) {
        /* Both Left Alt and Left Ctrl are pressed */
    }
}

Syntax

get_modifiers( <modifier_mask> );

Parameters

<modifier_mask> : a bitmask of keyboard modifiers.

Returns

The current state of the modifiers as a bitmask.