Enum Class AimLimit

java.lang.Object

java.lang.Enum<AimLimit>

com.github.yellowstonegames.path.technique.AimLimit

All Implemented Interfaces:

Serializable, Comparable<AimLimit>, Constable

public enum AimLimit
extends Enum<AimLimit>

Enum used for common targeting limitations (or lack thereof, in the case of AimLimit.FREE ). AimLimit.ORTHOGONAL will limit single targets or the centers/aimed-at-cells of AOE effects to cells directly, north, south, east or west of the user. AimLimit.DIAGONAL does the same but for northeast, southeast, southwest, or northwest. AimLimit.EIGHT_WAY limits the same things, but is less restrictive, allowing all cells AimLimit.ORTHOGONAL does as well as all cells AimLimit.DIAGONAL allows. AimLimit.FREE allows all cells within any range limit an ability may have.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIAGONAL
EIGHT_WAY
FREE
ORTHOGONAL

Field Summary

Fields

Modifier and Type	Field	Description
static final AimLimit[]	ALL	The cached result of values(), so you can avoid repeatedly allocating AimLimit[] objects.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FREE

public static final AimLimit FREE

ORTHOGONAL

public static final AimLimit ORTHOGONAL

DIAGONAL

public static final AimLimit DIAGONAL

EIGHT_WAY

public static final AimLimit EIGHT_WAY

Field Details

ALL

public static final AimLimit[] ALL

The cached result of values(), so you can avoid repeatedly allocating AimLimit[] objects. DO NOT MODIFY THIS ARRAY.

Method Details

values

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