Class EnterInstanceTeleporterCondition

java.lang.Object

com.hypixel.hytale.builtin.instances.integrations.EnterInstanceTeleporterCondition

All Implemented Interfaces:

EventCondition, EventCondition.TrackedEvent<EnterInstanceTeleporterEvent>

public class EnterInstanceTeleporterCondition
extends Object
implements EventCondition.TrackedEvent<EnterInstanceTeleporterEvent>

An EventCondition that is triggered on EnterInstanceTeleporterEvent.

The event is fired from TeleportInstanceInteraction. This condition type is only able to match on InstanceBlock teleporters that have been placed by the world-event. The condition cannot handle events where the interaction is configured using an "InstanceKey".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnterInstanceTeleporterCondition.Config
static class	EnterInstanceTeleporterCondition.Handler
static enum	EnterInstanceTeleporterCondition.State

Nested classes/interfaces inherited from interface EventCondition

EventCondition.Event<T>, EventCondition.Ticking, EventCondition.TrackedEvent<T>, EventCondition.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final BuilderCodec<EnterInstanceTeleporterCondition>	CODEC
static final String	ID
static final EventCondition.Type	TYPE

Fields inherited from interface EventCondition

ARRAY_CODEC, EMPTY_ARRAY, TYPE_CODEC

Constructor Summary

Constructors

Constructor	Description
EnterInstanceTeleporterCondition()

Method Summary

Modifier and Type	Method	Description
Class<EnterInstanceTeleporterEvent>	eventType()	Returns the exact class of the ECS event this condition handles.
void	handle(World world, EnterInstanceTeleporterEvent event, TrackedComponent tracked)	Processes an incoming ECS event together with the tracking component of the entity that triggered it.
void	merge(EventCondition other)	Copies runtime state from other into this condition.
boolean	onComplete(WorldEvent event)	Called after all conditions in the stage have returned true from EventCondition.test(), before the stage's actions are run.
boolean	onStart(WorldEvent event)	Called when the stage this condition belongs to begins, after EventCondition.reset().
void	reset()	Resets the condition to its unsatisfied state before a new stage iteration begins.
boolean	test()	Returns true when this condition has been satisfied.

Methods inherited from class Object

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

Methods inherited from interface EventCondition

onCancel

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

TYPE

public static final EventCondition.Type TYPE

CODEC

public static final BuilderCodec<EnterInstanceTeleporterCondition> CODEC

Constructor Details

EnterInstanceTeleporterCondition

public EnterInstanceTeleporterCondition()

Method Details

eventType

public Class<EnterInstanceTeleporterEvent> eventType()

Description copied from interface: EventCondition.TrackedEvent

Returns the exact class of the ECS event this condition handles.

Specified by:

eventType in interface EventCondition.TrackedEvent<EnterInstanceTeleporterEvent>

Returns:

the event class; must match the type parameter T exactly

test

public boolean test()

Description copied from interface: EventCondition

Returns true when this condition has been satisfied.

This method is called frequently and must be side-effect free. Update internal state in EventCondition.Ticking.tick(float, Store) or EventCondition.Event.handle(World, T) instead.

Specified by:

test in interface EventCondition

Returns:

true if the condition is met

reset

public void reset()

Description copied from interface: EventCondition

Resets the condition to its unsatisfied state before a new stage iteration begins.

Called before EventCondition.onStart(WorldEvent) at the start of a stage. All transient fields (timers, flags, cached context references) should be cleared here.

Specified by:

reset in interface EventCondition

merge

public void merge(@Nonnull
 EventCondition other)

Description copied from interface: EventCondition

Copies runtime state from other into this condition.

Called when a persisted condition is restored from storage. The (this) condition is built from its asset config, and the loaded state from the (other) condition is merged into it.

Specified by:

merge in interface EventCondition

Parameters:

other - the loaded condition to merge state from.

handle

public void handle(@Nonnull
 World world,
 @Nonnull
 EnterInstanceTeleporterEvent event,
 @Nonnull
 TrackedComponent tracked)

Description copied from interface: EventCondition.TrackedEvent

Processes an incoming ECS event together with the tracking component of the entity that triggered it.

Specified by:

handle in interface EventCondition.TrackedEvent<EnterInstanceTeleporterEvent>

Parameters:

world - the world in which the event was fired

event - the ECS event

tracked - the TrackedComponent from the entity that triggered the event

onStart

public boolean onStart(@Nonnull
 WorldEvent event)

Description copied from interface: EventCondition

Called when the stage this condition belongs to begins, after EventCondition.reset().

Implementations typically use this to look up values in the event context that the condition needs in order to operate (e.g. a location or a child event reference). If a required context value is absent, log a warning and return false to abort the stage immediately.

Specified by:

onStart in interface EventCondition

Parameters:

event - the world event whose stage is starting

Returns:

false to abort the stage before it runs

onComplete

public boolean onComplete(@Nonnull
 WorldEvent event)

Description copied from interface: EventCondition

Called after all conditions in the stage have returned true from EventCondition.test(), before the stage's actions are run.

This is the correct place to write results into the event context (e.g. LocationCondition writes the chosen location as a LocationContext here). Return false if the condition cannot produce a valid result, which will treat the stage as failed.

Specified by:

onComplete in interface EventCondition

Parameters:

event - the world event whose stage just completed

Returns:

false to treat the stage as failed