Enum Class PathingCommandType

java.lang.Object
java.lang.Enum<PathingCommandType>
com.zenith.feature.pathfinder.PathingCommandType
All Implemented Interfaces:
Serializable, Comparable<PathingCommandType>, Constable

public enum PathingCommandType extends Enum<PathingCommandType>
  • Enum Constant Details

    • SET_GOAL_AND_PATH

      public static final PathingCommandType SET_GOAL_AND_PATH
      Set the goal and path.

      If you use this alongside a null goal, it will continue along its current path and current goal.

    • REQUEST_PAUSE

      public static final PathingCommandType REQUEST_PAUSE
      Has no effect on the current goal or path, just requests a pause
    • CANCEL_AND_SET_GOAL

      public static final PathingCommandType CANCEL_AND_SET_GOAL
      Set the goal (regardless of null), and request a cancel of the current path (when safe)
    • REVALIDATE_GOAL_AND_PATH

      public static final PathingCommandType REVALIDATE_GOAL_AND_PATH
      Set the goal and path.

      revalidate the current goal, and cancel if it's no longer valid, or if the new goal is null.

    • SOFT_REPATH

      public static final PathingCommandType SOFT_REPATH
      Continue on the current path, but set new goal and path to it Useful for potentially long pathing calc times and existing paths might not be bad to continue
    • FORCE_REVALIDATE_GOAL_AND_PATH

      public static final PathingCommandType FORCE_REVALIDATE_GOAL_AND_PATH
      Set the goal and path.

      Cancel the current path if the goals are not equal

    • DEFER

      public static final PathingCommandType DEFER
      Go and ask the next process what to do
    • SET_GOAL_AND_PAUSE

      public static final PathingCommandType SET_GOAL_AND_PAUSE
      Sets the goal and calculates a path, but pauses instead of immediately starting the path.
  • Method Details

    • values

      public static PathingCommandType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PathingCommandType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null