Class InputContextPushedEvent

Published via the Scylla Event eXchange System (SEX) when an input context is pushed onto the context stack, making it the new active context.

Inheritance
object
ScyllaEvent
InputContextPushedEvent
Inherited Members
ScyllaEvent.IsCancelled
ScyllaEvent.StopPropagation()
Namespace: Scylla.Input
Assembly: ScyllaInput.dll
Syntax
public class InputContextPushedEvent : ScyllaEvent
Remarks

When a context is pushed it becomes the topmost entry on the stack and its configured action maps are enabled while any maps it disables are suppressed. If the pushed context has BlocksLowerPriority or ConsumesAllInput set, lower-priority contexts on the stack will not receive input.

Subscribe via ScyllaEvents.Listen<InputContextPushedEvent>. InputContextChangedEvent is also published immediately after this event to summarize the net state change.

Constructors

InputContextPushedEvent(string, InputContext, int)

Initializes a new InputContextPushedEvent.

Declaration
public InputContextPushedEvent(string contextID, InputContext context, int stackDepth)
Parameters
Type Name Description
string contextID

The ID of the context that was pushed. Never null or empty.
InputContext context

The InputContext object that was pushed onto the stack.
int stackDepth

The total number of contexts on the stack after this push operation. Will be at least 1.

Properties

Context

Gets the InputContext object that was pushed. Use this reference to inspect the context's action map configuration, priority, and blocking behavior.

Declaration
public InputContext Context { get; }
Property Value
Type Description
InputContext

ContextID

Gets the ID of the context that was pushed onto the stack.

Declaration
public string ContextID { get; }
Property Value
Type Description
string

StackDepth

Gets the total number of contexts on the stack after the push. A value of 1 means this is the only active context.

Declaration
public int StackDepth { get; }
Property Value
Type Description
int

See Also