squidpony.squidai

Enum AimLimit

java.lang.Object

java.lang.Enum<AimLimit>

squidpony.squidai.AimLimit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AimLimit>

public enum AimLimit
extends java.lang.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. Created by Tommy Ettinger on 12/17/2015.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIAGONAL
EIGHT_WAY
FREE
ORTHOGONAL

Method Summary

Modifier and Type	Method and Description
static AimLimit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AimLimit[]	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

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

Method Detail

values

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

Returns:

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

valueOf

public static AimLimit valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null