Class Gamepad

An Xbox-style gamepad with two sticks, a D-Pad, four face buttons, two triggers, two shoulder buttons, and two menu buttons.

Inheritance
System.Object
InputControl
InputDevice
Gamepad
DualShockGamepad
XInputController
Inherited Members
Namespace: UnityEngine.InputSystem
Syntax
public class Gamepad : InputDevice, IDualMotorRumble, IHaptics

Properties

aButton

Same as buttonSouth.

Declaration
public ButtonControl aButton { get; }
Property Value
Type Description
ButtonControl

all

A list of gamepads currently connected to the system.

Declaration
public static ReadOnlyArray<Gamepad> all { get; }
Property Value
Type Description
ReadOnlyArray<Gamepad>
Remarks

Does not cause GC allocation.

Do NOT hold on to the value returned by this getter but rather query it whenever you need it. Whenever the gamepad setup changes, the value returned by this getter is invalidated.

bButton

Same as buttonEast.

Declaration
public ButtonControl bButton { get; }
Property Value
Type Description
ButtonControl

buttonEast

Declaration
public ButtonControl buttonEast { get; }
Property Value
Type Description
ButtonControl

buttonNorth

Declaration
public ButtonControl buttonNorth { get; }
Property Value
Type Description
ButtonControl

buttonSouth

Declaration
public ButtonControl buttonSouth { get; }
Property Value
Type Description
ButtonControl

buttonWest

Declaration
public ButtonControl buttonWest { get; }
Property Value
Type Description
ButtonControl

current

The gamepad last used by the user or null if there is no gamepad connected to the system.

Declaration
public static Gamepad current { get; }
Property Value
Type Description
Gamepad

dpad

Declaration
public DpadControl dpad { get; }
Property Value
Type Description
DpadControl

Item[GamepadButton]

Declaration
public ButtonControl this[GamepadButton button] { get; }
Parameters
Type Name Description
GamepadButton button
Property Value
Type Description
ButtonControl

leftShoulder

Declaration
public ButtonControl leftShoulder { get; }
Property Value
Type Description
ButtonControl

leftStick

Declaration
public StickControl leftStick { get; }
Property Value
Type Description
StickControl

leftStickButton

Declaration
public ButtonControl leftStickButton { get; }
Property Value
Type Description
ButtonControl

leftTrigger

Declaration
public ButtonControl leftTrigger { get; }
Property Value
Type Description
ButtonControl

rightShoulder

Declaration
public ButtonControl rightShoulder { get; }
Property Value
Type Description
ButtonControl

rightStick

Declaration
public StickControl rightStick { get; }
Property Value
Type Description
StickControl

rightStickButton

Declaration
public ButtonControl rightStickButton { get; }
Property Value
Type Description
ButtonControl

rightTrigger

Declaration
public ButtonControl rightTrigger { get; }
Property Value
Type Description
ButtonControl

selectButton

Declaration
public ButtonControl selectButton { get; }
Property Value
Type Description
ButtonControl

startButton

Declaration
public ButtonControl startButton { get; }
Property Value
Type Description
ButtonControl

xButton

Same as buttonWest

Declaration
public ButtonControl xButton { get; }
Property Value
Type Description
ButtonControl

yButton

Same as buttonNorth.

Declaration
public ButtonControl yButton { get; }
Property Value
Type Description
ButtonControl

Methods

FinishSetup(InputDeviceBuilder)

Declaration
protected override void FinishSetup(InputDeviceBuilder builder)
Parameters
Type Name Description
InputDeviceBuilder builder
Overrides

MakeCurrent()

Declaration
public override void MakeCurrent()
Overrides

OnAdded()

Declaration
protected override void OnAdded()
Overrides

OnRemoved()

Declaration
protected override void OnRemoved()
Overrides

PauseHaptics()

Declaration
public virtual void PauseHaptics()
Implements

ResetHaptics()

Declaration
public virtual void ResetHaptics()
Implements

ResumeHaptics()

Declaration
public virtual void ResumeHaptics()
Implements

SetMotorSpeeds(Single, Single)

Declaration
public virtual void SetMotorSpeeds(float lowFrequency, float highFrequency)
Parameters
Type Name Description
System.Single lowFrequency
System.Single highFrequency
Implements

Extension Methods