Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
InputAction
Inherits from: Instance → Object
InputAction defines a gameplay action mechanic such as "Jump," "Sprint," or "Shoot." These actions are then mapped to hardware inputs using InputBinding. An InputAction will check for its first ancestor type of InputContext and register itself to that context (if there is no ancestor context, it will be registered to a default context).
Inherits from: Instance
Memory category: Instances
Properties
| Name | Type / Returns | Description |
|---|---|---|
| InputAction.BoolState | boolean | Non-scriptable read-only property useful for debugging Bool input actions. |
| InputAction.Direction1DState | float | Non-scriptable read-only property useful for debugging Direction1D input actions. |
| InputAction.Direction2DState | Vector2 | Non-scriptable read-only property useful for debugging Direction2D input actions. |
| InputAction.Direction3DState | Vector3 | Non-scriptable read-only property useful for debugging Direction3D input actions. |
| InputAction.DisplayName | string | Localized display name for this action. |
| InputAction.Enabled | boolean | Determines if the InputAction is enabled or not. |
| InputAction.PreferredBinding | InputBinding | The InputBinding best matching the player's current input device. |
| InputAction.Type | InputActionType | Specifies what type of input value the action is expecting. |
| InputAction.ViewportPositionState | Vector2 | Non-scriptable read-only property useful for debugging ViewportPosition input actions. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
InputAction.BoolState
A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of Bool.
| Field | Value |
|---|---|
| type | boolean |
| tags | ["ReadOnly","NotReplicated","NotScriptable"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
InputAction.Direction1DState
A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of Direction1D.
| Field | Value |
|---|---|
| type | float |
| tags | ["ReadOnly","NotReplicated","NotScriptable"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
InputAction.Direction2DState
A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of Direction2D.
| Field | Value |
|---|---|
| type | Vector2 |
| tags | ["ReadOnly","NotReplicated","NotScriptable"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
InputAction.Direction3DState
A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of Direction3D.
| Field | Value |
|---|---|
| type | Vector3 |
| tags | ["ReadOnly","NotReplicated","NotScriptable"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
InputAction.DisplayName
A custom string used to show a localized display name for this action in UI elements such as a controls help menu.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Display |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
| simulationAccess | true |
InputAction.Enabled
Determines if the InputAction is enabled or not. The action state will be reset if this property is toggled to false.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Behavior |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
| simulationAccess | true |
InputAction.PreferredBinding
A read-only reference to the InputBinding child that matches the player's current input device using UserInputService.PreferredInput.
| Field | Value |
|---|---|
| type | InputBinding |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":true} |
| capabilities | ["Input"] |
InputAction.Type
Specifies what type of input value the action is expecting. See InputActionType for more details.
| Field | Value |
|---|---|
| type | InputActionType |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Behavior |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
| simulationAccess | true |
InputAction.ViewportPositionState
A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of ViewportPosition.
| Field | Value |
|---|---|
| type | Vector2 |
| tags | ["ReadOnly","NotReplicated","NotScriptable"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Input"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| InputAction:Fire | () | Updates the InputAction to the given state and fires the appropriate signals. |
| InputAction:GetState | Variant | Returns the current state of the InputAction. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
InputAction:Fire
Deprecated. Use InputBinding:Fire() with a Scriptable binding instead.
Updates the InputAction to the given state and fires the appropriate signals. This method is most useful for script‑triggered "input" where the passed state should trigger events like Pressed or StateChanged regardless of whether the player triggered that state through normal inputs.
This method will only accept a state parameter that matches the Type and attempting to call it with a mismatched type will cause an error, for example passing a state of 0.5 when the Type is Bool.
Note that this method follows the conditions of Pressed, Released, and StateChanged. For example, if you make multiple consecutive calls to Fire() with a state of true, StateChanged will only fire on the first state change and the subsequent calls to Fire() will do nothing.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| state | Variant |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Input"] |
| simulationAccess | true |
InputAction:GetState
Returns the current state of the InputAction, for example true for an action with Type set to Bool.
Returns
| Type | Description |
|---|---|
| Variant | The current state of InputAction. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Safe |
| capabilities | ["Input"] |
| simulationAccess | true |
Events
| Name | Type / Returns | Description |
|---|---|---|
| InputAction.Pressed | Fires only when the InputAction.Type is set to Bool on a state transition from false to true. | |
| InputAction.Released | Fires only when the InputAction.Type is set to Bool on a state transition from true to false. | |
| InputAction.StateChanged | Fires for all InputActionType types whenever the state changes, except if the state attempts to transition to the same state. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
InputAction.Pressed
This event fires only when the Type is set to Bool, and only when the state transitions from false to true.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |
InputAction.Released
This event fires only when the Type is set to Bool, and only when the state transitions from true to false.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |
InputAction.StateChanged
This event fires for all InputActionType types whenever the state changes, except if the state attempts to transition to the same state.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | Variant | The new state of the InputAction. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |