Struct GamepadState
Default state layout for gamepads.
Namespace: UnityEngine.InputSystem.LowLevel
Syntax
public struct GamepadState : IInputStateTypeInfo
Remarks
Be aware that unlike some other devices such as Mouse or Touchscreen, gamepad devices tend to have wildly varying state formats, i.e. forms in which they internally store their input data. In practice, even on the same platform gamepads will often store their data in different formats. This means that GamepadState will often not be the format in which a particular gamepad (such as XInputController, for example) stores its data.
Constructors
GamepadState(GamepadButton[])
Create a gamepad state with the given buttons being pressed.
Declaration
public GamepadState(params GamepadButton[] buttons)
Parameters
Type | Name | Description |
---|---|---|
GamepadButton[] | buttons | Buttons to put into pressed state. |
Fields
buttons
Button bit mask.
Declaration
public uint buttons
Field Value
Type | Description |
---|---|
UInt32 | Button bit mask. |
See Also
leftStick
Left stick position. Each axis goes from -1 to 1 with 0 being center position.
Declaration
public Vector2 leftStick
Field Value
Type | Description |
---|---|
Vector2 | Left stick position. |
See Also
leftTrigger
Position of the left trigger. Goes from 0 (not pressed) to 1 (fully pressed).
Declaration
public float leftTrigger
Field Value
Type | Description |
---|---|
Single | Position of left trigger. |
See Also
rightStick
Right stick position. Each axis from -1 to 1 with 0 being center position.
Declaration
public Vector2 rightStick
Field Value
Type | Description |
---|---|
Vector2 | Right stick position. |
See Also
rightTrigger
Position of the right trigger. Goes from 0 (not pressed) to 1 (fully pressed).
Declaration
public float rightTrigger
Field Value
Type | Description |
---|---|
Single | Position of right trigger. |
See Also
Properties
format
State format tag for GamepadState.
Declaration
public readonly FourCC format { get; }
Property Value
Type | Description |
---|---|
FourCC | Returns "GPAD". |
Implements
Format
Declaration
public static readonly FourCC Format { get; }
Property Value
Type | Description |
---|---|
FourCC |
Methods
WithButton(GamepadButton, Boolean)
Set the specific buttons to be pressed or unpressed.
Declaration
public GamepadState WithButton(GamepadButton button, bool value = true)
Parameters
Type | Name | Description |
---|---|---|
GamepadButton | button | A gamepad button. |
Boolean | value | Whether to set |
Returns
Type | Description |
---|---|
GamepadState | GamepadState with a modified buttons mask. |