Package com.minecolonies.api.items.component

Record Class ColonyId

java.lang.Object
java.lang.Record
com.minecolonies.api.items.component.ColonyId
All Implemented Interfaces:
net.minecraft.world.item.component.TooltipProvider
public record ColonyId(int id, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension) extends Record implements net.minecraft.world.item.component.TooltipProvider

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ColonyId(int id, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension)
    Creates an instance of a ColonyId record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addToTooltip(net.minecraft.world.item.Item.TooltipContext context, @NotNull Consumer<net.minecraft.network.chat.Component> tooltip, @NotNull net.minecraft.world.item.TooltipFlag flags)
     
    net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>
    dimension()
    Returns the value of the dimension record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    hasColonyId()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    id()
    Returns the value of the id record component.
    static @Nullable IColony
    readColonyFromItemStack(net.minecraft.world.item.ItemStack itemStack)
     
    static @Nullable IColonyView
    readColonyViewFromItemStack(net.minecraft.world.item.ItemStack itemStack)
     
    static ColonyId
    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<ColonyId> 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 ColonyId EMPTY

    • CODEC

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

    • STREAM_CODEC

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

  • Constructor Details

    • ColonyId

      public ColonyId(int id, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension)
      Creates an instance of a ColonyId record class.
      Parameters:
      id - the value for the id record component
      dimension - the value for the dimension record component

  • Method Details

    • hasColonyId

      public boolean hasColonyId()

    • writeToItemStack

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

    • readFromItemStack

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

    • readColonyFromItemStack

      @Nullable public static @Nullable IColony readColonyFromItemStack(net.minecraft.world.item.ItemStack itemStack)

    • readColonyViewFromItemStack

      @Nullable public static @Nullable IColonyView readColonyViewFromItemStack(net.minecraft.world.item.ItemStack itemStack)

    • updateItemStack

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

    • addToTooltip

      public void addToTooltip(@NotNull net.minecraft.world.item.Item.TooltipContext context, @NotNull @NotNull Consumer<net.minecraft.network.chat.Component> tooltip, @NotNull @NotNull net.minecraft.world.item.TooltipFlag flags)
      Specified by:
      addToTooltip in interface net.minecraft.world.item.component.TooltipProvider

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

    • id

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

    • dimension

      public net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension()
      Returns the value of the dimension record component.
      Returns:
      the value of the dimension record component