Record Class SkyLayerDefinition.DayFade

java.lang.Object
java.lang.Record
net.ixdarklord.coolcatcanvas.api.client.sky.SkyLayerDefinition.DayFade
Enclosing class:
SkyLayerDefinition
public static record SkyLayerDefinition.DayFade(int startFadeIn, int endFadeIn, int startFadeOut, int endFadeOut) extends Record
Shows the layer during part of the day: it fades in over [startFadeIn, endFadeIn], stays, then fades out over [startFadeOut, endFadeOut]. Times are ticks of the day, 0 to 24000 (0 is sunrise, 6000 noon, 13000 dusk, 18000 midnight), and may wrap around midnight.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.Codec<SkyLayerDefinition.DayFade>
    CODEC
     
    static final SkyLayerDefinition.DayFade
    DAY
    Visible by day only, fading around dawn and dusk.
    static final int
    DAY_LENGTH
     
    static final SkyLayerDefinition.DayFade
    NIGHT
    Visible at night only, fading around dusk and dawn.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DayFade(int startFadeIn, int endFadeIn, int startFadeOut, int endFadeOut)
    Creates an instance of a DayFade record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    endFadeIn()
    Returns the value of the endFadeIn record component.
    int
    endFadeOut()
    Returns the value of the endFadeOut 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.
    int
    startFadeIn()
    Returns the value of the startFadeIn record component.
    int
    startFadeOut()
    Returns the value of the startFadeOut record component.
    final String
    toString()
    Returns a string representation of this record class.
    float
    visibility(float dayTime)
    How visible the layer is at dayTime ticks into the day, from 0 to 1.

    Methods inherited from class Object

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

  • Field Details

  • Constructor Details

    • DayFade

      public DayFade(int startFadeIn, int endFadeIn, int startFadeOut, int endFadeOut)
      Creates an instance of a DayFade record class.
      Parameters:
      startFadeIn - the value for the startFadeIn record component
      endFadeIn - the value for the endFadeIn record component
      startFadeOut - the value for the startFadeOut record component
      endFadeOut - the value for the endFadeOut record component

  • Method Details

    • visibility

      public float visibility(float dayTime)
      How visible the layer is at dayTime ticks into the day, from 0 to 1.

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

    • startFadeIn

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

    • endFadeIn

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

    • startFadeOut

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

    • endFadeOut

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