Package org.moddingx.libx.screen.text.entry

Record Class AlignedComponent

java.lang.Object
java.lang.Record
org.moddingx.libx.screen.text.entry.AlignedComponent
Record Components:
text - The component to display.
left - The horizontal padding to the left edge of the screen.
top - The vertical padding to the bottom of the previous component.
wrapping - A AlignedComponent.TextWrapping describing the wrapping properties of this component or null if this component should not be wrapped.
color - The default display colour for the component. This can be altered by the style.
shadow - Whether the component should be drawn with a shadow.
All Implemented Interfaces:
TextScreenEntry, TextScreenEntry.Direct
public record AlignedComponent(net.minecraft.network.chat.Component text, int left, int top, @Nullable AlignedComponent.TextWrapping wrapping, int color, boolean shadow) extends Record implements TextScreenEntry.Direct
A Component that has been aligned for display on a TextScreen.

  • Constructor Details

    • AlignedComponent

      public AlignedComponent(net.minecraft.network.chat.Component text, int left, int top, AlignedComponent.TextWrapping wrap)

    • AlignedComponent

      public AlignedComponent(net.minecraft.network.chat.Component text, int left, int top, boolean wrap)

    • AlignedComponent

      public AlignedComponent(net.minecraft.network.chat.Component text, int left, int top)

    • AlignedComponent

      public AlignedComponent(net.minecraft.network.chat.Component text, int left, int top, @Nullable AlignedComponent.TextWrapping wrapping, int color, boolean shadow)
      Creates an instance of a AlignedComponent record class.
      Parameters:
      text - the value for the text record component
      left - the value for the left record component
      top - the value for the top record component
      wrapping - the value for the wrapping record component
      color - the value for the color record component
      shadow - the value for the shadow 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 '=='.
      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.

    • text

      public net.minecraft.network.chat.Component text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • left

      public int left()
      Returns the value of the left record component.
      Specified by:
      left in interface TextScreenEntry
      Returns:
      the value of the left record component

    • top

      public int top()
      Returns the value of the top record component.
      Specified by:
      top in interface TextScreenEntry
      Returns:
      the value of the top record component

    • wrapping

      @Nullable public AlignedComponent.TextWrapping wrapping()
      Returns the value of the wrapping record component.
      Returns:
      the value of the wrapping record component

    • color

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

    • shadow

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