Package edu.wpi.first.wpilibj

Enum PS5Controller.Button

java.lang.Object

java.lang.Enum<PS5Controller.Button>

edu.wpi.first.wpilibj.PS5Controller.Button

All Implemented Interfaces:

Serializable, Comparable<PS5Controller.Button>, Constable

Enclosing class:

PS5Controller

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

Represents a digital button on a PS5Controller.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
kCircle	Circle button.
kCreate	Create button.
kCross	X button.
kL1	Left trigger 1 button.
kL2	Left trigger 2 button.
kL3	Left stick button.
kOptions	Options button.
kPS	PlayStation button.
kR1	Right trigger 1 button.
kR2	Right trigger 2 button.
kR3	Right stick button.
kSquare	Square button.
kTouchpad	Touchpad click button.
kTriangle	Triangle button.

Field Summary

Fields

Modifier and Type	Field	Description
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 PS5Controller.Button	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PS5Controller.Button[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kSquare

public static final PS5Controller.Button kSquare

Square button.

kCross

public static final PS5Controller.Button kCross

X button.

kCircle

public static final PS5Controller.Button kCircle

Circle button.

kTriangle

public static final PS5Controller.Button kTriangle

Triangle button.

kL1

public static final PS5Controller.Button kL1

Left trigger 1 button.

kR1

public static final PS5Controller.Button kR1

Right trigger 1 button.

kL2

public static final PS5Controller.Button kL2

Left trigger 2 button.

kR2

public static final PS5Controller.Button kR2

Right trigger 2 button.

kCreate

public static final PS5Controller.Button kCreate

Create button.

kOptions

public static final PS5Controller.Button kOptions

Options button.

kL3

public static final PS5Controller.Button kL3

Left stick button.

kR3

public static final PS5Controller.Button kR3

Right stick button.

kPS

public static final PS5Controller.Button kPS

PlayStation button.

kTouchpad

public static final PS5Controller.Button kTouchpad

Touchpad click button.

Field Details

value

public final int value

Button value.

Method Details

values

public static PS5Controller.Button[] values()

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

Returns:

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

valueOf

public static PS5Controller.Button valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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 if not the touchpad append `Button`.

Primarily used for automated unit tests.

Overrides:

toString in class Enum<PS5Controller.Button>

Returns:

the human-friendly name of the button.