Class RebindSettings

Default settings applied to every interactive rebinding operation initiated through the Input module. Individual operations may override these defaults programmatically.

Inheritance

object

RebindSettings

Inherited Members

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

[Serializable]
public class RebindSettings

Remarks

A rebind operation waits for the player to press a control and then assigns it to the target action binding. The operation automatically cancels if no valid input is received within the Timeout window, or immediately if the player presses the control specified by DefaultCancelPath.

The mouse position and mouse movement are never captured by a rebind, so moving the mouse toward a prompt does not become the new binding. Unity's interactive rebinding excludes both on every operation, and a binding that expects mouse movement is captured through WithDeltaPolling(bool) instead.

Fields

DefaultCancelPath

Unity Input System control path of the input that immediately cancels an active rebind operation without assigning a new binding. Uses the standard Input System path format, e.g., <Keyboard>/escape. Setting this to an empty string disables cancellation, meaning the player must wait for the timeout. Defaults to "<Keyboard>/escape".

Declaration

[Tooltip("The input control path that cancels an active rebind operation (e.g. '<Keyboard>/escape'). When the player presses this control during rebinding, the operation is cancelled and the original binding is preserved.")]
public string DefaultCancelPath

Field Value

Type	Description
string

MAX_TIMEOUT

Largest accepted Timeout in seconds.

Declaration

public const float MAX_TIMEOUT = 30

Field Value

Type	Description
float

MIN_TIMEOUT

Smallest accepted Timeout in seconds.

Declaration

public const float MIN_TIMEOUT = 1

Field Value

Type	Description
float

Timeout

Maximum number of seconds to wait for player input before the rebind operation is automatically cancelled. Valid range: 1-30 seconds; a JSON override outside that range is clamped into it, so a configured rebind always times out. Defaults to 5. A single operation can still disable its timeout through WithTimeout(float).

Declaration

[Tooltip("The maximum duration in seconds that a rebind operation waits for input before automatically cancelling. A reasonable timeout prevents the UI from appearing frozen if the player walks away during rebinding.")]
[Range(1, 30)]
public float Timeout

Field Value

Type	Description
float