Record Class TriggerVolumeContext

java.lang.Object
java.lang.Record
com.hypixel.hytale.builtin.triggervolumes.worldevent.TriggerVolumeContext
All Implemented Interfaces:
Context
public record TriggerVolumeContext(@Nonnull String volumeId) extends Record implements Context
Context written by TriggerVolumeCreateAction to track the trigger volume it created. It holds the generated volume ID so a later TriggerVolumeRemoveAction can find and remove the volume by its VolumeKey.

  • Field Details

  • Constructor Details

    • TriggerVolumeContext

      public TriggerVolumeContext(@Nonnull String volumeId)
      Creates an instance of a TriggerVolumeContext record class.
      Parameters:
      volumeId - the value for the volumeId 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. 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.

    • volumeId

      @Nonnull public String volumeId()
      Returns the value of the volumeId record component.
      Returns:
      the value of the volumeId record component