fr.arakne.utils.maps.constant

Enum CellMovement

java.lang.Object

java.lang.Enum<CellMovement>

fr.arakne.utils.maps.constant.CellMovement

All Implemented Interfaces:

Serializable, Comparable<CellMovement>

public enum CellMovement
extends Enum<CellMovement>

Available movement values for a cell. Contains information about the walkable state and path priority.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Default movement value for walkable cells
LESS_WALKABLE Walkable cells, but not prioritized.
MOST_WALKABLE The higher movement value, the most prioritized walkable cells.
NOT_WALKABLE Simple not walkable cell
NOT_WALKABLE_INTERACTIVE Not walkable cell containing an interactive object
PADDOCK Cells for paddocks
ROAD Cells for a road.
TRIGGER Movement for triggers.

Method Summary

Modifier and Type	Method and Description
static CellMovement	byValue(@IntRange(from=0L,to=7L) int value) Get a cell movement by its integer value
static CellMovement	valueOf(String name) Returns the enum constant of this type with the specified name.
static CellMovement[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
boolean	walkable() Check if the current movement is for a walkable cell

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

NOT_WALKABLE

public static final CellMovement NOT_WALKABLE

Simple not walkable cell

NOT_WALKABLE_INTERACTIVE

public static final CellMovement NOT_WALKABLE_INTERACTIVE

Not walkable cell containing an interactive object

TRIGGER

public static final CellMovement TRIGGER

Movement for triggers. Note: some triggers has the "default" movement. This value is not reliable for detect triggers.

LESS_WALKABLE

public static final CellMovement LESS_WALKABLE

Walkable cells, but not prioritized. Also contains cellar access cells.

DEFAULT

public static final CellMovement DEFAULT

Default movement value for walkable cells

PADDOCK

public static final CellMovement PADDOCK

Cells for paddocks

ROAD

public static final CellMovement ROAD

Cells for a road. Those cells are prioritized.

MOST_WALKABLE

public static final CellMovement MOST_WALKABLE

The higher movement value, the most prioritized walkable cells.

Method Detail

values

public static CellMovement[] 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 (CellMovement c : CellMovement.values())
    System.out.println(c);

Returns:

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

valueOf

public static CellMovement 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

walkable

@Pure
public boolean walkable()

Check if the current movement is for a walkable cell

Returns:

true is the cel is walkable

byValue

@Pure
public static CellMovement byValue(@IntRange(from=0L,to=7L) int value)

Get a cell movement by its integer value

Parameters:

value - The movement id

Returns:

The movement item