Record Class TriggerVolumeCreateAction

java.lang.Object
java.lang.Record
com.hypixel.hytale.builtin.triggervolumes.worldevent.TriggerVolumeCreateAction
All Implemented Interfaces:
EventAction
public record TriggerVolumeCreateAction(@Nonnull ContextKey locationKey, @Nonnull ContextKey volumeKey, @Nullable org.joml.Vector3d offset, @Nonnull TriggerVolume volume) extends Record implements EventAction
A world-event action that spawns a trigger volume at a location from the event context.

The action reads the LocationContext stored under LocationKey, registers the configured Volume at that position under a generated unique ID, and writes a TriggerVolumeContext under VolumeKey. Later actions reference the volume through that key, typically a TriggerVolumeRemoveAction. If the volume is never removed explicitly, the context destroys it when the event ends.

  • Field Details

  • Constructor Details

    • TriggerVolumeCreateAction

      public TriggerVolumeCreateAction(@Nonnull ContextKey locationKey, @Nonnull ContextKey volumeKey, @Nullable org.joml.Vector3d offset, @Nonnull TriggerVolume volume)
      Creates an instance of a TriggerVolumeCreateAction record class.
      Parameters:
      locationKey - the value for the locationKey record component
      volumeKey - the value for the volumeKey record component
      offset - the value for the offset record component
      volume - the value for the volume record component

  • Method Details

    • 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

    • 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. 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.

    • locationKey

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

    • volumeKey

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

    • offset

      @Nullable public org.joml.Vector3d offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component

    • volume

      @Nonnull public TriggerVolume volume()
      Returns the value of the volume record component.
      Returns:
      the value of the volume record component