Enum Class EffectOrigin

java.lang.Object

java.lang.Enum<EffectOrigin>

com.hypixel.hytale.builtin.triggervolumes.effect.EffectOrigin

All Implemented Interfaces:

Serializable, Comparable<EffectOrigin>, Constable

public enum EffectOrigin
extends Enum<EffectOrigin>

The reference point an effect resolves its position against. Shared by every effect that places something at a point so the anchor vocabulary and the missing-actor fallback stay consistent. Resolve a concrete position with TriggerContext.resolveOrigin(EffectOrigin, Vector3d, TriggerContext.MissingActor).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ENTITY	The triggering entity's position; falls back per the effect's policy when there is no actor.
EVENT	Where the triggering event happened (block position, else actor); falls back per policy when absent.
VOLUME_ORIGIN	The volume's origin.
WORLD_ABSOLUTE	An absolute world coordinate.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VOLUME_ORIGIN

public static final EffectOrigin VOLUME_ORIGIN

The volume's origin. The configured offset is added to it.

ENTITY

public static final EffectOrigin ENTITY

The triggering entity's position; falls back per the effect's policy when there is no actor.

EVENT

public static final EffectOrigin EVENT

Where the triggering event happened (block position, else actor); falls back per policy when absent.

WORLD_ABSOLUTE

public static final EffectOrigin WORLD_ABSOLUTE

An absolute world coordinate. The configured offset is the position itself.

Method Details

values

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