Robot Core Documentation
Loading...
Searching...
No Matches
edu.wpi.first.wpilibj2.command.InstantCommand Class Reference
Inheritance diagram for edu.wpi.first.wpilibj2.command.InstantCommand:
edu.wpi.first.wpilibj2.command.FunctionalCommand edu.wpi.first.wpilibj2.command.Command edu.wpi.first.util.sendable.Sendable edu.wpi.first.wpilibj2.command.PrintCommand

Public Member Functions

 InstantCommand (Runnable toRun, Subsystem... requirements)
 
 InstantCommand ()
 
- Public Member Functions inherited from edu.wpi.first.wpilibj2.command.FunctionalCommand
 FunctionalCommand (Runnable onInit, Runnable onExecute, Consumer< Boolean > onEnd, BooleanSupplier isFinished, Subsystem... requirements)
 
void initialize ()
 
void execute ()
 
void end (boolean interrupted)
 
boolean isFinished ()
 
- Public Member Functions inherited from edu.wpi.first.wpilibj2.command.Command
Set< SubsystemgetRequirements ()
 
final void addRequirements (Subsystem... requirements)
 
String getName ()
 
void setName (String name)
 
String getSubsystem ()
 
void setSubsystem (String subsystem)
 
ParallelRaceGroup withTimeout (double seconds)
 
ParallelRaceGroup until (BooleanSupplier condition)
 
ParallelRaceGroup onlyWhile (BooleanSupplier condition)
 
SequentialCommandGroup beforeStarting (Runnable toRun, Subsystem... requirements)
 
SequentialCommandGroup beforeStarting (Command before)
 
SequentialCommandGroup andThen (Runnable toRun, Subsystem... requirements)
 
SequentialCommandGroup andThen (Command... next)
 
ParallelDeadlineGroup deadlineWith (Command... parallel)
 
ParallelCommandGroup alongWith (Command... parallel)
 
ParallelRaceGroup raceWith (Command... parallel)
 
RepeatCommand repeatedly ()
 
ProxyCommand asProxy ()
 
ConditionalCommand unless (BooleanSupplier condition)
 
ConditionalCommand onlyIf (BooleanSupplier condition)
 
WrapperCommand ignoringDisable (boolean doesRunWhenDisabled)
 
WrapperCommand withInterruptBehavior (InterruptionBehavior interruptBehavior)
 
WrapperCommand finallyDo (BooleanConsumer end)
 
WrapperCommand finallyDo (Runnable end)
 
WrapperCommand handleInterrupt (Runnable handler)
 
void schedule ()
 
void cancel ()
 
boolean isScheduled ()
 
boolean hasRequirement (Subsystem requirement)
 
InterruptionBehavior getInterruptionBehavior ()
 
boolean runsWhenDisabled ()
 
WrapperCommand withName (String name)
 
void initSendable (SendableBuilder builder)
 
- Public Member Functions inherited from edu.wpi.first.util.sendable.Sendable

Additional Inherited Members

- Protected Member Functions inherited from edu.wpi.first.wpilibj2.command.Command
 Command ()
 
- Protected Attributes inherited from edu.wpi.first.wpilibj2.command.Command
Set< Subsystemm_requirements = new HashSet<>()
 

Detailed Description

A Command that runs instantly; it will initialize, execute once, and end on the same iteration of the scheduler. Users can either pass in a Runnable and a set of requirements, or else subclass this command if desired.

This class is provided by the NewCommands VendorDep

Constructor & Destructor Documentation

◆ InstantCommand() [1/2]

edu.wpi.first.wpilibj2.command.InstantCommand.InstantCommand ( Runnable toRun,
Subsystem... requirements )

Creates a new InstantCommand that runs the given Runnable with the given requirements.

Parameters
toRunthe Runnable to run
requirementsthe subsystems required by this command

◆ InstantCommand() [2/2]

edu.wpi.first.wpilibj2.command.InstantCommand.InstantCommand ( )

Creates a new InstantCommand with a Runnable that does nothing. Useful only as a no-arg constructor to call implicitly from subclass constructors.


The documentation for this class was generated from the following file: