ThicketScript

Input constants ​

Key, GamepadButton, GamepadAxis and MouseCursor.

Always available

No import needed. These names are in scope in every file.

MouseCursor static class ​

ts
static class MouseCursor

Final: it cannot be subclassed.

Named cursor shapes accepted by Mouse.cursor and engine.cursor.set.

MouseCursor.DEFAULT ​

ts
static readonly DEFAULT: string

The default pointer.

MouseCursor.ARROW ​

ts
static readonly ARROW: string

The arrow pointer.

MouseCursor.IBEAM ​

ts
static readonly IBEAM: string

The text-insertion I-beam.

MouseCursor.CROSSHAIR ​

ts
static readonly CROSSHAIR: string

A crosshair.

MouseCursor.POINTING_HAND ​

ts
static readonly POINTING_HAND: string

The pointing hand used over links.

MouseCursor.RESIZE_EW ​

ts
static readonly RESIZE_EW: string

Horizontal resize (left-right).

MouseCursor.RESIZE_NS ​

ts
static readonly RESIZE_NS: string

Vertical resize (up-down).

MouseCursor.RESIZE_NWSE ​

ts
static readonly RESIZE_NWSE: string

Diagonal resize (top-left to bottom-right).

MouseCursor.RESIZE_NESW ​

ts
static readonly RESIZE_NESW: string

Diagonal resize (top-right to bottom-left).

MouseCursor.RESIZE_ALL ​

ts
static readonly RESIZE_ALL: string

Resize or move in every direction.

MouseCursor.NOT_ALLOWED ​

ts
static readonly NOT_ALLOWED: string

The not-allowed pointer.

Key static class ​

ts
static class Key

Final: it cannot be subclassed.

Keyboard constants named as in Heaps hxd.Key. Each is the physical key (scancode), so Key.W is the key in the W position of a QWERTY board on any layout.

Key.BACKSPACE ​

ts
static readonly BACKSPACE: int

Backspace.

Key.TAB ​

ts
static readonly TAB: int

Tab.

Key.ENTER ​

ts
static readonly ENTER: int

Enter / Return.

Key.ESCAPE ​

ts
static readonly ESCAPE: int

Escape.

Key.SPACE ​

ts
static readonly SPACE: int

The space bar.

Key.PGUP ​

ts
static readonly PGUP: int

Page Up.

Key.PGDOWN ​

ts
static readonly PGDOWN: int

Page Down.

Key.END ​

ts
static readonly END: int

End.

Key.HOME ​

ts
static readonly HOME: int

Home.

Key.LEFT ​

ts
static readonly LEFT: int

Left arrow.

Key.UP ​

ts
static readonly UP: int

Up arrow.

Key.RIGHT ​

ts
static readonly RIGHT: int

Right arrow.

Key.DOWN ​

ts
static readonly DOWN: int

Down arrow.

Key.INSERT ​

ts
static readonly INSERT: int

Insert.

Key.DELETE ​

ts
static readonly DELETE: int

Delete.

Key.PRINT_SCREEN ​

ts
static readonly PRINT_SCREEN: int

Print Screen.

Key.QWERTY_EQUALS ​

ts
static readonly QWERTY_EQUALS: int

The equals key (QWERTY layout position).

Key.QWERTY_MINUS ​

ts
static readonly QWERTY_MINUS: int

The minus key (QWERTY layout position).

Key.QWERTY_TILDE ​

ts
static readonly QWERTY_TILDE: int

The tilde key (QWERTY layout position).

Key.QWERTY_BRACKET_LEFT ​

ts
static readonly QWERTY_BRACKET_LEFT: int

The bracket left key (QWERTY layout position).

Key.QWERTY_BRACKET_RIGHT ​

ts
static readonly QWERTY_BRACKET_RIGHT: int

The bracket right key (QWERTY layout position).

Key.QWERTY_SEMICOLON ​

ts
static readonly QWERTY_SEMICOLON: int

The semicolon key (QWERTY layout position).

Key.QWERTY_QUOTE ​

ts
static readonly QWERTY_QUOTE: int

The quote key (QWERTY layout position).

Key.QWERTY_BACKSLASH ​

ts
static readonly QWERTY_BACKSLASH: int

The backslash key (QWERTY layout position).

Key.QWERTY_COMMA ​

ts
static readonly QWERTY_COMMA: int

The comma key (QWERTY layout position).

Key.QWERTY_PERIOD ​

ts
static readonly QWERTY_PERIOD: int

The period key (QWERTY layout position).

Key.QWERTY_SLASH ​

ts
static readonly QWERTY_SLASH: int

The slash key (QWERTY layout position).

Key.INTL_BACKSLASH ​

ts
static readonly INTL_BACKSLASH: int

The extra key next to left Shift on ISO keyboards.

Key.LEFT_WINDOW_KEY ​

ts
static readonly LEFT_WINDOW_KEY: int

Left Windows / Command key.

Key.RIGHT_WINDOW_KEY ​

ts
static readonly RIGHT_WINDOW_KEY: int

Right Windows / Command key.

Key.CONTEXT_MENU ​

ts
static readonly CONTEXT_MENU: int

The context-menu key.

Key.AZERTY_DOLLAR ​

ts
static readonly AZERTY_DOLLAR: int

The dollar key (AZERTY layout position).

Key.AZERTY_EQUALS ​

ts
static readonly AZERTY_EQUALS: int

The equals key (AZERTY layout position).

Key.AZERTY_COMMA ​

ts
static readonly AZERTY_COMMA: int

The comma key (AZERTY layout position).

Key.AZERTY_SEMICOLON ​

ts
static readonly AZERTY_SEMICOLON: int

The semicolon key (AZERTY layout position).

Key.AZERTY_COLON ​

ts
static readonly AZERTY_COLON: int

The colon key (AZERTY layout position).

Key.AZERTY_MODULO ​

ts
static readonly AZERTY_MODULO: int

The modulo key (AZERTY layout position).

Key.AZERTY_PARENT_CLOSE ​

ts
static readonly AZERTY_PARENT_CLOSE: int

The parent close key (AZERTY layout position).

Key.AZERTY_MULTIPLY ​

ts
static readonly AZERTY_MULTIPLY: int

The multiply key (AZERTY layout position).

Key.AZERTY_POWER ​

ts
static readonly AZERTY_POWER: int

The power key (AZERTY layout position).

Key.AZERTY_SQUARED ​

ts
static readonly AZERTY_SQUARED: int

The squared key (AZERTY layout position).

Key.AZERTY_EXCLAM ​

ts
static readonly AZERTY_EXCLAM: int

The exclam key (AZERTY layout position).

Key.PAUSE_BREAK ​

ts
static readonly PAUSE_BREAK: int

Pause / Break.

Key.CAPS_LOCK ​

ts
static readonly CAPS_LOCK: int

Caps Lock.

Key.NUM_LOCK ​

ts
static readonly NUM_LOCK: int

Num Lock.

Key.SCROLL_LOCK ​

ts
static readonly SCROLL_LOCK: int

Scroll Lock.

Key.NUMBER_0 ​

ts
static readonly NUMBER_0: int

The 0 key on the main number row.

Key.NUMBER_1 ​

ts
static readonly NUMBER_1: int

The 1 key on the main number row.

Key.NUMBER_2 ​

ts
static readonly NUMBER_2: int

The 2 key on the main number row.

Key.NUMBER_3 ​

ts
static readonly NUMBER_3: int

The 3 key on the main number row.

Key.NUMBER_4 ​

ts
static readonly NUMBER_4: int

The 4 key on the main number row.

Key.NUMBER_5 ​

ts
static readonly NUMBER_5: int

The 5 key on the main number row.

Key.NUMBER_6 ​

ts
static readonly NUMBER_6: int

The 6 key on the main number row.

Key.NUMBER_7 ​

ts
static readonly NUMBER_7: int

The 7 key on the main number row.

Key.NUMBER_8 ​

ts
static readonly NUMBER_8: int

The 8 key on the main number row.

Key.NUMBER_9 ​

ts
static readonly NUMBER_9: int

The 9 key on the main number row.

Key.NUMPAD_0 ​

ts
static readonly NUMPAD_0: int

The 0 key on the numeric keypad.

Key.NUMPAD_1 ​

ts
static readonly NUMPAD_1: int

The 1 key on the numeric keypad.

Key.NUMPAD_2 ​

ts
static readonly NUMPAD_2: int

The 2 key on the numeric keypad.

Key.NUMPAD_3 ​

ts
static readonly NUMPAD_3: int

The 3 key on the numeric keypad.

Key.NUMPAD_4 ​

ts
static readonly NUMPAD_4: int

The 4 key on the numeric keypad.

Key.NUMPAD_5 ​

ts
static readonly NUMPAD_5: int

The 5 key on the numeric keypad.

Key.NUMPAD_6 ​

ts
static readonly NUMPAD_6: int

The 6 key on the numeric keypad.

Key.NUMPAD_7 ​

ts
static readonly NUMPAD_7: int

The 7 key on the numeric keypad.

Key.NUMPAD_8 ​

ts
static readonly NUMPAD_8: int

The 8 key on the numeric keypad.

Key.NUMPAD_9 ​

ts
static readonly NUMPAD_9: int

The 9 key on the numeric keypad.

Key.NUMPAD_MULT ​

ts
static readonly NUMPAD_MULT: int

Numeric keypad multiply.

Key.NUMPAD_ADD ​

ts
static readonly NUMPAD_ADD: int

Numeric keypad add.

Key.NUMPAD_ENTER ​

ts
static readonly NUMPAD_ENTER: int

Numeric keypad Enter.

Key.NUMPAD_SUB ​

ts
static readonly NUMPAD_SUB: int

Numeric keypad subtract.

Key.NUMPAD_DOT ​

ts
static readonly NUMPAD_DOT: int

Numeric keypad decimal point.

Key.NUMPAD_DIV ​

ts
static readonly NUMPAD_DIV: int

Numeric keypad divide.

Key.A ​

ts
static readonly A: int

The A key (physical position).

Key.B ​

ts
static readonly B: int

The B key (physical position).

Key.C ​

ts
static readonly C: int

The C key (physical position).

Key.D ​

ts
static readonly D: int

The D key (physical position).

Key.E ​

ts
static readonly E: int

The E key (physical position).

Key.F ​

ts
static readonly F: int

The F key (physical position).

Key.G ​

ts
static readonly G: int

The G key (physical position).

Key.H ​

ts
static readonly H: int

The H key (physical position).

Key.I ​

ts
static readonly I: int

The I key (physical position).

Key.J ​

ts
static readonly J: int

The J key (physical position).

Key.K ​

ts
static readonly K: int

The K key (physical position).

Key.L ​

ts
static readonly L: int

The L key (physical position).

Key.M ​

ts
static readonly M: int

The M key (physical position).

Key.N ​

ts
static readonly N: int

The N key (physical position).

Key.O ​

ts
static readonly O: int

The O key (physical position).

Key.P ​

ts
static readonly P: int

The P key (physical position).

Key.Q ​

ts
static readonly Q: int

The Q key (physical position).

Key.R ​

ts
static readonly R: int

The R key (physical position).

Key.S ​

ts
static readonly S: int

The S key (physical position).

Key.T ​

ts
static readonly T: int

The T key (physical position).

Key.U ​

ts
static readonly U: int

The U key (physical position).

Key.V ​

ts
static readonly V: int

The V key (physical position).

Key.W ​

ts
static readonly W: int

The W key (physical position).

Key.X ​

ts
static readonly X: int

The X key (physical position).

Key.Y ​

ts
static readonly Y: int

The Y key (physical position).

Key.Z ​

ts
static readonly Z: int

The Z key (physical position).

Key.F1 ​

ts
static readonly F1: int

The F1 function key.

Key.F2 ​

ts
static readonly F2: int

The F2 function key.

Key.F3 ​

ts
static readonly F3: int

The F3 function key.

Key.F4 ​

ts
static readonly F4: int

The F4 function key.

Key.F5 ​

ts
static readonly F5: int

The F5 function key.

Key.F6 ​

ts
static readonly F6: int

The F6 function key.

Key.F7 ​

ts
static readonly F7: int

The F7 function key.

Key.F8 ​

ts
static readonly F8: int

The F8 function key.

Key.F9 ​

ts
static readonly F9: int

The F9 function key.

Key.F10 ​

ts
static readonly F10: int

The F10 function key.

Key.F11 ​

ts
static readonly F11: int

The F11 function key.

Key.F12 ​

ts
static readonly F12: int

The F12 function key.

Key.F13 ​

ts
static readonly F13: int

The F13 function key.

Key.F14 ​

ts
static readonly F14: int

The F14 function key.

Key.F15 ​

ts
static readonly F15: int

The F15 function key.

Key.F16 ​

ts
static readonly F16: int

The F16 function key.

Key.F17 ​

ts
static readonly F17: int

The F17 function key.

Key.F18 ​

ts
static readonly F18: int

The F18 function key.

Key.F19 ​

ts
static readonly F19: int

The F19 function key.

Key.F20 ​

ts
static readonly F20: int

The F20 function key.

Key.F21 ​

ts
static readonly F21: int

The F21 function key.

Key.F22 ​

ts
static readonly F22: int

The F22 function key.

Key.F23 ​

ts
static readonly F23: int

The F23 function key.

Key.F24 ​

ts
static readonly F24: int

The F24 function key.

Key.SHIFT ​

ts
static readonly SHIFT: int

Alias of LSHIFT.

Key.CTRL ​

ts
static readonly CTRL: int

Alias of LCTRL.

Key.ALT ​

ts
static readonly ALT: int

Alias of LALT.

Key.LSHIFT ​

ts
static readonly LSHIFT: int

Left Shift.

Key.RSHIFT ​

ts
static readonly RSHIFT: int

Right Shift.

Key.LCTRL ​

ts
static readonly LCTRL: int

Left Ctrl.

Key.RCTRL ​

ts
static readonly RCTRL: int

Right Ctrl.

Key.LALT ​

ts
static readonly LALT: int

Left Alt.

Key.RALT ​

ts
static readonly RALT: int

Right Alt.

Key.name ​

ts
static name(code: int): string

The Go-style name of a key ("LeftControl", "PageUp", "Space"), "" for anything that is not a Key constant. Saved bindings store this spelling.

Key.fromName ​

ts
static fromName(name: string): int

The Key constant for a Go-style ("LeftControl") or constant-style ("LCTRL") name; -1 when unknown.

GamepadButton static class ​

ts
static class GamepadButton

Final: it cannot be subclassed.

Gamepad button constants for Gamepad.isDown, isPressed and isReleased.

GamepadButton.A ​

ts
static readonly A: int

The A (bottom) face button.

GamepadButton.B ​

ts
static readonly B: int

The B (right) face button.

GamepadButton.X ​

ts
static readonly X: int

The X (left) face button.

GamepadButton.Y ​

ts
static readonly Y: int

The Y (top) face button.

GamepadButton.LB ​

ts
static readonly LB: int

Left shoulder button.

GamepadButton.RB ​

ts
static readonly RB: int

Right shoulder button.

GamepadButton.LT ​

ts
static readonly LT: int

Left trigger as a button.

GamepadButton.RT ​

ts
static readonly RT: int

Right trigger as a button.

GamepadButton.LEFT_STICK ​

ts
static readonly LEFT_STICK: int

Left stick click.

GamepadButton.RIGHT_STICK ​

ts
static readonly RIGHT_STICK: int

Right stick click.

GamepadButton.DPAD_UP ​

ts
static readonly DPAD_UP: int

D-pad up.

GamepadButton.DPAD_DOWN ​

ts
static readonly DPAD_DOWN: int

D-pad down.

GamepadButton.DPAD_LEFT ​

ts
static readonly DPAD_LEFT: int

D-pad left.

GamepadButton.DPAD_RIGHT ​

ts
static readonly DPAD_RIGHT: int

D-pad right.

GamepadButton.START ​

ts
static readonly START: int

Start button.

GamepadButton.BACK ​

ts
static readonly BACK: int

Back (select) button.

GamepadButton.HOME ​

ts
static readonly HOME: int

Home (guide) button.

GamepadAxis static class ​

ts
static class GamepadAxis

Final: it cannot be subclassed.

Gamepad axis constants for Gamepad.axis and axisRaw.

GamepadAxis.LEFT_X ​

ts
static readonly LEFT_X: int

Left stick horizontal axis.

GamepadAxis.LEFT_Y ​

ts
static readonly LEFT_Y: int

Left stick vertical axis.

GamepadAxis.RIGHT_X ​

ts
static readonly RIGHT_X: int

Right stick horizontal axis.

GamepadAxis.RIGHT_Y ​

ts
static readonly RIGHT_Y: int

Right stick vertical axis.

GamepadAxis.LT ​

ts
static readonly LT: int

Left trigger axis.

GamepadAxis.RT ​

ts
static readonly RT: int

Right trigger axis.

Generated from lang/types/builtin_input_constants.d.tks in the ThicketScript repository.