Class InputIconSetChangedEvent

Published via the Scylla Event eXchange System (SEX) when the active icon set for a particular control scheme changes, typically in response to a ControlSchemeChangedEvent or an explicit call to SetActiveIconSet(string).

Inheritance

object

ScyllaEvent

InputIconSetChangedEvent

Inherited Members

ScyllaEvent.IsCancelled

ScyllaEvent.StopPropagation()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.Input

Assembly: ScyllaInput.dll

Syntax

public class InputIconSetChangedEvent : ScyllaEvent

Remarks

When this event fires all hint display UI should be refreshed because the icon sprites associated with every action may have changed. The hint cache is automatically invalidated by InputHintsManager before this event is published, so fresh calls to GetHint(string) will return correctly updated hints.

Subscribe via ScyllaEvents.Listen<InputIconSetChangedEvent>. Alternatively, subscribe to OnIconSetChanged for a lightweight non-SEX callback.

Properties

CurrentIconSetID

Gets or sets the ID of the icon set that is now active for the scheme identified by SchemeType.

Declaration

public string CurrentIconSetID { get; set; }

Property Value

Type	Description
string

PreviousIconSetID

Gets or sets the ID of the icon set that was active before the change, or null if no icon set was configured for the relevant scheme.

Declaration

public string PreviousIconSetID { get; set; }

Property Value

Type	Description
string

SchemeType

Gets or sets the ControlSchemeType that this icon set change applies to, indicating which input family's prompt visuals are affected.

Declaration

public ControlSchemeType SchemeType { get; set; }

Property Value

Type	Description
ControlSchemeType

See Also

InputHintChangedEvent

InputIconSet

IInputHintsManager