Package guideme

Record Class GuideItemSettings

java.lang.Object
java.lang.Record
guideme.GuideItemSettings
public record GuideItemSettings(Optional<net.minecraft.network.chat.Component> displayName, List<net.minecraft.network.chat.Component> tooltipLines, Optional<net.minecraft.resources.ResourceLocation> itemModel) extends Record
Configuration settings for the automatically generated guide item.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static com.mojang.serialization.Codec<GuideItemSettings>
    CODEC
     
    static GuideItemSettings
    DEFAULT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    GuideItemSettings(Optional<net.minecraft.network.chat.Component> displayName, List<net.minecraft.network.chat.Component> tooltipLines, Optional<net.minecraft.resources.ResourceLocation> itemModel)
    Creates an instance of a GuideItemSettings record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<net.minecraft.network.chat.Component>
    displayName()
    Returns the value of the displayName 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.
    Optional<net.minecraft.resources.ResourceLocation>
    itemModel()
    Returns the value of the itemModel record component.
    List<net.minecraft.network.chat.Component>
    tooltipLines()
    Returns the value of the tooltipLines record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • GuideItemSettings

      public GuideItemSettings(Optional<net.minecraft.network.chat.Component> displayName, List<net.minecraft.network.chat.Component> tooltipLines, Optional<net.minecraft.resources.ResourceLocation> itemModel)
      Creates an instance of a GuideItemSettings record class.
      Parameters:
      displayName - the value for the displayName record component
      tooltipLines - the value for the tooltipLines record component
      itemModel - the value for the itemModel 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • displayName

      public Optional<net.minecraft.network.chat.Component> displayName()
      Returns the value of the displayName record component.
      Returns:
      the value of the displayName record component

    • tooltipLines

      public List<net.minecraft.network.chat.Component> tooltipLines()
      Returns the value of the tooltipLines record component.
      Returns:
      the value of the tooltipLines record component

    • itemModel

      public Optional<net.minecraft.resources.ResourceLocation> itemModel()
      Returns the value of the itemModel record component.
      Returns:
      the value of the itemModel record component