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

Class InternalButton

java.lang.Object

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

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

edu.wpi.first.wpilibj2.command.button.InternalButton

All Implemented Interfaces:

BooleanSupplier

public class InternalButton
extends Button

This class is intended to be used within a program. The programmer can manually set its value. Also includes a setting for whether or not it should invert its value.

Constructor Summary

Constructors

Constructor	Description
InternalButton()	Creates an InternalButton that is not inverted.
InternalButton(boolean inverted)	Creates an InternalButton which is inverted depending on the input.

Method Summary

Modifier and Type	Method	Description
boolean	get()	Returns whether or not the trigger is active.
void	setInverted(boolean inverted)
void	setPressed(boolean pressed)

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

InternalButton

public InternalButton()

Creates an InternalButton that is not inverted.

InternalButton

public InternalButton(boolean inverted)

Creates an InternalButton which is inverted depending on the input.

Parameters:

inverted - if false, then this button is pressed when set to true, otherwise it is pressed when set to false.

Method Details

setInverted

public void setInverted(boolean inverted)

setPressed

public void setPressed(boolean pressed)

get

public boolean get()

Description copied from class: Trigger

Returns whether or not the trigger is active.

This method will be called repeatedly a command is linked to the Trigger.

Functionally identical to Trigger.getAsBoolean().

Overrides:

get in class Trigger

Returns:

whether or not the trigger condition is active.