Record Class EventContext

java.lang.Object
java.lang.Record
com.hypixel.hytale.builtin.adventure.worldevents.context.EventContext
All Implemented Interfaces:
Context
public record EventContext(@Nonnull UUID id, boolean detached) extends Record implements Context

  • Field Summary

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

    Fields inherited from interface Context

    TYPE_CODEC

  • Constructor Summary

    Constructors
    Constructor
    Description
    EventContext(UUID id, boolean detached)
    Creates an instance of a EventContext record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cleanup(CommandBuffer<EntityStore> buffer, WorldEvent event)
    Called when the owning event ends, whether by success or failure.
    boolean
    detached()
    Returns the value of the detached record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    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

  • Field Details

  • Constructor Details

    • EventContext

      public EventContext(@Nonnull UUID id, boolean detached)
      Creates an instance of a EventContext record class.
      Parameters:
      id - the value for the id record component
      detached - the value for the detached record component

  • Method Details

    • cleanup

      public void cleanup(@Nonnull CommandBuffer<EntityStore> buffer, @Nonnull WorldEvent event)
      Description copied from interface: Context
      Called when the owning event ends, whether by success or failure.

      Override to release resources or trigger compensating actions. Enqueue any ECS mutations through buffer rather than applying them directly. This method is only called for context entries that are still present in the map when the event ends; entries that were removed via consume earlier in the event's lifetime will not have cleanup invoked.

      Specified by:
      cleanup in interface Context
      Parameters:
      buffer - the command buffer for enqueuing ECS mutations
      event - the world event that just ended

    • 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

    • detached

      public boolean detached()
      Returns the value of the detached record component.
      Returns:
      the value of the detached record component