Class InputActionRebindingExtensions | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class InputActionRebindingExtensions

    Extensions to help with dynamically rebinding InputAction in various ways.

    Inheritance
    System.Object
    InputActionRebindingExtensions
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: UnityEngine.Experimental.Input
    Syntax
    public static class InputActionRebindingExtensions
    Remarks

    Unlike InputActionSetupExtensions, the extension methods in here are meant to be called during normal game operation.

    The two primary duties of these extensions are to apply binding overrides that non-destructively redirect existing bindings and to facilitate user-controlled rebinding by listening for controls actuated by the user.

    Methods

    ApplyBindingOverride(InputAction, Int32, String)

    Declaration
    public static void ApplyBindingOverride(this InputAction action, int bindingIndex, string path)
    Parameters
    Type Name Description
    InputAction action
    System.Int32 bindingIndex
    System.String path

    ApplyBindingOverride(InputAction, Int32, InputBinding)

    Declaration
    public static void ApplyBindingOverride(this InputAction action, int bindingIndex, InputBinding bindingOverride)
    Parameters
    Type Name Description
    InputAction action
    System.Int32 bindingIndex
    InputBinding bindingOverride

    ApplyBindingOverride(InputAction, String, String, String)

    Declaration
    public static void ApplyBindingOverride(this InputAction action, string newPath, string group = null, string path = null)
    Parameters
    Type Name Description
    InputAction action
    System.String newPath
    System.String group
    System.String path

    ApplyBindingOverride(InputAction, InputBinding)

    Declaration
    public static void ApplyBindingOverride(this InputAction action, InputBinding bindingOverride)
    Parameters
    Type Name Description
    InputAction action
    InputBinding bindingOverride
    Remarks

    Binding overrides are non-destructive. They do not change the bindings set up for an action but rather apply non-destructive modifications that change the paths of existing bindings. However, this also means that for overrides to work, there have to be existing bindings that can be modified.

    ApplyBindingOverride(InputActionMap, Int32, InputBinding)

    Declaration
    public static void ApplyBindingOverride(this InputActionMap actionMap, int bindingIndex, InputBinding bindingOverride)
    Parameters
    Type Name Description
    InputActionMap actionMap
    System.Int32 bindingIndex
    InputBinding bindingOverride

    ApplyBindingOverride(InputActionMap, InputBinding)

    Apply the given binding override to all bindings in the map that are matched by the override.

    Declaration
    public static int ApplyBindingOverride(this InputActionMap actionMap, InputBinding bindingOverride)
    Parameters
    Type Name Description
    InputActionMap actionMap
    InputBinding bindingOverride
    Returns
    Type Description
    System.Int32

    The number of bindings overridden in the given map.

    ApplyBindingOverrides(InputActionMap, IEnumerable<InputBinding>)

    Declaration
    public static void ApplyBindingOverrides(this InputActionMap actionMap, IEnumerable<InputBinding> overrides)
    Parameters
    Type Name Description
    InputActionMap actionMap
    IEnumerable<InputBinding> overrides

    ApplyBindingOverridesOnMatchingControls(InputAction, InputControl)

    Declaration
    public static int ApplyBindingOverridesOnMatchingControls(this InputAction action, InputControl control)
    Parameters
    Type Name Description
    InputAction action
    InputControl control
    Returns
    Type Description
    System.Int32

    ApplyBindingOverridesOnMatchingControls(InputActionMap, InputControl)

    Declaration
    public static int ApplyBindingOverridesOnMatchingControls(this InputActionMap actionMap, InputControl control)
    Parameters
    Type Name Description
    InputActionMap actionMap
    InputControl control
    Returns
    Type Description
    System.Int32

    GetBindingOverrides(InputAction)

    Declaration
    public static IEnumerable<InputBinding> GetBindingOverrides(this InputAction action)
    Parameters
    Type Name Description
    InputAction action
    Returns
    Type Description
    IEnumerable<InputBinding>

    GetBindingOverrides(InputAction, List<InputBinding>)

    Declaration
    public static int GetBindingOverrides(this InputAction action, List<InputBinding> overrides)
    Parameters
    Type Name Description
    InputAction action
    List<InputBinding> overrides
    Returns
    Type Description
    System.Int32

    GetBindingOverrides(InputActionMap)

    Get all overrides applied to bindings in the given map.

    Declaration
    public static IEnumerable<InputBinding> GetBindingOverrides(this InputActionMap actionMap)
    Parameters
    Type Name Description
    InputActionMap actionMap
    Returns
    Type Description
    IEnumerable<InputBinding>

    GetBindingOverrides(InputActionMap, List<InputBinding>)

    Declaration
    public static int GetBindingOverrides(this InputActionMap actionMap, List<InputBinding> overrides)
    Parameters
    Type Name Description
    InputActionMap actionMap
    List<InputBinding> overrides
    Returns
    Type Description
    System.Int32

    PerformInteractiveRebinding(InputAction)

    Initiate an operation that interactively rebinds the given action based on received input.

    Declaration
    public static InputActionRebindingExtensions.RebindingOperation PerformInteractiveRebinding(this InputAction action)
    Parameters
    Type Name Description
    InputAction action

    Action to perform rebinding on.

    Returns
    Type Description
    InputActionRebindingExtensions.RebindingOperation

    RemoveAllBindingOverrides(InputAction)

    Declaration
    public static void RemoveAllBindingOverrides(this InputAction action)
    Parameters
    Type Name Description
    InputAction action

    RemoveAllBindingOverrides(InputActionMap)

    Restore all bindings in the map to their defaults.

    Declaration
    public static void RemoveAllBindingOverrides(this InputActionMap actionMap)
    Parameters
    Type Name Description
    InputActionMap actionMap

    Action map to remove overrides from. Must not have enabled actions.

    RemoveBindingOverride(InputAction, InputBinding)

    Declaration
    public static void RemoveBindingOverride(this InputAction action, InputBinding bindingOverride)
    Parameters
    Type Name Description
    InputAction action
    InputBinding bindingOverride

    RemoveBindingOverrides(InputActionMap, IEnumerable<InputBinding>)

    Declaration
    public static void RemoveBindingOverrides(this InputActionMap actionMap, IEnumerable<InputBinding> overrides)
    Parameters
    Type Name Description
    InputActionMap actionMap
    IEnumerable<InputBinding> overrides
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023