Enum Class Direction

java.lang.Object
java.lang.Enum<Direction>
com.botwithus.bot.api.snapshot.Direction
All Implemented Interfaces:
Serializable, Comparable<Direction>, Constable
public enum Direction extends Enum<Direction>
The eight compass points, in clockwise order starting at north.

The declaration order is load-bearing: Orientation.compass() indexes values() by 45-degree sector, so reordering these constants changes what every script reads.

  • Enum Constant Details

    • NORTH

      public static final Direction NORTH

    • NORTH_EAST

      public static final Direction NORTH_EAST

    • EAST

      public static final Direction EAST

    • SOUTH_EAST

      public static final Direction SOUTH_EAST

    • SOUTH

      public static final Direction SOUTH

    • SOUTH_WEST

      public static final Direction SOUTH_WEST

    • WEST

      public static final Direction WEST

    • NORTH_WEST

      public static final Direction NORTH_WEST

  • Method Details

    • values

      public static Direction[] 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 Direction 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

    • degrees

      public double degrees()
      Compass bearing of this point, clockwise from north: 0, 45, ... 315.