Class TriggerContext

java.lang.Object

com.hypixel.hytale.builtin.triggervolumes.effect.TriggerContext

public class TriggerContext
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TriggerContext.MissingActor	How resolveOrigin(EffectOrigin, Vector3d, TriggerContext.MissingActor) behaves when an ENTITY/EVENT anchor has no position.

Constructor Summary

Constructors

Constructor	Description
TriggerContext(Ref<EntityStore> entityRef, Store<EntityStore> store, TriggerEventType eventType, VolumeEntry volume)
TriggerContext(Ref<EntityStore> entityRef, Store<EntityStore> store, TriggerEventType eventType, VolumeEntry volume, List<VolumeEntry> spatialVolumes)
TriggerContext(Ref<EntityStore> entityRef, Store<EntityStore> store, TriggerEventType eventType, VolumeEntry volume, List<VolumeEntry> spatialVolumes, org.joml.Vector3d actorPosition)
TriggerContext(Ref<EntityStore> entityRef, Store<EntityStore> store, TriggerEventType eventType, VolumeEntry volume, List<VolumeEntry> spatialVolumes, org.joml.Vector3d actorPosition, List<SignalTag> signalTags, org.joml.Vector3d blockPosition, String blockId, InteractionType interactionType)

Method Summary

Modifier and Type	Method	Description
org.joml.Vector3d	getActorPosition()	Position of the triggering actor: the live transform when the ref is still valid, otherwise the snapshot captured when the effect was scheduled (so position-based effects still fire at the right place after the actor, e.g. a projectile, has despawned).
String	getBlockId()
org.joml.Vector3d	getBlockPosition()
Ref<EntityStore>	getEntityRef()
org.joml.Vector3d	getEventPosition()	Where the triggering event happened: the block position for block-driven events, otherwise the actor position.
TriggerEventType	getEventType()
InteractionType	getInteractionType()
List<SignalTag>	getSignalTags()	Tags carried by the signal that produced this context (empty for non-signal events).
List<VolumeEntry>	getSpatialVolumes()	Volumes used for spatial queries (shape, bounds).
Store<EntityStore>	getStore()
VolumeEntry	getVolume()
org.joml.Vector3d	resolveOrigin(EffectOrigin origin, org.joml.Vector3d offset, TriggerContext.MissingActor onMissing)	Resolves the world position an effect should act at for the given anchor, adding offset (which is the absolute position itself for EffectOrigin.WORLD_ABSOLUTE).

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TriggerContext

public TriggerContext(@Nullable
 Ref<EntityStore> entityRef,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 TriggerEventType eventType,
 @Nonnull
 VolumeEntry volume)

TriggerContext

public TriggerContext(@Nullable
 Ref<EntityStore> entityRef,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 TriggerEventType eventType,
 @Nonnull
 VolumeEntry volume,
 @Nonnull
 List<VolumeEntry> spatialVolumes)

TriggerContext

public TriggerContext(@Nullable
 Ref<EntityStore> entityRef,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 TriggerEventType eventType,
 @Nonnull
 VolumeEntry volume,
 @Nonnull
 List<VolumeEntry> spatialVolumes,
 @Nullable
 org.joml.Vector3d actorPosition)

TriggerContext

public TriggerContext(@Nullable
 Ref<EntityStore> entityRef,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 TriggerEventType eventType,
 @Nonnull
 VolumeEntry volume,
 @Nonnull
 List<VolumeEntry> spatialVolumes,
 @Nullable
 org.joml.Vector3d actorPosition,
 @Nonnull
 List<SignalTag> signalTags,
 @Nullable
 org.joml.Vector3d blockPosition,
 @Nullable
 String blockId,
 @Nullable
 InteractionType interactionType)

Method Details

getEntityRef

@Nullable
public Ref<EntityStore> getEntityRef()

getActorPosition

@Nullable
public org.joml.Vector3d getActorPosition()

Position of the triggering actor: the live transform when the ref is still valid, otherwise the snapshot captured when the effect was scheduled (so position-based effects still fire at the right place after the actor, e.g. a projectile, has despawned). Null when neither is available.

getStore

@Nonnull
public Store<EntityStore> getStore()

getEventType

@Nonnull
public TriggerEventType getEventType()

getVolume

@Nonnull
public VolumeEntry getVolume()

getSpatialVolumes

@Nonnull
public List<VolumeEntry> getSpatialVolumes()

Volumes used for spatial queries (shape, bounds). For group effects this is every member volume; otherwise it is a single-element list of getVolume().

getSignalTags

@Nonnull
public List<SignalTag> getSignalTags()

Tags carried by the signal that produced this context (empty for non-signal events). A TagCondition with Source: EVENT matches against these.

getBlockPosition

@Nullable
public org.joml.Vector3d getBlockPosition()

getEventPosition

@Nullable
public org.joml.Vector3d getEventPosition()

Where the triggering event happened: the block position for block-driven events, otherwise the actor position. Used to anchor a signal at its origin so receiver effects fire there rather than at the receiving volume's center. Null when the event carries no position.

getBlockId

@Nullable
public String getBlockId()

getInteractionType

@Nullable
public InteractionType getInteractionType()

resolveOrigin

@Nullable
public org.joml.Vector3d resolveOrigin(@Nonnull
 EffectOrigin origin,
 @Nullable
 org.joml.Vector3d offset,
 @Nonnull
 TriggerContext.MissingActor onMissing)

Resolves the world position an effect should act at for the given anchor, adding offset (which is the absolute position itself for EffectOrigin.WORLD_ABSOLUTE). Returns null only when an ENTITY/EVENT anchor has no position and onMissing is TriggerContext.MissingActor.SKIP.