Class ShowEventTitleAction

java.lang.Object

com.hypixel.hytale.builtin.adventure.worldevents.action.ShowEventTitleAction

All Implemented Interfaces:

EventAction

@Deprecated(forRemoval=true)
public final class ShowEventTitleAction
extends Object
implements EventAction

Deprecated, for removal: This API element is subject to removal in a future version.

This class will change when Noesis serverside support comes.

Field Summary

Fields

Modifier and Type	Field	Description
static final BuilderCodec<ShowEventTitleAction>	CODEC	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	ID	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface EventAction

ARRAY_CODEC, EMPTY_ARRAY, TYPE_CODEC

Constructor Summary

Constructors

Constructor	Description
ShowEventTitleAction()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
boolean	apply(Ref<EntityStore> ref, CommandBuffer<EntityStore> buffer, WorldEvent event)	Deprecated, for removal: This API element is subject to removal in a future version. Executes the action.
void	validate(Validator validator)	Deprecated, for removal: This API element is subject to removal in a future version. Called at asset-load time so the action can register the ContextKey values it depends on, enabling the validator to catch dangling or mismatched key names.

Methods inherited from class Object

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

Field Details

ID

public static final String ID

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

CODEC

@Nonnull
public static final BuilderCodec<ShowEventTitleAction> CODEC

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

ShowEventTitleAction

public ShowEventTitleAction()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

apply

public boolean apply(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 CommandBuffer<EntityStore> buffer,
 @Nonnull
 WorldEvent event)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: EventAction

Executes the action.

Actions that read from the event context should check for null values and return false with a warning log if a required entry is missing, as the context may not have been populated if an earlier condition or action failed.

ECS mutations (spawning entities, setting blocks, etc.) should be submitted through buffer rather than applied directly, to maintain world-thread consistency.

Specified by:

apply in interface EventAction

Parameters:

ref - the entity reference for the world event entity

buffer - the command buffer used to submit ECS mutations

event - the running world event, including its context

Returns:

true if the action succeeded; false to abort the current stage

validate

public void validate(@Nonnull
 Validator validator)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: EventAction

Called at asset-load time so the action can register the ContextKey values it depends on, enabling the validator to catch dangling or mismatched key names.

Call Validator.addReferencedKey(String, String, ContextKey) for each key this action reads from context, and Validator.addDefinedKey(String, String, ContextKey) for each key this action writes to context.

Specified by:

validate in interface EventAction

Parameters:

validator - the validator to register key references with