Enum Input.ActionID

Constants for action key IDs.

Contains both bindable gameplay actions and hard-wired or raw input action IDs. To be used with Input.IsKeyHit, Input.IsKeyHeld, and other similar functions.

Bindable action IDs

FORWARD Forward action.
BACK Back action.
LEFT Left action.
RIGHT Right action.
STEP_LEFT Step left action.
STEP_RIGHT Step right action.
WALK Walk action.
SPRINT Sprint action.
CROUCH Crouch action.
JUMP Jump action.
ROLL Roll action.
ACTION Action key.
DRAW Draw weapon action.
LOOK Look action.
ACCELERATE Accelerate action.
REVERSE Reverse action.
FASTER Faster action.
SLOWER Slower action.
BRAKE Brake action.
FIRE Fire action.
FLARE Flare action.
SMALL_MEDIPACK Small medipack action.
LARGE_MEDIPACK Large medipack action.
PREVIOUS_WEAPON Previous weapon action.
NEXT_WEAPON Next weapon action.
WEAPON_1 Weapon 1 action.
WEAPON_2 Weapon 2 action.
WEAPON_3 Weapon 3 action.
WEAPON_4 Weapon 4 action.
WEAPON_5 Weapon 5 action.
WEAPON_6 Weapon 6 action.
WEAPON_7 Weapon 7 action.
WEAPON_8 Weapon 8 action.
WEAPON_9 Weapon 9 action.
WEAPON_10 Weapon 10 action.
SELECT Select action.
DESELECT Deselect action.
PAUSE Pause action.
INVENTORY Inventory action.
SAVE Save action.
LOAD Load action.

Hard-wired menu navigation IDs

MENU_UP Menu up action.
MENU_DOWN Menu down action.
MENU_LEFT Menu left action.
MENU_RIGHT Menu right action.

Raw keyboard action IDs

A Keyboard A key.
B Keyboard B key.
C Keyboard C key.
D Keyboard D key.
E Keyboard E key.
F Keyboard F key.
G Keyboard G key.
H Keyboard H key.
I Keyboard I key.
J Keyboard J key.
K Keyboard K key.
L Keyboard L key.
M Keyboard M key.
N Keyboard N key.
O Keyboard O key.
P Keyboard P key.
Q Keyboard Q key.
R Keyboard R key.
S Keyboard S key.
T Keyboard T key.
U Keyboard U key.
V Keyboard V key.
W Keyboard W key.
X Keyboard X key.
Y Keyboard Y key.
Z Keyboard Z key.
NUM1 Keyboard 1 key.
NUM2 Keyboard 2 key.
NUM3 Keyboard 3 key.
NUM4 Keyboard 4 key.
NUM5 Keyboard 5 key.
NUM6 Keyboard 6 key.
NUM7 Keyboard 7 key.
NUM8 Keyboard 8 key.
NUM9 Keyboard 9 key.
NUM0 Keyboard 0 key.
F1 Function key F1.
F2 Function key F2.
F3 Function key F3.
F4 Function key F4.
F5 Function key F5.
F6 Function key F6.
F7 Function key F7.
F8 Function key F8.
F9 Function key F9.
F10 Function key F10.
F11 Function key F11.
F12 Function key F12.
RETURN Return/Enter key.
ESCAPE Escape key.
BACKSPACE Backspace key.
TAB Tab key.
SPACE Space key.
PAGE_UP Page up key.
PAGE_DOWN Page down key.
INSERT Insert key.
HOME Home key.
END End key.
DELETE Delete key.
PAUSE_KEY Pause/Break key.
PRINT_SCREEN Print Screen key.
SCROLL_LOCK Scroll Lock key.
CAPS_LOCK Caps Lock key.
NUM_LOCK Num Lock key.
MINUS Minus key.
EQUALS Equals key.
BRACKET_LEFT Left bracket key.
BRACKET_RIGHT Right bracket key.
BACKSLASH Backslash key.
SEMICOLON Semicolon key.
APOSTROPHE Apostrophe key.
COMMA Comma key.
PERIOD Period key.
SLASH Slash key.
ARROW_UP Arrow up key.
ARROW_DOWN Arrow down key.
ARROW_LEFT Arrow left key.
ARROW_RIGHT Arrow right key.
CTRL Control key.
SHIFT Shift key.
ALT Alt key.

Raw mouse action IDs

MOUSE_CLICK_LEFT Mouse left click.
MOUSE_CLICK_MIDDLE Mouse middle click.
MOUSE_CLICK_RIGHT Mouse right click.
MOUSE_SCROLL_UP Mouse scroll up.
MOUSE_SCROLL_DOWN Mouse scroll down.
MOUSE_UP Mouse up movement.
MOUSE_DOWN Mouse down movement.
MOUSE_LEFT Mouse left movement.
MOUSE_RIGHT Mouse right movement.

Raw gamepad action IDs

GAMEPAD_SOUTH Gamepad south button.
GAMEPAD_EAST Gamepad east button.
GAMEPAD_WEST Gamepad west button.
GAMEPAD_NORTH Gamepad north button.
GAMEPAD_BACK Gamepad back button.
GAMEPAD_GUIDE Gamepad guide button.
GAMEPAD_START Gamepad start button.
GAMEPAD_LEFT_STICK_UP Gamepad left stick up direction.
GAMEPAD_LEFT_STICK_DOWN Gamepad left stick down direction.
GAMEPAD_LEFT_STICK_LEFT Gamepad left stick left direction.
GAMEPAD_LEFT_STICK_RIGHT Gamepad left stick right direction.
GAMEPAD_LEFT_STICK Gamepad left stick click.
GAMEPAD_RIGHT_STICK_UP Gamepad right stick up direction.
GAMEPAD_RIGHT_STICK_DOWN Gamepad right stick down direction.
GAMEPAD_RIGHT_STICK_LEFT Gamepad right stick left direction.
GAMEPAD_RIGHT_STICK_RIGHT Gamepad right stick right direction.
GAMEPAD_RIGHT_STICK Gamepad right stick click.
GAMEPAD_LEFT_SHOULDER Gamepad left shoulder button.
GAMEPAD_RIGHT_SHOULDER Gamepad right shoulder button.
GAMEPAD_DPAD_UP Gamepad D-Pad up button.
GAMEPAD_DPAD_DOWN Gamepad D-Pad down button.
GAMEPAD_DPAD_LEFT Gamepad D-Pad left button.
GAMEPAD_DPAD_RIGHT Gamepad D-Pad right button.
GAMEPAD_LEFT_PADDLE1 Gamepad left paddle 1 button.
GAMEPAD_LEFT_PADDLE2 Gamepad left paddle 2 button.
GAMEPAD_RIGHT_PADDLE1 Gamepad right paddle 1 button.
GAMEPAD_RIGHT_PADDLE2 Gamepad right paddle 2 button.
GAMEPAD_TOUCHPAD Gamepad touchpad button.
GAMEPAD_MISC1 Gamepad misc 1 button.
GAMEPAD_MISC2 Gamepad misc 2 button.
GAMEPAD_MISC3 Gamepad misc 3 button.
GAMEPAD_MISC4 Gamepad misc 4 button.
GAMEPAD_MISC5 Gamepad misc 5 button.
GAMEPAD_MISC6 Gamepad misc 6 button.
GAMEPAD_LEFT_TRIGGER Gamepad left trigger.
GAMEPAD_RIGHT_TRIGGER Gamepad right trigger.


Bindable action IDs

Actions in this section are exposed through the control settings and binding profiles. Use them when script logic should follow the player's configured bindings instead of physical device buttons.
FORWARD
Forward action.
BACK
Back action.
LEFT
Left action.
RIGHT
Right action.
STEP_LEFT
Step left action.
STEP_RIGHT
Step right action.
WALK
Walk action.
SPRINT
Sprint action.
CROUCH
Crouch action.
JUMP
Jump action.
ROLL
Roll action.
ACTION
Action key.
DRAW
Draw weapon action.
LOOK
Look action.
ACCELERATE
Accelerate action.
REVERSE
Reverse action.
FASTER
Faster action.
SLOWER
Slower action.
BRAKE
Brake action.
FIRE
Fire action.
FLARE
Flare action.
SMALL_MEDIPACK
Small medipack action.
LARGE_MEDIPACK
Large medipack action.
PREVIOUS_WEAPON
Previous weapon action.
NEXT_WEAPON
Next weapon action.
WEAPON_1
Weapon 1 action.
WEAPON_2
Weapon 2 action.
WEAPON_3
Weapon 3 action.
WEAPON_4
Weapon 4 action.
WEAPON_5
Weapon 5 action.
WEAPON_6
Weapon 6 action.
WEAPON_7
Weapon 7 action.
WEAPON_8
Weapon 8 action.
WEAPON_9
Weapon 9 action.
WEAPON_10
Weapon 10 action.
SELECT
Select action.
DESELECT
Deselect action.
PAUSE
Pause action.
INVENTORY
Inventory action.
SAVE
Save action.
LOAD
Load action.

Hard-wired menu navigation IDs

This section contains menu navigation actions that are hard-wired to specific raw input bindings such as keyboard arrows or gamepad axis and D-Pad, and cannot be rebound by the player.
MENU_UP
Menu up action.
MENU_DOWN
Menu down action.
MENU_LEFT
Menu left action.
MENU_RIGHT
Menu right action.

Raw keyboard action IDs

This section contains raw keyboard input IDs, including function keys. Use these values when script logic must read physical keyboard state directly.
A
Keyboard A key.
B
Keyboard B key.
C
Keyboard C key.
D
Keyboard D key.
E
Keyboard E key.
F
Keyboard F key.
G
Keyboard G key.
H
Keyboard H key.
I
Keyboard I key.
J
Keyboard J key.
K
Keyboard K key.
L
Keyboard L key.
M
Keyboard M key.
N
Keyboard N key.
O
Keyboard O key.
P
Keyboard P key.
Q
Keyboard Q key.
R
Keyboard R key.
S
Keyboard S key.
T
Keyboard T key.
U
Keyboard U key.
V
Keyboard V key.
W
Keyboard W key.
X
Keyboard X key.
Y
Keyboard Y key.
Z
Keyboard Z key.
NUM1
Keyboard 1 key.
NUM2
Keyboard 2 key.
NUM3
Keyboard 3 key.
NUM4
Keyboard 4 key.
NUM5
Keyboard 5 key.
NUM6
Keyboard 6 key.
NUM7
Keyboard 7 key.
NUM8
Keyboard 8 key.
NUM9
Keyboard 9 key.
NUM0
Keyboard 0 key.
F1
Function key F1.
F2
Function key F2.
F3
Function key F3.
F4
Function key F4.
F5
Function key F5.
F6
Function key F6.
F7
Function key F7.
F8
Function key F8.
F9
Function key F9.
F10
Function key F10.
F11
Function key F11.
F12
Function key F12.
RETURN
Return/Enter key.
ESCAPE
Escape key.
BACKSPACE
Backspace key.
TAB
Tab key.
SPACE
Space key.
PAGE_UP
Page up key.
PAGE_DOWN
Page down key.
INSERT
Insert key.
HOME
Home key.
END
End key.
DELETE
Delete key.
PAUSE_KEY
Pause/Break key.
PRINT_SCREEN
Print Screen key.
SCROLL_LOCK
Scroll Lock key.
CAPS_LOCK
Caps Lock key.
NUM_LOCK
Num Lock key.
MINUS
Minus key.
EQUALS
Equals key.
BRACKET_LEFT
Left bracket key.
BRACKET_RIGHT
Right bracket key.
BACKSLASH
Backslash key.
SEMICOLON
Semicolon key.
APOSTROPHE
Apostrophe key.
COMMA
Comma key.
PERIOD
Period key.
SLASH
Slash key.
ARROW_UP
Arrow up key.
ARROW_DOWN
Arrow down key.
ARROW_LEFT
Arrow left key.
ARROW_RIGHT
Arrow right key.
CTRL
Control key. Registers both left and right keys.
SHIFT
Shift key. Registers both left and right keys.
ALT
Alt key. Registers both left and right keys.

Raw mouse action IDs

This section contains raw mouse button, wheel, and movement direction input IDs. Use these values when script logic must read physical mouse state directly.
MOUSE_CLICK_LEFT
Mouse left click.
MOUSE_CLICK_MIDDLE
Mouse middle click.
MOUSE_CLICK_RIGHT
Mouse right click.
MOUSE_SCROLL_UP
Mouse scroll up.
MOUSE_SCROLL_DOWN
Mouse scroll down.
MOUSE_UP
Mouse up movement.
MOUSE_DOWN
Mouse down movement.
MOUSE_LEFT
Mouse left movement.
MOUSE_RIGHT
Mouse right movement.

Raw gamepad action IDs

This section contains raw gamepad button, stick direction, D-Pad, paddle, touchpad, and trigger input IDs. Use these values when script logic must read physical gamepad state directly.
GAMEPAD_SOUTH
Gamepad south button. Corresponds to the "A" button on Xbox controllers and "Cross" on PlayStation controllers.
GAMEPAD_EAST
Gamepad east button. Corresponds to the "B" button on Xbox controllers and "Circle" on PlayStation controllers.
GAMEPAD_WEST
Gamepad west button. Corresponds to the "X" button on Xbox controllers and "Square" on PlayStation controllers.
GAMEPAD_NORTH
Gamepad north button. Corresponds to the "Y" button on Xbox controllers and "Triangle" on PlayStation controllers.
GAMEPAD_BACK
Gamepad back button. Corresponds to the "Select" button on PlayStation 3/4 controllers and "Share" button on PlayStation 5 controllers.
GAMEPAD_GUIDE
Gamepad guide button. Corresponds to the "Xbox" button on Xbox controllers and "PlayStation" button on PlayStation controllers.
GAMEPAD_START
Gamepad start button. Corresponds to the "Options" button on PlayStation 4/5 controllers.
GAMEPAD_LEFT_STICK_UP
Gamepad left stick up direction.
GAMEPAD_LEFT_STICK_DOWN
Gamepad left stick down direction.
GAMEPAD_LEFT_STICK_LEFT
Gamepad left stick left direction.
GAMEPAD_LEFT_STICK_RIGHT
Gamepad left stick right direction.
GAMEPAD_LEFT_STICK
Gamepad left stick click.
GAMEPAD_RIGHT_STICK_UP
Gamepad right stick up direction.
GAMEPAD_RIGHT_STICK_DOWN
Gamepad right stick down direction.
GAMEPAD_RIGHT_STICK_LEFT
Gamepad right stick left direction.
GAMEPAD_RIGHT_STICK_RIGHT
Gamepad right stick right direction.
GAMEPAD_RIGHT_STICK
Gamepad right stick click.
GAMEPAD_LEFT_SHOULDER
Gamepad left shoulder button.
GAMEPAD_RIGHT_SHOULDER
Gamepad right shoulder button.
GAMEPAD_DPAD_UP
Gamepad D-Pad up button.
GAMEPAD_DPAD_DOWN
Gamepad D-Pad down button.
GAMEPAD_DPAD_LEFT
Gamepad D-Pad left button.
GAMEPAD_DPAD_RIGHT
Gamepad D-Pad right button.
GAMEPAD_LEFT_PADDLE1
Gamepad left paddle 1 button. Available only for Xbox Elite controllers and similar models with rear paddles.
GAMEPAD_LEFT_PADDLE2
Gamepad left paddle 2 button. Available only for Xbox Elite controllers and similar models with rear paddles.
GAMEPAD_RIGHT_PADDLE1
Gamepad right paddle 1 button. Available only for Xbox Elite controllers and similar models with rear paddles.
GAMEPAD_RIGHT_PADDLE2
Gamepad right paddle 2 button. Available only for Xbox Elite controllers and similar models with rear paddles.
GAMEPAD_TOUCHPAD
Gamepad touchpad button. Available only for PlayStation controllers with a clickable touchpad, such as DualShock 4 and DualSense.
GAMEPAD_MISC1
Gamepad misc 1 button.
GAMEPAD_MISC2
Gamepad misc 2 button.
GAMEPAD_MISC3
Gamepad misc 3 button.
GAMEPAD_MISC4
Gamepad misc 4 button.
GAMEPAD_MISC5
Gamepad misc 5 button.
GAMEPAD_MISC6
Gamepad misc 6 button.
GAMEPAD_LEFT_TRIGGER
Gamepad left trigger.
GAMEPAD_RIGHT_TRIGGER
Gamepad right trigger.
generated by TEN-LDoc (a fork of LDoc 1.4.6)