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

Class Button

java.lang.Object

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

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

All Implemented Interfaces:

BooleanSupplier

Direct Known Subclasses:

InternalButton, JoystickButton, NetworkButton, POVButton

@Deprecated
public class Button
extends Trigger

Deprecated.

Replace with Trigger.

This class provides an easy way to link commands to OI inputs.

It is very easy to link a button to a command. For instance, you could link the trigger button of a joystick to a "score" command.

This class represents a subclass of Trigger that is specifically aimed at buttons on an operator interface as a common use case of the more generalized Trigger objects. This is a simple wrapper around Trigger with the method names renamed to fit the Button object use.

Constructor Summary

Constructors

Constructor	Description
Button()	Deprecated. Replace with new Button(() -> false) .
Button(BooleanSupplier isPressed)	Deprecated. Replace with Trigger.

Method Summary

Modifier and Type	Method	Description
Button	cancelWhenPressed(Command command)	Deprecated. Instead, pass this as an end condition to Command.until(BooleanSupplier).
Button	toggleWhenPressed(Command command)	Deprecated. Replace with Trigger.toggleOnTrue(Command)
Button	whenHeld(Command command)	Deprecated. Replace with Trigger.whileTrue(Command)
Button	whenPressed(Command command)	Deprecated. Replace with Trigger.onTrue(Command)
Button	whenPressed(Runnable toRun, Subsystem... requirements)	Deprecated. Replace with Trigger.onTrue(Command), creating the InstantCommand manually
Button	whenReleased(Command command)	Deprecated. Replace with Trigger.onFalse(Command)
Button	whenReleased(Runnable toRun, Subsystem... requirements)	Deprecated. Replace with Trigger.onFalse(Command), creating the InstantCommand manually
Button	whileHeld(Command command)	Deprecated. Use Trigger.whileTrue(Command) with RepeatCommand.
Button	whileHeld(Runnable toRun, Subsystem... requirements)	Deprecated. Use Trigger.whileTrue(Command) and construct a RunCommand manually

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

and, cancelWhenActive, debounce, debounce, getAsBoolean, negate, onFalse, onTrue, or, toggleOnFalse, toggleOnTrue, toggleWhenActive, whenActive, whenActive, whenInactive, whenInactive, whileActiveContinuous, whileActiveContinuous, whileActiveOnce, whileFalse, whileTrue

Methods inherited from class java.lang.Object

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

Constructor Details

Button

@Deprecated(since="2023") public Button()

Deprecated.

Replace with new Button(() -> false) .

Default constructor; creates a button that is never pressed.

Button

@Deprecated public Button(BooleanSupplier isPressed)

Deprecated.

Replace with Trigger.

Creates a new button with the given condition determining whether it is pressed.

Parameters:

isPressed - returns whether the trigger should be active

Method Details

whenPressed

@Deprecated public Button whenPressed(Command command)

Deprecated.

Replace with Trigger.onTrue(Command)

Starts the given command whenever the button is newly pressed.

Parameters:

command - the command to start

Returns:

this button, so calls can be chained

whenPressed

@Deprecated public Button whenPressed(Runnable toRun, Subsystem... requirements)

Deprecated.

Replace with Trigger.onTrue(Command), creating the InstantCommand manually

Runs the given runnable whenever the button is newly pressed.

Parameters:

toRun - the runnable to run

requirements - the required subsystems

Returns:

this button, so calls can be chained

whileHeld

@Deprecated public Button whileHeld(Command command)

Deprecated.

Use Trigger.whileTrue(Command) with RepeatCommand.

Constantly starts the given command while the button is held.

Command.schedule() will be called repeatedly while the button is held, and will be canceled when the button is released.

Parameters:

command - the command to start

Returns:

this button, so calls can be chained

whileHeld

@Deprecated public Button whileHeld(Runnable toRun, Subsystem... requirements)

Deprecated.

Use Trigger.whileTrue(Command) and construct a RunCommand manually

Constantly runs the given runnable while the button is held.

Parameters:

toRun - the runnable to run

requirements - the required subsystems

Returns:

this button, so calls can be chained

whenHeld

@Deprecated public Button whenHeld(Command command)

Deprecated.

Replace with Trigger.whileTrue(Command)

Starts the given command when the button is first pressed, and cancels it when it is released, but does not start it again if it ends or is otherwise interrupted.

Parameters:

command - the command to start

Returns:

this button, so calls can be chained

whenReleased

@Deprecated public Button whenReleased(Command command)

Deprecated.

Replace with Trigger.onFalse(Command)

Starts the command when the button is released. The command is set to be interruptible.

Parameters:

command - the command to start

Returns:

this button, so calls can be chained

whenReleased

@Deprecated public Button whenReleased(Runnable toRun, Subsystem... requirements)

Deprecated.

Replace with Trigger.onFalse(Command), creating the InstantCommand manually

Runs the given runnable when the button is released.

Parameters:

toRun - the runnable to run

requirements - the required subsystems

Returns:

this button, so calls can be chained

toggleWhenPressed

@Deprecated public Button toggleWhenPressed(Command command)

Deprecated.

Replace with Trigger.toggleOnTrue(Command)

Toggles the command whenever the button is pressed (on, then off, then on). The command is set to be interruptible.

Parameters:

command - the command to start

Returns:

this button, so calls can be chained

cancelWhenPressed

@Deprecated public Button cancelWhenPressed(Command command)

Deprecated.

Instead, pass this as an end condition to Command.until(BooleanSupplier).

Cancels the command when the button is pressed.

Parameters:

command - the command to start

Returns:

this button, so calls can be chained