Record Class SkyLayerDefinition.Animation

java.lang.Object
java.lang.Record
net.ixdarklord.coolcatcanvas.api.client.sky.SkyLayerDefinition.Animation
Record Components:
frameTime - ticks each frame shows for (20 a second)
interpolate - cross-fades from each frame into the next instead of cutting
clock - SkyClock.GAME_TIME (the default) or SkyClock.REAL_TIME
Enclosing class:
SkyLayerDefinition
public static record SkyLayerDefinition.Animation(int frames, float frameTime, boolean interpolate, SkyClock clock) extends Record
Plays the texture as a flipbook: frames images of equal height stacked top to bottom.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.Codec<SkyLayerDefinition.Animation>
    CODEC
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Animation(int frames, float frameTime, boolean interpolate, SkyClock clock)
    Creates an instance of a Animation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    SkyClock
    clock()
    Returns the value of the clock record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    frames()
    Returns the value of the frames record component.
    float
    frameTime()
    Returns the value of the frameTime record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    interpolate()
    Returns the value of the interpolate record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Field Details

  • Constructor Details

    • Animation

      public Animation(int frames, float frameTime, boolean interpolate, SkyClock clock)
      Creates an instance of a Animation record class.
      Parameters:
      frames - the value for the frames record component
      frameTime - the value for the frameTime record component
      interpolate - the value for the interpolate record component
      clock - the value for the clock record component

  • Method Details

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

    • frames

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

    • frameTime

      public float frameTime()
      Returns the value of the frameTime record component.
      Returns:
      the value of the frameTime record component

    • interpolate

      public boolean interpolate()
      Returns the value of the interpolate record component.
      Returns:
      the value of the interpolate record component

    • clock

      public SkyClock clock()
      Returns the value of the clock record component.
      Returns:
      the value of the clock record component