Package org.rspeer.game.effect

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

org.rspeer.game.effect.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

Enum containing possible directions in the game

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
NORTH
NORTH_EAST
NORTH_WEST
SOUTH
SOUTH_EAST
SOUTH_WEST
WEST

Method Summary

Modifier and Type	Method	Description
static Direction[]	cardinal()
int	getXOffset()
int	getYOffset()
Direction	invert()
boolean	isCardinal()
static Direction[]	nonCardinal()
static Direction	of(int angle)
static Direction	of(SceneNode src, SceneNode dst)
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

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 Direction SOUTH

SOUTH_WEST

public static final Direction SOUTH_WEST

WEST

public static final Direction WEST

NORTH_WEST

public static final Direction NORTH_WEST

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

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

cardinal

public static Direction[] cardinal()

nonCardinal

public static Direction[] nonCardinal()

of

public static Direction of(int angle)

of

public static Direction of(SceneNode src,
 SceneNode dst)

invert

public Direction invert()

getXOffset

public int getXOffset()

getYOffset

public int getYOffset()

isCardinal

public boolean isCardinal()