Package dev.twilite.game.common

Enum Class Heading

java.lang.Object

java.lang.Enum<Heading>

dev.twilite.game.common.Heading

All Implemented Interfaces:

Serializable, Comparable<Heading>, Constable

public enum Heading
extends Enum<Heading>

Compass headings used by game entities, represented as the client's 16-direction heading values.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST
EAST_NORTH_EAST
EAST_SOUTH_EAST
NORTH
NORTH_EAST
NORTH_NORTH_EAST
NORTH_NORTH_WEST
NORTH_WEST
SOUTH
SOUTH_EAST
SOUTH_SOUTH_EAST
SOUTH_SOUTH_WEST
SOUTH_WEST
WEST
WEST_NORTH_WEST
WEST_SOUTH_WEST

Method Summary

Modifier and Type	Method	Description
static Heading	fromValue(int value)
int	value()
static Heading	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Heading[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SOUTH

public static final Heading SOUTH

SOUTH_SOUTH_WEST

public static final Heading SOUTH_SOUTH_WEST

SOUTH_WEST

public static final Heading SOUTH_WEST

WEST_SOUTH_WEST

public static final Heading WEST_SOUTH_WEST

WEST

public static final Heading WEST

WEST_NORTH_WEST

public static final Heading WEST_NORTH_WEST

NORTH_WEST

public static final Heading NORTH_WEST

NORTH_NORTH_WEST

public static final Heading NORTH_NORTH_WEST

NORTH

public static final Heading NORTH

NORTH_NORTH_EAST

public static final Heading NORTH_NORTH_EAST

NORTH_EAST

public static final Heading NORTH_EAST

EAST_NORTH_EAST

public static final Heading EAST_NORTH_EAST

EAST

public static final Heading EAST

EAST_SOUTH_EAST

public static final Heading EAST_SOUTH_EAST

SOUTH_EAST

public static final Heading SOUTH_EAST

SOUTH_SOUTH_EAST

public static final Heading SOUTH_SOUTH_EAST

Method Details

values

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

fromValue

public static Heading fromValue(int value)

value

public int value()