Package edu.wpi.first.wpilibj2.command.button

Class JoystickButton

java.lang.Object

edu.wpi.first.wpilibj2.command.button.Trigger

edu.wpi.first.wpilibj2.command.button.Button

edu.wpi.first.wpilibj2.command.button.JoystickButton

All Implemented Interfaces:

BooleanSupplier

public class JoystickButton
extends Button

A Button that gets its state from a GenericHID.

Constructor Summary

Constructors

Constructor	Description
JoystickButton(GenericHID joystick, int buttonNumber)	Creates a joystick button for triggering commands.

Method Summary

Modifier and Type	Method	Description
boolean	get()	Gets the value of the joystick button.

Methods inherited from class edu.wpi.first.wpilibj2.command.button.Button

cancelWhenPressed, toggleWhenPressed, toggleWhenPressed, whenHeld, whenHeld, whenPressed, whenPressed, whenPressed, whenReleased, whenReleased, whenReleased, whileHeld, whileHeld, whileHeld

Methods inherited from class edu.wpi.first.wpilibj2.command.button.Trigger

and, cancelWhenActive, debounce, debounce, getAsBoolean, negate, or, toggleWhenActive, toggleWhenActive, whenActive, whenActive, whenActive, whenInactive, whenInactive, whenInactive, whileActiveContinuous, whileActiveContinuous, whileActiveContinuous, whileActiveOnce, whileActiveOnce

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JoystickButton

public JoystickButton(GenericHID joystick, int buttonNumber)

Creates a joystick button for triggering commands.

Parameters:

joystick - The GenericHID object that has the button (e.g. Joystick, KinectStick, etc)

buttonNumber - The button number (see GenericHID.getRawButton(int)

Method Details

get

public boolean get()

Gets the value of the joystick button.

Overrides:

get in class Trigger

Returns:

The value of the joystick button