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.

This class is not browsable. It is not visible in Studio's object browser.
Memory categoryInstances
Tags: [NotBrowsable]

Member index 3

HistoryMember
663Enabled: bool
663Priority: int
663Sink: bool
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(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 7

Members 3

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 2

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 2

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 2

Settings