Input#

Contains variables related to button, mouse, and keyboard input.

Access with Input->.

Variables#

bool[]

Press

bool[]

Button

bool[]

KeyPress

bool[]

Key

untyped[]

Mouse

int[]

KeyBindings

int

ModifierKeys

bool[]

DisableKey

bool[]

DisableButton

const bool[]

Joypad

const bool[]

ReadKey deprecated

bool[]

Hold deprecated

bool[]

KeyRaw deprecated

Variable descriptions#

bool[] Press πŸ”— Source

Whether the given button (CB_ constants) is down (or β€˜pressed’).


bool[] Button πŸ”— Source

Whether the given button (CB_ constants) is down (or β€˜pressed’).


bool[] KeyPress πŸ”— Source

Returns true if the respective key was just pressed this frame (similar to Press[], but for keys instead of buttons).


bool[] Key πŸ”— Source

Returns true if the respective key is down this frame (similar to Button[], but for keys instead of buttons).


untyped[] Mouse πŸ”— Source


int[] KeyBindings πŸ”— Source

For each index (using CB_ constants to access), the keyboard key (KEY_ constants) that is bound to that button.


int ModifierKeys πŸ”— Source

Returns the modifier keys as a bitwise flagset.


bool[] DisableKey πŸ”— Source

Whether a given keyboard key (KEY_ constants) is disabled from having any in-engine effect.


bool[] DisableButton πŸ”— Source

Whether a given button (CB_ constants) is disabled from having any in-engine effect.


const bool[] Joypad πŸ”— Source

Similar to Press, except that it only returns presses from a joystick device, not a keyboard.

Use the CB_ constants to access this array.


const bool[] ReadKey πŸ”— Source

Warning

Deprecated! Use KeyPress[] instead!


bool[] Hold πŸ”— Source

Warning

Deprecated! Use Button[] instead!


bool[] KeyRaw πŸ”— Source

Warning

Deprecated! Unsafe!