Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-21 01:01:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[commands] Disambiguate ProxyCommand and DeferredCommand (#6324)

Browse Source
This commit is contained in:
DeltaDizzy
2024-04-28 00:41:04 -05:00
committed by GitHub
parent 39d33bfca6
commit 1e4a647918
8 changed files with 69 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
wpilibNewCommands/src/main/native/include/frc2/command/DeferredCommand.h
View File

@@ -16,7 +16,7 @@
namespace frc2 {
/**
* Defers Command construction to runtime. Runs the command returned by the
* Defers Command construction to runtime. Runs the command returned by a
* supplier when this command is initialized, and ends when it ends. Useful for
* performing runtime tasks before creating a new command. If this command is
* interrupted, it will cancel the command.
@@ -29,9 +29,10 @@ namespace frc2 {
class DeferredCommand : public CommandHelper<Command, DeferredCommand> {
public:
/**
* Creates a new DeferredCommand that runs the supplied command when
* initialized, and ends when it ends. Useful for lazily
* creating commands at runtime. The supplier will be called each time this
* Creates a new DeferredCommand that directly runs the supplied command when
* initialized, and ends when it ends. Useful for lazily creating commands
* when the DeferredCommand is initialized, such as if the supplied command
* depends on runtime state. The supplier will be called each time this
* command is initialized. The supplier <i>must</i> create a new Command each
* call.
*