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

Enumerations

enum Button: 🔗 Source

Controller buttons.

Button CB_UP = 0

Button CB_DOWN = 1

Button CB_LEFT = 2

Button CB_RIGHT = 3

Button CB_A = 4

Button CB_B = 5

Button CB_START = 6

Button CB_L = 7

Button CB_R = 8

Button CB_MAP = 9

Button CB_EX1 = 10

Button CB_X = 10

Button CB_EX2 = 11

Button CB_Y = 11

Button CB_EX3 = 12

Button CB_EX4 = 13

Button CB_STICKUP = 14

Button CB_STICKDOWN = 15

Button CB_STICKLEFT = 16

Button CB_STICKRIGHT = 17

Button CB_AXIS_UP = 14

Button CB_AXIS_DOWN = 15

Button CB_AXIS_LEFT = 16

Button CB_AXIS_RIGHT = 17

Button CB_MAX = 18

---

enum MouseButtonBitflags: 🔗 Source

Mouse button bitflags, used with Hero->InputMouseB.

Deprecated: Use MouseIndex (MOUSE_) and Input->Mouse[] instead!

MouseButtonBitflags MB_LEFTCLICK = 1

MouseButtonBitflags MB_RIGHTCLICK = 2

MouseButtonBitflags MB_MIDDLECLICK = 4

---

enum MouseIndex: 🔗 Source

Used with Input->Mouse[].

MouseIndex MOUSE_X = 0

MouseIndex MOUSE_Y = 1

MouseIndex MOUSE_Z = 2

MouseIndex MOUSE_LEFT = 3

MouseIndex MOUSE_RIGHT = 4

MouseIndex MOUSE_MIDDLE = 5

---

Variable descriptions

bool[] Press 🔗 Source

index Button[]

Whether the given button is down (or ‘pressed’).

---

bool[] Button 🔗 Source

index Button[]

Whether the given button is down (or ‘pressed’).

---

bool[] KeyPress 🔗 Source

index KeyCode (KEY_)

Returns true if the respective key was just pressed this frame.

---

bool[] Key 🔗 Source

index KeyCode (KEY_)

Returns true if the respective key is down this frame.

---

untyped[] Mouse 🔗 Source

---

int[] KeyBindings 🔗 Source

index Button[]

value KeyCode (KEY_)

For each button, the keyboard key that is bound to that button.

---

int ModifierKeys 🔗 Source

value KeyModifierBitflags (KB_)

The state of the modifier keys.

---

bool[] DisableKey 🔗 Source

index KeyCode (KEY_)

Whether a given keyboard key is disabled from having any in-engine effect.

---

bool[] DisableButton 🔗 Source

index Button[]

Whether a given button is disabled from having any in-engine effect.

---

const bool[] Joypad 🔗 Source

index Button[]

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

---

const bool[] ReadKey 🔗 Source

Deprecated: Use KeyPress[] instead!

---

bool[] Hold 🔗 Source

Deprecated: Use Button[] instead!

---

bool[] KeyRaw 🔗 Source

Deprecated: Unsafe!