Class InputContextPoppedEvent

Published via the Scylla Event eXchange System (SEX) when an input context is popped from the context stack, restoring the previously active context (if any) to the top position.

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

When a context is popped its action map overrides are reversed: maps it had enabled may be disabled again and maps it had disabled may be re-enabled, depending on the remaining contexts on the stack. The context that was below the popped context becomes the new active context.

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

Constructors

InputContextPoppedEvent(string, InputContext, int)

Initializes a new InputContextPoppedEvent.

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

The ID of the context that was removed from the stack. Never null or empty.
InputContext context

The InputContext object that was popped.
int stackDepth

The total number of contexts remaining on the stack after the pop. A value of 0 means the stack is now empty.

Properties

Context

Gets the InputContext object that was removed. This reference can be used to inspect the context's configuration after the fact; the object itself is not destroyed by the pop operation.

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

ContextID

Gets the ID of the context that was popped from the stack.

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

StackDepth

Gets the total number of contexts remaining on the stack after the pop. A value of 0 means the context stack is now empty and no context is active.

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

See Also