Record Class MapMarkerOverrideAddAction

java.lang.Object
java.lang.Record
com.hypixel.hytale.builtin.adventure.worldevents.action.MapMarkerOverrideAddAction
All Implemented Interfaces:
EventAction
public record MapMarkerOverrideAddAction(@Nonnull ContextKey markerKey, @Nonnull String name, @Nullable String icon, @Nullable String displayName, @Nullable Boolean global) extends Record implements EventAction

  • Field Details

  • Constructor Details

    • MapMarkerOverrideAddAction

      public MapMarkerOverrideAddAction(@Nonnull ContextKey markerKey, @Nonnull String name, @Nullable String icon, @Nullable String displayName, @Nullable Boolean global)
      Creates an instance of a MapMarkerOverrideAddAction record class.
      Parameters:
      markerKey - the value for the markerKey record component
      name - the value for the name record component
      icon - the value for the icon record component
      displayName - the value for the displayName record component
      global - the value for the global 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.

    • markerKey

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

    • name

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

    • icon

      @Nullable public String icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component

    • displayName

      @Nullable public String displayName()
      Returns the value of the displayName record component.
      Returns:
      the value of the displayName record component

    • global

      @Nullable public Boolean global()
      Returns the value of the global record component.
      Returns:
      the value of the global record component