Package com.minecolonies.api.items.component

Record Class Desc

java.lang.Object
java.lang.Record
com.minecolonies.api.items.component.Desc
public record Desc(net.minecraft.network.chat.MutableComponent desc) extends Record
Custom usually tooltip component, like ItemLore, but simplier

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.Codec<Desc>
    CODEC
     
    static final Desc
    EMPTY
     
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,Desc>
    STREAM_CODEC
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Desc(net.minecraft.network.chat.Component comp)
     
    Desc(net.minecraft.network.chat.MutableComponent desc)
    Creates an instance of a Desc record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    net.minecraft.network.chat.MutableComponent
    desc()
    Returns the value of the desc 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.
    boolean
    isEmpty()
     
    static Desc
    readFromItemStack(net.minecraft.world.item.ItemStack itemStack)
     
    final String
    toString()
    Returns a string representation of this record class.
    static void
    updateItemStack(net.minecraft.world.item.ItemStack itemStack, UnaryOperator<Desc> updater)
     
    void
    writeToItemStack(net.minecraft.world.item.ItemStack itemStack)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • EMPTY

      public static final Desc EMPTY

    • CODEC

      public static final com.mojang.serialization.Codec<Desc> CODEC

    • STREAM_CODEC

      public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,Desc> STREAM_CODEC

  • Constructor Details

    • Desc

      public Desc(net.minecraft.network.chat.Component comp)

    • Desc

      public Desc(net.minecraft.network.chat.MutableComponent desc)
      Creates an instance of a Desc record class.
      Parameters:
      desc - the value for the desc record component

  • Method Details

    • isEmpty

      public boolean isEmpty()

    • writeToItemStack

      public void writeToItemStack(net.minecraft.world.item.ItemStack itemStack)

    • readFromItemStack

      public static Desc readFromItemStack(net.minecraft.world.item.ItemStack itemStack)

    • updateItemStack

      public static void updateItemStack(net.minecraft.world.item.ItemStack itemStack, UnaryOperator<Desc> updater)

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

    • desc

      public net.minecraft.network.chat.MutableComponent desc()
      Returns the value of the desc record component.
      Returns:
      the value of the desc record component