InputBinding
CreatorHub

Defines which hardware binding should trigger the parent InputAction.

It is not visible in Studio's object browser.

Memory category	Instances

Tags: [NotBrowsable]

Member index 10

History		Member
667		Down: KeyCode
663		KeyCode: KeyCode
667		Left: KeyCode
665		PressedThreshold: float
665		ReleasedThreshold: float
667		Right: KeyCode
667		Scale: float
663		UIButton: GuiButton
667		Up: KeyCode
667		Vector2Scale: Vector2
65 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
670		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
670		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		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
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: 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
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
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		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()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Description

An InputBinding defines which hardware binding should trigger the parent InputAction, for example a key press, gamepad button, or tap on a touch‑enabled device. There can be multiple InputBinding instances parented to an InputAction.

History 14
Hide member changes

667 Add Vector2Scale
667 Add Up
667 Change Category of Scale from Data to Behavior
667 Add Right
667 Add Left
667 Add Down
665 Add Scale
665 Add ReleasedThreshold
665 Add PressedThreshold
663 Change Category of UIButton from Data to Behavior
663 Change Category of KeyCode from Data to Behavior
661 Add UIButton
661 Add KeyCode
661 Add InputBinding

Members 10

Down
CreatorHub

Type		Default
KeyCode		Unknown

Specifies an alternate KeyCode for dispatching directionally "down" inputs to GetState() and the StateChanged event of the parent InputAction. When the parent action's Type is Direction1D, the dispatched value will be between 0 and -1. When the parent action's Type is Direction2D, the dispatched value will be a Vector2 between (0, 0) and (0, -1).

Thread safety	ReadSafe
Category	Composite Directions
Loaded/Saved	true

History 1

667 Add Down

KeyCode
CreatorHub

Type		Default
KeyCode		Unknown

Specifies the KeyCode which triggers the parent InputAction. The code type should match the input action's Type, for example KeyCode.E for an action type of Bool or KeyCode.Thumbstick1 for an action type of Direction2D. Type mismatches will either not fire the InputAction or the StateChanged event will receive a converted value.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 2

663 Change Category of KeyCode from Data to Behavior
661 Add KeyCode

Left
CreatorHub

Type		Default
KeyCode		Unknown

Specifies an alternate KeyCode for dispatching directionally "left" inputs to GetState() and the StateChanged event of the parent InputAction. Only applies when the parent action's Type is Direction2D, in which case the dispatched value will be a Vector2 between (0, 0) and (-1, 0).

Thread safety	ReadSafe
Category	Composite Directions
Loaded/Saved	true

History 1

667 Add Left

PressedThreshold
CreatorHub

Type		Default
float		0.5

Numerical value above which to fire an InputAction with a Type of Bool, for example when a gamepad trigger such as KeyCode.ButtonL2 exceeds 0.5 (halfway pressed). Default is 0.5.

This property must be greater than or equal to ReleasedThreshold or else it will be clamped to ReleasedThreshold.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 1

665 Add PressedThreshold

ReleasedThreshold
CreatorHub

Type		Default
float		0.200000003

Numerical value below which to fire an InputAction with a Type of Bool, for example when a gamepad trigger such as KeyCode.ButtonL2 falls below 0.5 (less than halfway pressed). Default is 0.2.

This property must be less than or equal to PressedThreshold or else it will be clamped to PressedThreshold.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 1

665 Add ReleasedThreshold

Right
CreatorHub

Type		Default
KeyCode		Unknown

Specifies an alternate KeyCode for dispatching directionally "right" inputs to GetState() and the StateChanged event of the parent InputAction. Only applies when the parent action's Type is Direction2D, in which case the dispatched value will be a Vector2 between (0, 0) and (1, 0).

Thread safety	ReadSafe
Category	Composite Directions
Loaded/Saved	true

History 1

667 Add Right

Scale
CreatorHub

Type		Default
float		1

Amount by which to linearly scale the values of an InputAction with Type of Direction1D or Direction2D.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 2

667 Change Category of Scale from Data to Behavior
665 Add Scale

UIButton
CreatorHub

Type		Default
GuiButton

GuiButton to connect to a boolean action.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 2

663 Change Category of UIButton from Data to Behavior
661 Add UIButton

Up
CreatorHub

Type		Default
KeyCode		Unknown

Specifies an alternate KeyCode for dispatching directionally "up" inputs to GetState() and the StateChanged event of the parent InputAction. When the parent action's Type is Direction1D, the dispatched value will be between 0 and 1. When the parent action's Type is Direction2D, the dispatched value will be a Vector2 between (0, 0) and (0, 1).

Thread safety	ReadSafe
Category	Composite Directions
Loaded/Saved	true

History 1

667 Add Up

Vector2Scale
CreatorHub

Type		Default
Vector2		1, 1

Amount by which to linearly scale the values of an InputAction with Type of Direction2D.

Thread safety	ReadSafe
Category	Behavior
Loaded/Saved	true

History 1

667 Add Vector2Scale

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

InputBinding
CreatorHub

Member index 10

Description

History 14
Hide member changes

Members 10

Down
CreatorHub

History 1

KeyCode
CreatorHub

History 2

Left
CreatorHub

History 1

PressedThreshold
CreatorHub

History 1

ReleasedThreshold
CreatorHub

History 1

Right
CreatorHub

History 1

Scale
CreatorHub

History 2

UIButton
CreatorHub

History 2

Up
CreatorHub

History 1

Vector2Scale
CreatorHub

History 1

Settings