Enum Class ActionDirection

java.lang.Object
java.lang.Enum<ActionDirection>
com.soulfiremc.server.pathfinding.graph.actions.movement.ActionDirection
All Implemented Interfaces:
Serializable, Comparable<ActionDirection>, Constable

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

  • Field Details

  • Method Details

    • values

      public static ActionDirection[] 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 ActionDirection 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
    • isOpposite

      public abstract boolean isOpposite(ActionDirection direction)
      Checks if the given direction is the opposite of this direction. This also includes that the opposite of UP is DOWN and vice versa. It also includes diagonals, so NORTH_EAST is the opposite of SOUTH_WEST, but also the opposite of SOUTH and WEST.
      Parameters:
      direction - The direction to check
      Returns:
      If the given direction is the opposite of this direction