fr.arakne.utils.maps.constant

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

fr.arakne.utils.maps.constant.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

List of available directions

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST
NORTH
NORTH_EAST
NORTH_WEST
SOUTH
SOUTH_EAST
SOUTH_WEST
WEST

Field Summary

Fields

Modifier and Type	Field and Description
static char	FIRST_CHAR
static char	LAST_CHAR

Method Summary

Modifier and Type	Method and Description
static Direction	byChar(@IntRange(from=97L,to=104L) char c) Get the direction by its char value
int	nextCellIncrement(@Positive int mapWidth) Get the increment to apply to cell id for get the next cell on the direction Ex: MapCell current = map.get(123); MapCell east = map.get(Direction.EAST.nextCellIncrement(map.dimensions().width()) + current.id());
Direction	opposite() Get the opposite direction
Direction	orthogonal() Get the orthogonal direction
boolean	restricted() Does the direction is restricted A restricted direction can be used in fight, or by monsters's sprites Restricted direction do not allow diagonal
static Direction[]	restrictedDirections() Get the restricted directions (i.e. can be used on fight) Note: a new array is always returned
char	toChar() Get the char value of the direction
static Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Direction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EAST

public static final Direction EAST

SOUTH_EAST

public static final Direction SOUTH_EAST

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

Field Detail

FIRST_CHAR

public static final char FIRST_CHAR

See Also:

Constant Field Values

LAST_CHAR

public static final char LAST_CHAR

See Also:

Constant Field Values

Method Detail

values

public static Direction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Direction c : Direction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Direction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

toChar

@Pure
public char toChar()

Get the char value of the direction

Returns:

The direction char value

opposite

@Pure
public Direction opposite()

Get the opposite direction

Returns:

The direction

orthogonal

@Pure
public Direction orthogonal()

Get the orthogonal direction

Returns:

The direction

restricted

@Pure
public boolean restricted()

Does the direction is restricted A restricted direction can be used in fight, or by monsters's sprites Restricted direction do not allow diagonal

Returns:

true if the direction can be used when restrictions are enabled

nextCellIncrement

@Pure
public int nextCellIncrement(@Positive int mapWidth)

Get the increment to apply to cell id for get the next cell on the direction Ex: MapCell current = map.get(123); MapCell east = map.get(Direction.EAST.nextCellIncrement(map.dimensions().width()) + current.id());

Parameters:

mapWidth - The map width

Returns:

The next cell id increment

byChar

@Pure
public static Direction byChar(@IntRange(from=97L,to=104L) char c)

Get the direction by its char value

Parameters:

c - The direction character value

Returns:

The direction

restrictedDirections

@SideEffectFree
public static Direction[] restrictedDirections()

Get the restricted directions (i.e. can be used on fight) Note: a new array is always returned

Returns:

The array of Direction