Package gg.xp.xivsupport.gui.map.omen

Enum Class OmenLocationType

java.lang.Object

java.lang.Enum<OmenLocationType>

gg.xp.xivsupport.gui.map.omen.OmenLocationType

All Implemented Interfaces:

Serializable, Comparable<OmenLocationType>, Constable

public enum OmenLocationType
extends Enum<OmenLocationType>

Describes where in relation to the caster and target an omen should be drawn

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
CASTER	Draw at the caster using the caster's facing angle
CASTER_FACE_TARGET	Draw at the caster, but facing the target (think baited cleaves where the NPC doesn't turn)
TARGET_IF_AVAILABLE	Draw at the target.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CASTER

public static final OmenLocationType CASTER

Draw at the caster using the caster's facing angle

CASTER_FACE_TARGET

public static final OmenLocationType CASTER_FACE_TARGET

Draw at the caster, but facing the target (think baited cleaves where the NPC doesn't turn)

If no target is available, behaves the same as CASTER

TARGET_IF_AVAILABLE

public static final OmenLocationType TARGET_IF_AVAILABLE

Draw at the target. If no target is available, behaves the same as CASTER

Method Details

values

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