Class
InputContext
Collection of actions which holds related actions and defines how they interact with other contexts/actions.
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.
Properties 3#
Enabledboolean | Determines if this InputContext is enabled or not.ReadSafe |
Priorityint | The priority level at which the context should be run.ReadSafe |
Sinkboolean | Determines whether input bindings of lower priority will be processed.ReadSafe |
Enabled: boolean#
ReadSafe
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.
Priority: int#
ReadSafe
The priority level at which the context should be run (higher priority
InputContext instances run before lower ones).
Sink: boolean#
ReadSafe
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.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild