Enum Class Gamepad.Button

java.lang.Object

java.lang.Enum<Gamepad.Button>

org.wpilib.driverstation.Gamepad.Button

All Implemented Interfaces:

Serializable, Comparable<Gamepad.Button>, Constable

Enclosing class:

Gamepad

public static enum Gamepad.Button
extends Enum<Gamepad.Button>

Represents a digital button on a Gamepad.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
kBack	Back button.
kDpadDown	D-pad down button.
kDpadLeft	D-pad left button.
kDpadRight	D-pad right button.
kDpadUp	D-pad up button.
kEastFace	East Face button.
kGuide	Guide button.
kLeftBumper	Left bumper button.
kLeftPaddle1	Left Paddle 1 button.
kLeftPaddle2	Left Paddle 2 button.
kLeftStick	Left stick button.
kMisc1	Miscellaneous 1 button.
kMisc2	Miscellaneous 2 button.
kMisc3	Miscellaneous 3 button.
kMisc4	Miscellaneous 4 button.
kMisc5	Miscellaneous 5 button.
kMisc6	Miscellaneous 6 button.
kNorthFace	North Face button.
kRightBumper	Right bumper button.
kRightPaddle1	Right Paddle 1 button.
kRightPaddle2	Right Paddle 2 button.
kRightStick	Right stick button.
kSouthFace	South Face button.
kStart	Start button.
kTouchpad	Touchpad button.
kWestFace	West Face button.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	Button value.

Method Summary

Modifier and Type	Method	Description
String	toString()	Get the human-friendly name of the button, matching the relevant methods.
static Gamepad.Button	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Gamepad.Button[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kSouthFace

public static final Gamepad.Button kSouthFace

South Face button.

kEastFace

public static final Gamepad.Button kEastFace

East Face button.

kWestFace

public static final Gamepad.Button kWestFace

West Face button.

kNorthFace

public static final Gamepad.Button kNorthFace

North Face button.

kBack

public static final Gamepad.Button kBack

Back button.

kGuide

public static final Gamepad.Button kGuide

Guide button.

kStart

public static final Gamepad.Button kStart

Start button.

kLeftStick

public static final Gamepad.Button kLeftStick

Left stick button.

kRightStick

public static final Gamepad.Button kRightStick

Right stick button.

kLeftBumper

public static final Gamepad.Button kLeftBumper

Left bumper button.

kRightBumper

public static final Gamepad.Button kRightBumper

Right bumper button.

kDpadUp

public static final Gamepad.Button kDpadUp

D-pad up button.

kDpadDown

public static final Gamepad.Button kDpadDown

D-pad down button.

kDpadLeft

public static final Gamepad.Button kDpadLeft

D-pad left button.

kDpadRight

public static final Gamepad.Button kDpadRight

D-pad right button.

kMisc1

public static final Gamepad.Button kMisc1

Miscellaneous 1 button.

kRightPaddle1

public static final Gamepad.Button kRightPaddle1

Right Paddle 1 button.

kLeftPaddle1

public static final Gamepad.Button kLeftPaddle1

Left Paddle 1 button.

kRightPaddle2

public static final Gamepad.Button kRightPaddle2

Right Paddle 2 button.

kLeftPaddle2

public static final Gamepad.Button kLeftPaddle2

Left Paddle 2 button.

kTouchpad

public static final Gamepad.Button kTouchpad

Touchpad button.

kMisc2

public static final Gamepad.Button kMisc2

Miscellaneous 2 button.

kMisc3

public static final Gamepad.Button kMisc3

Miscellaneous 3 button.

kMisc4

public static final Gamepad.Button kMisc4

Miscellaneous 4 button.

kMisc5

public static final Gamepad.Button kMisc5

Miscellaneous 5 button.

kMisc6

public static final Gamepad.Button kMisc6

Miscellaneous 6 button.

Field Details

value

public final int value

Button value.

Method Details

values

public static Gamepad.Button[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Gamepad.Button valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Get the human-friendly name of the button, matching the relevant methods. This is done by stripping the leading `k`, and appending `Button`.

Primarily used for automated unit tests.

Overrides:

toString in class Enum<Gamepad.Button>

Returns:

the human-friendly name of the button.