Package com.minecolonies.api.items

Record Class IBlockOverlayItem.OverlayBox

java.lang.Object
java.lang.Record
com.minecolonies.api.items.IBlockOverlayItem.OverlayBox
Record Components:
bounds - the bounds of the box.
pos - rendering relative pos, if null then aabb is used
color - the line color.
width - the line width.
showThroughBlocks - true to display through blocks.
Enclosing interface:
IBlockOverlayItem
public static record IBlockOverlayItem.OverlayBox(@Nullable net.minecraft.world.phys.AABB bounds, @Nullable net.minecraft.core.BlockPos pos, int color, float width, boolean showThroughBlocks) extends Record
Details about the overlay box to draw.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OverlayBox(net.minecraft.core.BlockPos bounds, int color, float width, boolean showThroughBlocks)
     
    OverlayBox(@Nullable net.minecraft.world.phys.AABB bounds, @Nullable net.minecraft.core.BlockPos pos, int color, float width, boolean showThroughBlocks)
    Creates an instance of a OverlayBox record class.
    OverlayBox(net.minecraft.world.phys.AABB bounds, int color, float width, boolean showThroughBlocks)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable net.minecraft.world.phys.AABB
    bounds()
    Returns the value of the bounds record component.
    int
    color()
    Returns the value of the color 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.
    @Nullable net.minecraft.core.BlockPos
    pos()
    Returns the value of the pos record component.
    boolean
    showThroughBlocks()
    Returns the value of the showThroughBlocks record component.
    final String
    toString()
    Returns a string representation of this record class.
    float
    width()
    Returns the value of the width record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OverlayBox

      public OverlayBox(@Nullable @Nullable net.minecraft.world.phys.AABB bounds, @Nullable @Nullable net.minecraft.core.BlockPos pos, int color, float width, boolean showThroughBlocks)
      Creates an instance of a OverlayBox record class.
      Parameters:
      bounds - the value for the bounds record component
      pos - the value for the pos record component
      color - the value for the color record component
      width - the value for the width record component
      showThroughBlocks - the value for the showThroughBlocks record component

    • OverlayBox

      public OverlayBox(net.minecraft.core.BlockPos bounds, int color, float width, boolean showThroughBlocks)

    • OverlayBox

      public OverlayBox(net.minecraft.world.phys.AABB bounds, int color, float width, boolean showThroughBlocks)

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

    • bounds

      @Nullable public @Nullable net.minecraft.world.phys.AABB bounds()
      Returns the value of the bounds record component.
      Returns:
      the value of the bounds record component

    • pos

      @Nullable public @Nullable net.minecraft.core.BlockPos pos()
      Returns the value of the pos record component.
      Returns:
      the value of the pos record component

    • color

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

    • width

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

    • showThroughBlocks

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