InputAction
CreatorHub

Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using InputBinding.

Memory category	Instances

Member index 16

History		Member
731		BoolState: bool
731		Direction1DState: float
731		Direction2DState: Vector2
731		Direction3DState: Vector3
731		Enabled: bool
731		PreferredBinding: InputBinding
731		Type: InputActionType
731		ViewportPositionState: Vector2
731		Fire(state: Variant): null
708		GetInputBindings(): Instances
731		GetPreferredBindingList(count: int = 0): Instances
704		GetState(): Variant
708		InputBindingsChanged()
661		Pressed()
661		Released()
661		StateChanged(value: Variant)
68 members inherited from Instance
731		Archivable: bool
731		Attributes: string
731		AttributesReplicate: string
731		AttributesSerialize: BinaryString
731		Capabilities: SecurityCapabilities
731		DataCost: int
731		DefinesCapabilities: bool
731		HistoryId: UniqueId
731		IsInSandbox: bool
731		Name: string
731		Parent: Instance
731		PredictionMode: PredictionMode
731		PropertyStatusStudio: PropertyStatus
731		RobloxLocked: bool
731		Sandboxed: bool
731		SourceAssetId: int64
731		Tags: SharedString
731		UniqueId: UniqueId
731		archivable: bool
731		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
731		children(): Instances
731		clone(): Instance
731		destroy(): null
731		findFirstChild(name: string, recursive: bool = false): Instance
731		getChildren(): Instances
731		isDescendantOf(ancestor: Instance): bool
731		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
731		childAdded(child: Instance)
6 members inherited from Object
731		ClassName: string
731		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
731		isA(className: string): bool
647		Changed(property: string)

Description

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).

History 38
Hide member changes

731 Add GetPreferredBindingList
731 Change PreferredDescriptor of Fire from to Fire
731 Change Default of ViewportPositionState from to Vector2(0, 0)
731 Change Default of Type from to Bool
731 Add PreferredBinding
731 Change Default of Enabled from to true
731 Change Default of Direction3DState from to Vector3(0, 0, 0)
731 Change Default of Direction2DState from to Vector2(0, 0)
731 Change Default of Direction1DState from to 0
731 Change Default of BoolState from to false
727 Change Tags of Fire from [] to [Deprecated]
726 Change Default of ViewportPositionState from Vector2(0, 0) to
726 Change Default of Type from Bool to
726 Change Default of Enabled from true to
726 Change Default of Direction3DState from Vector3(0, 0, 0) to
726 Change Default of Direction2DState from Vector2(0, 0) to
726 Change Default of Direction1DState from 0 to
726 Change Default of BoolState from false to
708 Add InputBindingsChanged
708 Add GetInputBindings
706 Add ViewportPositionState
704 Change ThreadSafety of GetState from Unsafe to Safe
687 Change Tags of InputAction from [NotBrowsable] to []
677 Add Direction3DState
676 Add Direction2DState
676 Add Direction1DState
676 Add BoolState
674 Change Parameters of Fire from (value: Variant) to (state: Variant)
663 Change Category of Type from Data to Behavior
663 Change Category of Enabled from Data to Behavior
661 Add StateChanged
661 Add Released
661 Add Pressed
661 Add GetState
661 Add Fire
661 Add Type
661 Add Enabled
661 Add InputAction

Members 16

BoolState
CreatorHub

Type		Default
bool		false

A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of Bool.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

731 Change Default of BoolState from to false
726 Change Default of BoolState from false to
676 Add BoolState

Tags: [ReadOnly, NotReplicated, NotScriptable]

Direction1DState
CreatorHub

Type		Default
float		0

A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of Direction1D.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

731 Change Default of Direction1DState from to 0
726 Change Default of Direction1DState from 0 to
676 Add Direction1DState

Tags: [ReadOnly, NotReplicated, NotScriptable]

Direction2DState
CreatorHub

Type		Default
Vector2		0, 0

A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of Direction2D.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

731 Change Default of Direction2DState from to Vector2(0, 0)
726 Change Default of Direction2DState from Vector2(0, 0) to
676 Add Direction2DState

Tags: [ReadOnly, NotReplicated, NotScriptable]

Direction3DState
CreatorHub

Type		Default
Vector3		0, 0, 0

A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of Direction3D.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

731 Change Default of Direction3DState from to Vector3(0, 0, 0)
726 Change Default of Direction3DState from Vector3(0, 0, 0) to
677 Add Direction3DState

Tags: [ReadOnly, NotReplicated, NotScriptable]

Enabled
CreatorHub

Type		Default
bool		true

Determines if the InputAction is enabled or not. The action state will be reset if this property is toggled to false.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 4

731 Change Default of Enabled from to true
726 Change Default of Enabled from true to
663 Change Category of Enabled from Data to Behavior
661 Add Enabled

Fire
CreatorHub

Parameters (1)
state	Variant
Returns (1)
null

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.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 4

731 Change PreferredDescriptor of Fire from to Fire
727 Change Tags of Fire from [] to [Deprecated]
674 Change Parameters of Fire from (value: Variant) to (state: Variant)
661 Add Fire

Tags: [Deprecated]

GetInputBindings
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Instances

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

708 Add GetInputBindings

GetPreferredBindingList
CreatorHub

Parameters (1)		Default
count	int	0
Returns (1)
Instances

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

731 Add GetPreferredBindingList

GetState
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Variant

Returns the current state of the InputAction, for example true for an action with Type set to Bool.

Thread safety	Safe

History 2

704 Change ThreadSafety of GetState from Unsafe to Safe
661 Add GetState

InputBindingsChanged
CreatorHub

Parameters (0)
No parameters.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

708 Add InputBindingsChanged

PreferredBinding
CreatorHub

Type		Default
InputBinding

A read-only reference to the InputBinding child that matches the player's current input device using PreferredInput.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false/true

History 1

731 Add PreferredBinding

Tags: [ReadOnly, NotReplicated]

Pressed
CreatorHub

Parameters (0)
No parameters.

This event fires only when the Type is set to Bool, and only when the state transitions from false to true.

Thread safety	Unsafe

History 1

661 Add Pressed

Released
CreatorHub

Parameters (0)
No parameters.

This event fires only when the Type is set to Bool, and only when the state transitions from true to false.

Thread safety	Unsafe

History 1

661 Add Released

StateChanged
CreatorHub

Parameters (1)
value	Variant

This event fires for all InputActionType types whenever the state changes, except if the state attempts to transition to the same state.

Thread safety	Unsafe

History 1

661 Add StateChanged

Type
CreatorHub

Type		Default
InputActionType		Bool

Specifies what type of input value the action is expecting. See InputActionType for more details.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 4

731 Change Default of Type from to Bool
726 Change Default of Type from Bool to
663 Change Category of Type from Data to Behavior
661 Add Type

ViewportPositionState
CreatorHub

Type		Default
Vector2		0, 0

A non-scriptable read-only property only visible in Studio, primarily useful for debugging while testing an InputAction with Type of ViewportPosition.

It cannot be accessed by script code.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 3

731 Change Default of ViewportPositionState from to Vector2(0, 0)
726 Change Default of ViewportPositionState from Vector2(0, 0) to
706 Add ViewportPositionState

Tags: [ReadOnly, NotReplicated, NotScriptable]

Engine API

Website

Related

History 3

History 3

History 3

History 3

History 4

History 4

History 1

History 1

History 2

History 1

History 1

History 1

History 1

History 1

History 4

History 3