Class InputControlLayoutAttribute

Attribute to control layout settings of a type used to generate an InputControlLayout.

Inheritance

System.Object

System.Attribute

InputControlLayoutAttribute

Namespace: UnityEngine.InputSystem.Layouts

Syntax

[AttributeUsage(AttributeTargets.Class, Inherited = false)]
public sealed class InputControlLayoutAttribute : Attribute, _Attribute

Properties

commonUsages

Declaration

public string[] commonUsages { get; set; }

Property Value

Type	Description
System.String[]

description

Declaration

public string description { get; set; }

Property Value

Type	Description
System.String

displayName

Gives a name to display in the UI. By default, the name is the same as the class the attribute is applied to.

Declaration

public string displayName { get; set; }

Property Value

Type	Description
System.String

hideInUI

If true, don't include the layout when presenting picking options in the UI.

Declaration

public bool hideInUI { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

This will keep device layouts out of the control picker and will keep control layouts out of action type dropdowns.

isGenericTypeOfDevice

If true, the layout describes a generic class of devices such as "gamepads" or "mice".

Declaration

public bool isGenericTypeOfDevice { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

This property also determines how the layout is presented in the UI. All the device layouts that are marked as generic kinds of devices are displayed with their own entry at the root level of the control picker (), for example.

stateFormat

Declaration

public string stateFormat { get; set; }

Property Value

Type	Description
System.String

stateType

Associates a state representation with an input device and drives the control layout generated for the device from its state rather than from the device class.

Declaration

public Type stateType { get; set; }

Property Value

Type	Description
System.Type

Remarks

This is only useful if you have a state struct dictating a specific state layout and you want the device layout to automatically take offsets from the fields annotated with InputControlAttribute.

updateBeforeRender

Declaration

public bool updateBeforeRender { get; set; }

Property Value

Type	Description
System.Boolean

variants

Declaration

public string variants { get; set; }

Property Value

Type	Description
System.String