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.

Mouse axes are excluded by default because players rarely intend to bind actions to continuous positional signals. These exclusions can be disabled if an action specifically targets mouse movement input.

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

ExcludeMouseDelta

When true, mouse delta controls (<Mouse>/delta) are excluded from being assigned during a rebind operation. Prevents players from accidentally binding actions to frame-relative mouse movement rather than discrete buttons. Defaults to true.

Declaration

[Tooltip("When enabled, the mouse delta (movement) control is excluded from being selected as a rebind target. This prevents the mouse movement from being captured during rebinding when only button or key presses are expected.")]
public bool ExcludeMouseDelta

Field Value

Type	Description
bool

ExcludeMousePosition

When true, the mouse position control (<Mouse>/position) is excluded from being assigned during a rebind operation. Prevents players from accidentally binding actions to the absolute screen-space cursor position. Defaults to true.

Declaration

[Tooltip("When enabled, the mouse position control is excluded from being selected as a rebind target. This prevents accidental binding to mouse position, which is rarely a desired rebind result for button-type actions.")]
public bool ExcludeMousePosition

Field Value

Type	Description
bool

Timeout

Maximum number of seconds to wait for player input before the rebind operation is automatically cancelled. Valid range: 1-30 seconds. Defaults to 5.

Declaration

[Tooltip("The maximum duration in seconds that a rebind operation waits for input before automatically cancelling. Set to 0 for no timeout. 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