Record Class GlobalEventStopAction

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

EventAction

public record GlobalEventStopAction(@Nonnull UUID id, boolean fail)
extends Record
implements EventAction

Field Summary

Fields

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

Fields inherited from interface EventAction

ARRAY_CODEC, EMPTY_ARRAY, TYPE_CODEC

Constructor Summary

Constructors

Constructor	Description
GlobalEventStopAction(UUID id, boolean fail)	Creates an instance of a GlobalEventStopAction 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.
boolean	fail()	Returns the value of the fail record component.
final int	hashCode()	Returns a hash code value for this object.
UUID	id()	Returns the value of the id record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface EventAction

validate

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

CODEC

public static final RecordCodec<GlobalEventStopAction> CODEC

Constructor Details

GlobalEventStopAction

public GlobalEventStopAction(@Nonnull
 UUID id,
 boolean fail)

Creates an instance of a GlobalEventStopAction record class.

Parameters:

id - the value for the id record component

fail - the value for the fail 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

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

id

@Nonnull
public UUID id()

Returns the value of the id record component.

Returns:

the value of the id record component

fail

public boolean fail()

Returns the value of the fail record component.

Returns:

the value of the fail record component