Add Commands.runIf(...) as command factory method to Commands #7808
Conversation
|
This PR modifies commands. Please open a corresponding PR in Python Commands and include a link to this PR. |
github-actions
bot
added
the
component: command-based
| /** | ||
| * Runs a command if the boolean selector function is true. | ||
| * | ||
| * @param selector the selector function |
There was a problem hiding this comment.
Instead of selector I'd refer to this as a condition
There was a problem hiding this comment.
@rzblue With this change should I move the command out of the Selector Commands section of the Commands.java file? If so where should it go instead?
There was a problem hiding this comment.
It can stay in the Selecting section (along with either etc)
| @@ -166,6 +166,18 @@ public static Command either(Command onTrue, Command onFalse, BooleanSupplier se | |||
| return new ConditionalCommand(onTrue, onFalse, selector); | |||
| } | |||
|
|
|||
| /** | |||
| * Runs a command if the boolean condition function is true. | |||
There was a problem hiding this comment.
Make it more obvious in the doc that if the condition is false, the command will do nothing and exit (meaning it will still grab requirements etc) -- you can link to none()
There was a problem hiding this comment.
I edited the code so it should be clear now!
Apologies for the late response!
| @@ -166,6 +166,19 @@ public static Command either(Command onTrue, Command onFalse, BooleanSupplier se | |||
| return new ConditionalCommand(onTrue, onFalse, selector); | |||
| } | |||
|
|
|||
| /** | |||
| * Runs a command if the boolean condition function is true otherwise it does nothing and exits. | |||
There was a problem hiding this comment.
| * Runs a command if the boolean condition function is true otherwise it does nothing and exits. | |
| * Runs a command if the boolean condition function is true. Otherwise it does nothing and exits | |
| * (but still has the same requirements as the command, interrupting any commands with shared | |
| * requirements). |
I could see some people reading "does nothing" as "has no side effects" and being surprised/confused when it interrupts commands with shared requirements. Splitting the sentence is just personal preference that helps me parse it better, but go ahead and structure it how you think is best.
| * @param onTrue the command to run if the condition function returns true | ||
| * @return the command | ||
| * @see ConditionalCommand | ||
| * @see {@link Commands#none()} |
There was a problem hiding this comment.
| * @see {@link Commands#none()} | |
| * @see Commands#none() |
When running the java formatting CI locally, it didn't seem to like using @link in the @see. This has the following javadoc output (you can run ./gradlew wpilibNewCommands:javadoc locally and open wpilibNewCommands/build/docs/javadoc/allclasses-index.html to see the javadoc output):
(This is including the other suggested change)
Intends to close #7807
Adds the equivalent to an if statement for Commands.java.
It runs
Commands.eitherunder the hood withCommands.none()as theonFalseparameter.I haven't coded a C++ or python version for this as I'm not confident enough in my coding ability in those languages.