Record Class EffectsAction

java.lang.Object
java.lang.Record
com.hypixel.hytale.builtin.adventure.worldevents.action.EffectsAction
All Implemented Interfaces:
EventAction
public record EffectsAction(@Nonnull ContextKey locationKey, int radius, @Nonnull Shape shape, @Nullable CameraFX cfx, @Nullable SoundFX sfx, @Nullable VisualFX vfx) extends Record implements EventAction

  • Field Details

  • Constructor Details

    • EffectsAction

      public EffectsAction(@Nonnull ContextKey locationKey, int radius, @Nonnull Shape shape, @Nullable CameraFX cfx, @Nullable SoundFX sfx, @Nullable VisualFX vfx)
      Creates an instance of a EffectsAction record class.
      Parameters:
      locationKey - the value for the locationKey record component
      radius - the value for the radius record component
      shape - the value for the shape record component
      cfx - the value for the cfx record component
      sfx - the value for the sfx record component
      vfx - the value for the vfx 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

    • 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

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

    • locationKey

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

    • radius

      public int radius()
      Returns the value of the radius record component.
      Returns:
      the value of the radius record component

    • shape

      @Nonnull public Shape shape()
      Returns the value of the shape record component.
      Returns:
      the value of the shape record component

    • cfx

      @Nullable public CameraFX cfx()
      Returns the value of the cfx record component.
      Returns:
      the value of the cfx record component

    • sfx

      @Nullable public SoundFX sfx()
      Returns the value of the sfx record component.
      Returns:
      the value of the sfx record component

    • vfx

      @Nullable public VisualFX vfx()
      Returns the value of the vfx record component.
      Returns:
      the value of the vfx record component