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

    Class InputControlAttribute

    Mark a data member in a state struct as being an input control.

    Inheritance
    System.Object
    InputControlAttribute
    Namespace: UnityEngine.Experimental.Input.Layouts
    Syntax
    public class InputControlAttribute : Attribute
    Remarks

    The system will scan the state for those and automatically construct InputControl instances from them.

    If applied to a field, set ups an actual instance of InputControl. If applied to a property, modifies the InputControl instances inside the control the property references.

    Fields

    alias

    Declaration
    public string alias
    Field Value
    Type Description
    System.String

    aliases

    Declaration
    public string[] aliases
    Field Value
    Type Description
    System.String[]

    arraySize

    Declaration
    public int arraySize
    Field Value
    Type Description
    System.Int32

    bit

    Declaration
    public uint bit
    Field Value
    Type Description
    System.UInt32

    defaultState

    Declaration
    public object defaultState
    Field Value
    Type Description
    System.Object

    displayName

    Declaration
    public string displayName
    Field Value
    Type Description
    System.String

    format

    Declaration
    public string format
    Field Value
    Type Description
    System.String

    layout

    Declaration
    public string layout
    Field Value
    Type Description
    System.String

    maxValue

    Declaration
    public object maxValue
    Field Value
    Type Description
    System.Object

    minValue

    Declaration
    public object minValue
    Field Value
    Type Description
    System.Object

    name

    Declaration
    public string name
    Field Value
    Type Description
    System.String

    noisy

    Declaration
    public bool noisy
    Field Value
    Type Description
    System.Boolean

    offset

    Declaration
    public uint offset
    Field Value
    Type Description
    System.UInt32

    parameters

    Declaration
    public string parameters
    Field Value
    Type Description
    System.String

    processors

    Declaration
    public string processors
    Field Value
    Type Description
    System.String

    shortDisplayName

    Declaration
    public string shortDisplayName
    Field Value
    Type Description
    System.String

    sizeInBits

    Declaration
    public uint sizeInBits
    Field Value
    Type Description
    System.UInt32

    synthetic

    Declaration
    public bool synthetic
    Field Value
    Type Description
    System.Boolean

    usage

    Declaration
    public string usage
    Field Value
    Type Description
    System.String

    usages

    Declaration
    public string[] usages
    Field Value
    Type Description
    System.String[]

    useStateFrom

    Declaration
    public string useStateFrom
    Field Value
    Type Description
    System.String

    variants

    Declaration
    public string variants
    Field Value
    Type Description
    System.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