Record Class CardinalLighting

java.lang.Object
java.lang.Record
net.minecraft.world.level.CardinalLighting
public record CardinalLighting(float down, float up, float north, float south, float west, float east) extends Record

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    CardinalLighting.Type
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CardinalLighting
    DEFAULT
     
    private final float
    down
    The field for the down record component.
    private final float
    east
    The field for the east record component.
    static final CardinalLighting
    NETHER
     
    private final float
    north
    The field for the north record component.
    private final float
    south
    The field for the south record component.
    private final float
    up
    The field for the up record component.
    private final float
    west
    The field for the west record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CardinalLighting(float down, float up, float north, float south, float west, float east)
    Creates an instance of a CardinalLighting record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    byFace(Direction direction)
     
    float
    down()
    Returns the value of the down record component.
    float
    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.
    float
    north()
    Returns the value of the north record component.
    float
    south()
    Returns the value of the south record component.
    final String
    toString()
    Returns a string representation of this record class.
    float
    up()
    Returns the value of the up record component.
    float
    west()
    Returns the value of the west record component.

    Methods inherited from class Object

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

  • Field Details

    • down

      private final float down
      The field for the down record component.

    • up

      private final float up
      The field for the up record component.

    • north

      private final float north
      The field for the north record component.

    • south

      private final float south
      The field for the south record component.

    • west

      private final float west
      The field for the west record component.

    • east

      private final float east
      The field for the east record component.

    • DEFAULT

      public static final CardinalLighting DEFAULT

    • NETHER

      public static final CardinalLighting NETHER

  • Constructor Details

    • CardinalLighting

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

  • Method Details

    • byFace

      public float byFace(Direction direction)

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

    • down

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

    • up

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

    • north

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

    • south

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

    • west

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

    • east

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