Reference API Roblox

Engine API

Website

Related

Reference API Roblox

InputContext

Collection of actions which holds related actions and defines how they interact with other contexts/actions.

Memory categoryInstances

Member index 5

HistoryMember
731Enabled: bool
731Priority: int
731Sink: bool
708GetInputActions(): Instances
708InputActionsChanged()
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

An InputContext is a collection of actions which holds related InputActions and defines how they interact with other contexts and actions. Nested InputContext instances will have no effect and ordering/priority is managed through Enabled, Priority, and Sink.

History 16

Members 5

Enabled

TypeDefault
booltrue

Determines if this InputContext is enabled or not. When false, all of the descendant actions of the context do not receive any signals except when Enabled is toggled from true to false, in which case a final "end" signal is triggered if a key is pressed or a two-directional input is not zero.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

GetInputActions

Parameters (0)
No parameters.
Returns (1)
Instances
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

InputActionsChanged

Parameters (0)
No parameters.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Priority

TypeDefault
int1000

The priority level at which the context should be run (higher priority InputContext instances run before lower ones).

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

Sink

TypeDefault
boolfalse

When Sink is set to true, inputs will not be processed for connected InputAction bindings within contexts of lower Priority. Contexts with the same priority will receive the input.

For example, if multiple contexts contain an InputAction with a binding to KeyCode.E and a higher priority context has Sink set to true, the lower priority contexts will not receive the input signal for KeyCode.E and will fire no events for it.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

  • 731 Change Default of Sink from to false
  • 726 Change Default of Sink from false to
  • 663 Change Category of Sink from Data to Behavior
  • 661 Add Sink

Settings