3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

InputActionType

This enum is used by InputAction.Type to determine which input data type the InputAction will receive.

Items

NameValueDescription
Bool0The InputAction will receive boolean values from button inputs, for example true/false on press/release from inputs such as KeyCode.ButtonA or KeyCode.E. This setting also exposes the UIButton property on child InputBindings, allowing you to easily hook up press or release of a GuiButton for the action.
Direction1D1The InputAction will receive numerical values, generally from analog gamepad triggers such as KeyCode.ButtonL2 or KeyCode.ButtonR2. This setting also exposes the Up and Down properties on child InputBindings, allowing for boolean inputs or "1D" inputs as composite directions for the action.
Direction2D2The InputAction will receive Vector2 values, generally from thumbstick inputs such as KeyCode.Thumbstick1 and KeyCode.Thumbstick2. This setting also exposes the Up, Down, Left, and Right properties on child InputBindings, allowing for "2D" inputs as composite directions for the action.
Direction3D3The InputAction will receive Vector3 values from inputs assigned to the Up, Down, Left, Right, Forward, and/or Backward properties on child InputBindings, allowing for "3D" inputs as composite directions for the action.
ViewportPosition4The InputAction will receive Vector2 values representing the absolute pixel (X, Y) coordinates of a pointer input in the viewport.

Bool

The InputAction will receive boolean values from button inputs, for example true/false on press/release from inputs such as KeyCode.ButtonA or KeyCode.E. This setting also exposes the UIButton property on child InputBindings, allowing you to easily hook up press or release of a GuiButton for the action.

FieldValue
value0

Direction1D

The InputAction will receive numerical values, generally from analog gamepad triggers such as KeyCode.ButtonL2 or KeyCode.ButtonR2. This setting also exposes the Up and Down properties on child InputBindings, allowing for boolean inputs or "1D" inputs as composite directions for the action.

FieldValue
value1

Direction2D

The InputAction will receive Vector2 values, generally from thumbstick inputs such as KeyCode.Thumbstick1 and KeyCode.Thumbstick2. This setting also exposes the Up, Down, Left, and Right properties on child InputBindings, allowing for "2D" inputs as composite directions for the action.

FieldValue
value2

Direction3D

The InputAction will receive Vector3 values from inputs assigned to the Up, Down, Left, Right, Forward, and/or Backward properties on child InputBindings, allowing for "3D" inputs as composite directions for the action.

FieldValue
value3

ViewportPosition

The InputAction will receive Vector2 values representing the absolute pixel (X, Y) coordinates of a pointer input in the viewport.

FieldValue
value4