Enum Class AxisDirection

java.lang.Object
java.lang.Enum<AxisDirection>
org.spongepowered.api.util.AxisDirection
All Implemented Interfaces:
Serializable, Comparable<AxisDirection>, Constable

public enum AxisDirection extends Enum<AxisDirection>
Represents the directional axis is either positive, zero, or negative.
  • Enum Constant Details

  • Method Details

    • values

      public static AxisDirection[] 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 AxisDirection 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
    • signum

      public int signum()
      Gets the signum for this direction.

      A positive direction has a value of 1, negative direction -1 and 0 for no direction.

      Returns:
      The signum