docs.unity3d.com
    Show / Hide Table of Contents

    Struct InputActionSetupExtensions.CompositeSyntax

    Namespace: UnityEngine.InputSystem
    Syntax
    public struct CompositeSyntax

    Properties

    bindingIndex

    Index of the binding that the accessor refers to.

    Declaration
    public int bindingIndex { get; }
    Property Value
    Type Description
    Int32
    Remarks

    When accessing bindings on an InputAction, this is the index in bindings of the action. When accessing bindings on an InputActionMap, it is the index bindings of the map.

    Methods

    With(String, String, String, String)

    Add a part binding to the composite.

    Declaration
    public InputActionSetupExtensions.CompositeSyntax With(string name, string binding, string groups = null, string processors = null)
    Parameters
    Type Name Description
    String name

    Name of the part. This is dependent on the type of composite. For Vector2Composite, for example, the valid parts are "Up", "Down", "Left", and "Right".

    String binding

    Control path to binding to. See path.

    String groups

    Binding groups to assign to the part binding. See groups.

    String processors

    Optional list of processors to apply to the binding. See processors.

    Returns
    Type Description
    InputActionSetupExtensions.CompositeSyntax

    The same composite syntax for further configuration.

    In This Article
    • Properties
      • bindingIndex
    • Methods
      • With(String, String, String, String)
    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