Class InputRebindCompletedEvent

Published via the Scylla Event eXchange System (SEX) when an interactive rebind operation finishes and a new input has been successfully assigned to the binding.

Inheritance

object

ScyllaEvent

InputRebindCompletedEvent

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 InputRebindCompletedEvent : ScyllaEvent

Remarks

Check Success to confirm whether a valid new binding was recorded. Even when published from a successful rebind session Success can in rare cases be false if the new input was rejected (e.g., excluded paths). After this event the hint cache is automatically invalidated so that subsequent calls to IInputHintsManager.GetHint(string) will reflect the updated binding.

Subscribe via ScyllaEvents.Listen<InputRebindCompletedEvent>.

Properties

ActionID

Gets or sets the string identifier of the action that was rebound.

Declaration

public string ActionID { get; set; }

Property Value

Type	Description
string

BindingIndex

Gets or sets the zero-based index of the binding that was modified.

Declaration

public int BindingIndex { get; set; }

Property Value

Type	Description
int

MapID

Gets or sets the action map declaring the action, which with the name identifies it. An action name is only unique inside its map.

Declaration

public string MapID { get; set; }

Property Value

Type	Description
string

NewPath

Gets or sets the binding path that was assigned by the rebind operation, for example "<Keyboard>/e". Will be null or empty when Success is false.

Declaration

public string NewPath { get; set; }

Property Value

Type	Description
string

OldPath

Gets or sets the binding path that was in effect before the rebind operation, for example "<Keyboard>/space". Use this to implement an undo workflow or to log the change.

Declaration

public string OldPath { get; set; }

Property Value

Type	Description
string

Success

Gets or sets whether the rebind operation captured a valid new binding and applied it successfully. When false the binding path is unchanged even though this event was published.

Declaration

public bool Success { get; set; }

Property Value

Type	Description
bool

See Also

InputRebindStartedEvent

InputRebindCancelledEvent