Class InputRebindStartedEvent

Published via the Scylla Event eXchange System (SEX) when an interactive rebind operation begins for a specific binding on a registered action. The game should display UI guidance prompting the player to press the desired new input while this operation is in progress.

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

During an active rebind, input processing for the action being rebound is typically paused by the rebind system to prevent the current input from interfering. Subscribe via ScyllaEvents.Listen<InputRebindStartedEvent>.

Either InputRebindCompletedEvent or InputRebindCancelledEvent will always be published after this event to signal the end of the rebind session.

Properties

ActionID

Gets or sets the string identifier of the action whose binding is being interactively rebound, as registered with IInputActionManager.

Declaration
public string ActionID { get; set; }
Property Value
Type Description
string

BindingIndex

Gets or sets the zero-based index into the action's binding collection that identifies which specific binding (e.g., which composite part) is being modified. Corresponds to InputAction.bindings[BindingIndex].

Declaration
public int BindingIndex { get; set; }
Property Value
Type Description
int

CurrentPath

Gets or sets the binding path string that is currently assigned to the binding before the rebind session completes, for example "<Keyboard>/space". This is the path that will be reverted to if the operation is cancelled.

Declaration
public string CurrentPath { get; set; }
Property Value
Type Description
string

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

See Also