Record Class PrefabRemoveContext

java.lang.Object
java.lang.Record
com.hypixel.hytale.builtin.adventure.worldevents.context.PrefabRemoveContext
All Implemented Interfaces:
Context
public record PrefabRemoveContext(@Nonnull UUID snapshot, @Nonnull ContextKey contextKey, @Nonnull Path prefab, @Nonnull org.joml.Vector3i origin, @Nonnull PrefabRotation rotation) extends Record implements Context

  • Field Details

  • Constructor Details

    • PrefabRemoveContext

      public PrefabRemoveContext(@Nonnull UUID snapshot, @Nonnull ContextKey contextKey, @Nonnull Path prefab, @Nonnull org.joml.Vector3i origin, @Nonnull PrefabRotation rotation)
      Creates an instance of a PrefabRemoveContext record class.
      Parameters:
      snapshot - the value for the snapshot record component
      contextKey - the value for the contextKey record component
      prefab - the value for the prefab record component
      origin - the value for the origin record component
      rotation - the value for the rotation 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.

    • snapshot

      @Nonnull public UUID snapshot()
      Returns the value of the snapshot record component.
      Returns:
      the value of the snapshot record component

    • contextKey

      @Nonnull public ContextKey contextKey()
      Returns the value of the contextKey record component.
      Returns:
      the value of the contextKey record component

    • prefab

      @Nonnull public Path prefab()
      Returns the value of the prefab record component.
      Returns:
      the value of the prefab record component

    • origin

      @Nonnull public org.joml.Vector3i origin()
      Returns the value of the origin record component.
      Returns:
      the value of the origin record component

    • rotation

      @Nonnull public PrefabRotation rotation()
      Returns the value of the rotation record component.
      Returns:
      the value of the rotation record component