Record Class EventStopAction

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

EventAction

public record EventStopAction(@Nonnull ContextKey eventKey)
extends Record
implements EventAction

Field Summary

Fields

Modifier and Type	Field	Description
static final RecordCodec<EventStopAction>	CODEC
static final String	ID

Fields inherited from interface EventAction

ARRAY_CODEC, EMPTY_ARRAY, TYPE_CODEC

Constructor Summary

Constructors

Constructor	Description
EventStopAction(ContextKey eventKey)	Creates an instance of a EventStopAction record class.

Method Summary

Modifier and Type	Method	Description
boolean	apply(Ref<EntityStore> ref, CommandBuffer<EntityStore> buffer, WorldEvent event)	Executes the action.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ContextKey	eventKey()	Returns the value of the eventKey record component.
final int	hashCode()	Returns a hash code value for this object.
static <T> void	stopEvent(CommandBuffer<EntityStore> buffer, T obj, BiPredicate<WorldEvent, T> predicate)
static <T> void	stopEvent(Store<EntityStore> store, T obj, BiPredicate<WorldEvent, T> predicate)
final String	toString()	Returns a string representation of this record class.
void	validate(Validator validator)	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

getClass, notify, notifyAll, wait, wait, wait

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

CODEC

public static final RecordCodec<EventStopAction> CODEC

Constructor Details

EventStopAction

public EventStopAction(@Nonnull
 ContextKey eventKey)

Creates an instance of a EventStopAction record class.

Parameters:

eventKey - the value for the eventKey record component

Method Details

apply

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

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)

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

stopEvent

public static <T> void stopEvent(@Nonnull
 Store<EntityStore> store,
 @Nullable
 T obj,
 @Nonnull
 BiPredicate<WorldEvent, T> predicate)

stopEvent

public static <T> void stopEvent(@Nonnull
 CommandBuffer<EntityStore> buffer,
 @Nullable
 T obj,
 @Nonnull
 BiPredicate<WorldEvent, T> predicate)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

eventKey

@Nonnull
public ContextKey eventKey()

Returns the value of the eventKey record component.

Returns:

the value of the eventKey record component