Record Class ModelAssetsEvent

java.lang.Object
java.lang.Record
kr.toxicity.model.api.event.ModelAssetsEvent
Record Components:
type - the renderer type
assets - the set of assets to be loaded
All Implemented Interfaces:
ModelEvent
public record ModelAssetsEvent(ModelRenderer.Type type, @NotNull Set<ModelAsset> assets) extends Record implements ModelEvent
Triggered when model assets are being gathered.

This event allows plugins to register custom ModelAssets to be loaded by the engine.

Since:
2.0.0

  • Constructor Details

    • ModelAssetsEvent

      public ModelAssetsEvent(@NotNull ModelRenderer.Type type, @NotNull @NotNull Set<ModelAsset> assets)
      Creates an instance of a ModelAssetsEvent record class.
      Parameters:
      type - the value for the type record component
      assets - the value for the assets record component

  • Method Details

    • addAsset

      public void addAsset(@NotNull @NotNull ModelAsset asset)
      Adds a new model asset to the loading queue.
      Parameters:
      asset - the asset to add
      Throws:
      IllegalArgumentException - if an asset with the same name already exists
      Since:
      2.0.0

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

    • type

      @NotNull public ModelRenderer.Type type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • assets

      @NotNull public @NotNull Set<ModelAsset> assets()
      Returns the value of the assets record component.
      Returns:
      the value of the assets record component