An Xbox-style gamepad with two switcks, a D-Pad, four face buttons, two triggers,
two shoulder buttons, and two menu buttons.
Inheritance
System.Object
Gamepad
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
public class Gamepad : InputDevice, IDualMotorRumble
Properties
Declaration
public ButtonControl aButton { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
A list of gamepads currently connected to the system.
Declaration
public static ReadOnlyArray<Gamepad> all { get; }
Property Value
| Type |
Description |
| ReadOnlyArray<Gamepad> |
|
Declaration
public ButtonControl bButton { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl buttonEast { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl buttonNorth { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl buttonSouth { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl buttonWest { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
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
Declaration
public DpadControl dpad { get; }
Property Value
| Type |
Description |
| DpadControl |
|
Declaration
public ButtonControl this[GamepadButton button] { get; }
Parameters
| Type |
Name |
Description |
| GamepadButton |
button |
|
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl leftShoulder { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public StickControl leftStick { get; }
Property Value
| Type |
Description |
| StickControl |
|
Declaration
public ButtonControl leftStickButton { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl leftTrigger { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl rightShoulder { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public StickControl rightStick { get; }
Property Value
| Type |
Description |
| StickControl |
|
Declaration
public ButtonControl rightStickButton { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl rightTrigger { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl selectButton { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl startButton { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl xButton { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Declaration
public ButtonControl yButton { get; }
Property Value
| Type |
Description |
| ButtonControl |
|
Methods
Declaration
protected override void FinishSetup(InputDeviceBuilder builder)
Parameters
| Type |
Name |
Description |
| InputDeviceBuilder |
builder |
|
Overrides
Declaration
public override void MakeCurrent()
Overrides
Declaration
protected override void OnAdded()
Overrides
Declaration
protected override void OnRemoved()
Overrides
Declaration
public virtual void PauseHaptics()
Declaration
public virtual void ResetHaptics()
Declaration
public virtual void ResumeHaptics()
Declaration
public virtual void SetMotorSpeeds(float lowFrequency, float highFrequency)
Parameters
| Type |
Name |
Description |
| System.Single |
lowFrequency |
|
| System.Single |
highFrequency |
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.