Package nz.ac.vuw.ecs.swen225.gp6.domain.Utility

Enum Class Direction

java.lang.Object
java.lang.Enum<Direction>
nz.ac.vuw.ecs.swen225.gp6.domain.Utility.Direction
All Implemented Interfaces:
Serializable, Comparable<Direction>, Constable
public enum Direction extends Enum<Direction>
Direction enum class that stores all possible moving directions for actors in this game.

  • Enum Constant Details

  • Field Details

    • x

      public final int x

    • y

      public final int y

    • symbol

      public final char symbol

  • 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

    • getDirFromSymbol

      public static Direction getDirFromSymbol(char symbol)
      gets a direction by a given symbol.
      Parameters:
      symbol - symbol to get direction equivalent of
      Returns:
      direction equivalent of given symbol
      Throws:
      IllegalArgumentException - when given symbol is invalid

    • transformLoc

      public Loc transformLoc(Loc l)
      transforms a given location with this direction.
      Parameters:
      l - loc to transform