Package dev.kyzel.game.entity

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

dev.kyzel.game.entity.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

All possible directions that Entity can move in.

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
DOWN	Going down.
LEFT	Going left.
NONE	No direction is used.
RIGHT	Going right.
UP	Going up.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Direction()

Method Summary

Modifier and Type	Method	Description
static Direction	getOppositeDirection(Direction dir)	Gets the opposite direction of the given direction.
static Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Direction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final Direction NONE

No direction is used.

UP

public static final Direction UP

Going up.

DOWN

public static final Direction DOWN

Going down.

RIGHT

public static final Direction RIGHT

Going right.

LEFT

public static final Direction LEFT

Going left.

Constructor Details

Direction

private Direction()

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

getOppositeDirection

public static Direction getOppositeDirection(Direction dir)

Gets the opposite direction of the given direction.

Parameters:

dir - the given direction

Returns:

the opposite direction