Package kr.toxicity.model.api.data.raw

Record Class ModelFace

java.lang.Object
java.lang.Record
kr.toxicity.model.api.data.raw.ModelFace
Record Components:
north - the UV mapping for the north face
east - the UV mapping for the east face
south - the UV mapping for the south face
west - the UV mapping for the west face
up - the UV mapping for the up face
down - the UV mapping for the down face
@Internal public record ModelFace(@NotNull ModelUV north, @NotNull ModelUV east, @NotNull ModelUV south, @NotNull ModelUV west, @NotNull ModelUV up, @NotNull ModelUV down) extends Record
Represents the UV mappings for all six faces of a cube element.
Since:
1.15.2

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModelFace(@NotNull ModelUV north, @NotNull ModelUV east, @NotNull ModelUV south, @NotNull ModelUV west, @NotNull ModelUV up, @NotNull ModelUV down)
    Creates an instance of a ModelFace record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull ModelUV
    down()
    Returns the value of the down record component.
    @NotNull ModelUV
    east()
    Returns the value of the east record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    hasTexture()
    Checks if any face has a texture defined.
    @NotNull ModelUV
    north()
    Returns the value of the north record component.
    @NotNull ModelUV
    south()
    Returns the value of the south record component.
    @NotNull com.google.gson.JsonObject
    toJson(@NotNull ModelBlueprint parent, int tint)
    Converts the face UV data to a JSON object for the Minecraft model file.
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull ModelUV
    up()
    Returns the value of the up record component.
    @NotNull ModelUV
    west()
    Returns the value of the west record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ModelFace

      public ModelFace(@NotNull @NotNull ModelUV north, @NotNull @NotNull ModelUV east, @NotNull @NotNull ModelUV south, @NotNull @NotNull ModelUV west, @NotNull @NotNull ModelUV up, @NotNull @NotNull ModelUV down)
      Creates an instance of a ModelFace record class.
      Parameters:
      north - the value for the north record component
      east - the value for the east record component
      south - the value for the south record component
      west - the value for the west record component
      up - the value for the up record component
      down - the value for the down record component

  • Method Details

    • toJson

      @NotNull public @NotNull com.google.gson.JsonObject toJson(@NotNull @NotNull ModelBlueprint parent, int tint)
      Converts the face UV data to a JSON object for the Minecraft model file.

      Only faces with a defined texture will be included in the output.

      Parameters:
      parent - the parent model blueprint, used for texture resolution
      tint - the tint index to apply
      Returns:
      the generated JSON object
      Since:
      1.15.2

    • hasTexture

      public boolean hasTexture()
      Checks if any face has a texture defined.
      Returns:
      true if at least one face has a texture, false otherwise
      Since:
      1.15.2

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

    • north

      @NotNull public @NotNull ModelUV north()
      Returns the value of the north record component.
      Returns:
      the value of the north record component

    • east

      @NotNull public @NotNull ModelUV east()
      Returns the value of the east record component.
      Returns:
      the value of the east record component

    • south

      @NotNull public @NotNull ModelUV south()
      Returns the value of the south record component.
      Returns:
      the value of the south record component

    • west

      @NotNull public @NotNull ModelUV west()
      Returns the value of the west record component.
      Returns:
      the value of the west record component

    • up

      @NotNull public @NotNull ModelUV up()
      Returns the value of the up record component.
      Returns:
      the value of the up record component

    • down

      @NotNull public @NotNull ModelUV down()
      Returns the value of the down record component.
      Returns:
      the value of the down record component