RepoMirrors
/
baritone
mirror of https://github.com/cabaletta/baritone
1
0
Fork 1
Code Issues Releases Wiki Activity

More javadocs

This commit is contained in:
Brady 2018-11-05 18:11:16 -06:00
parent 472e89239c
commit fdee1b9453
No known key found for this signature in database
GPG Key ID: 73A788379A197567
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/api/java/baritone/api/process/PathingCommand.java
View File

@ -20,7 +20,9 @@ package baritone.api.process;
import baritone.api.pathing.goals.Goal;
public class PathingCommand {
public final Goal goal;
public final PathingCommandType commandType;
public PathingCommand(Goal goal, PathingCommandType commandType) {

14
src/api/java/baritone/api/process/PathingCommandType.java
View File

@ -17,11 +17,14 @@
package baritone.api.process;
import baritone.api.Settings;
public enum PathingCommandType {
/**
* Set the goal and path.
* <p>
* If you use this alongside a null goal, it will continue along its current path and current goal.
* If you use this alongside a {@code null} goal, it will continue along its current path and current goal.
*/
SET_GOAL_AND_PATH,
@ -31,21 +34,22 @@ public enum PathingCommandType {
REQUEST_PAUSE,
/**
* Set the goal (regardless of null), and request a cancel of the current path (when safe)
* Set the goal (regardless of {@code null}), and request a cancel of the current path (when safe)
*/
CANCEL_AND_SET_GOAL,
/**
* Set the goal and path.
* <p>
* If cancelOnGoalInvalidation is true, revalidate the current goal, and cancel if it's no longer valid, or if the new goal is null.
* If {@link Settings#cancelOnGoalInvalidation} is {@code true}, revalidate the
* current goal, and cancel if it's no longer valid, or if the new goal is {@code null}.
*/
REVALIDATE_GOAL_AND_PATH,
/**
* Set the goal and path.
* <p>
* Revalidate the current goal, and cancel if it's no longer valid, or if the new goal is null.
* Revalidate the current goal, and cancel if it's no longer valid, or if the new goal is {@code null}.
*/
FORCE_REVALIDATE_GOAL_AND_PATH,
FORCE_REVALIDATE_GOAL_AND_PATH
}