Struct InputActionSetupExtensions.BindingSyntax | Input System | 1.0.2
docs.unity3d.com
    Show / Hide Table of Contents

    Struct InputActionSetupExtensions.BindingSyntax

    Syntax to configure a binding added to an InputAction or an InputActionMap.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Namespace: UnityEngine.InputSystem
    Syntax
    public struct BindingSyntax

    Methods

    Erase()

    Declaration
    public void Erase()

    To(InputBinding)

    Declaration
    public InputActionSetupExtensions.BindingSyntax To(InputBinding binding)
    Parameters
    Type Name Description
    InputBinding binding
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    Triggering(InputAction)

    Declaration
    public InputActionSetupExtensions.BindingSyntax Triggering(InputAction action)
    Parameters
    Type Name Description
    InputAction action
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    WithGroup(String)

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithGroup(string group)
    Parameters
    Type Name Description
    String group
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    WithGroups(String)

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithGroups(string groups)
    Parameters
    Type Name Description
    String groups
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    WithInteraction(String)

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithInteraction(string interaction)
    Parameters
    Type Name Description
    String interaction
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    WithInteraction<TInteraction>()

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithInteraction<TInteraction>()
        where TInteraction : IInputInteraction
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax
    Type Parameters
    Name Description
    TInteraction

    WithInteractions(String)

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithInteractions(string interactions)
    Parameters
    Type Name Description
    String interactions
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    WithName(String)

    Set the name of the binding.

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithName(string name)
    Parameters
    Type Name Description
    String name

    Name for the binding.

    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    The same binding syntax for further configuration.

    See Also
    name
    AddBinding(InputAction, String, String, String, String)

    WithPath(String)

    Set the path of the binding.

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithPath(string path)
    Parameters
    Type Name Description
    String path

    Path for the binding.

    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    The same binding syntax for further configuration.

    See Also
    path

    WithProcessor(String)

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithProcessor(string processor)
    Parameters
    Type Name Description
    String processor
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    WithProcessor<TProcessor>()

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithProcessor<TProcessor>()
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax
    Type Parameters
    Name Description
    TProcessor

    WithProcessors(String)

    Declaration
    public InputActionSetupExtensions.BindingSyntax WithProcessors(string processors)
    Parameters
    Type Name Description
    String processors
    Returns
    Type Description
    InputActionSetupExtensions.BindingSyntax

    See Also

    AddBinding(InputAction, InputBinding)
    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