Package net.neoforged.neoforge.common.crafting

Record Class IngredientType<T extends ICustomIngredient>

java.lang.Object
java.lang.Record
net.neoforged.neoforge.common.crafting.IngredientType<T>
public record IngredientType<T extends ICustomIngredient>(com.mojang.serialization.MapCodec<T extends ICustomIngredient> codec, StreamCodec<? super RegistryFriendlyByteBuf,T extends ICustomIngredient> streamCodec) extends Record
An ingredient type encapsulates the codecs to serialize and deserialize a custom ingredient.

Note that the streamCodec() is only used if ICustomIngredient.isSimple() returns false.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final com.mojang.serialization.MapCodec<T>
    codec
    The field for the codec record component.
    private final StreamCodec<? super RegistryFriendlyByteBuf,T>
    streamCodec
    The field for the streamCodec record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IngredientType(com.mojang.serialization.MapCodec<T> codec)
    Constructor for ingredient types that use a regular codec for network syncing.
    IngredientType(com.mojang.serialization.MapCodec<T> codec, StreamCodec<? super RegistryFriendlyByteBuf,T> streamCodec)
    Creates an instance of a IngredientType record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.mojang.serialization.MapCodec<T>
    codec()
    Returns the value of the codec 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.
    StreamCodec<? super RegistryFriendlyByteBuf,T>
    streamCodec()
    Returns the value of the streamCodec 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

    • IngredientType

      public IngredientType(com.mojang.serialization.MapCodec<T> codec)
      Constructor for ingredient types that use a regular codec for network syncing.

    • IngredientType

      public IngredientType(com.mojang.serialization.MapCodec<T> codec, StreamCodec<? super RegistryFriendlyByteBuf,T> streamCodec)
      Creates an instance of a IngredientType record class.
      Parameters:
      codec - the value for the codec record component
      streamCodec - the value for the streamCodec 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.

    • codec

      public com.mojang.serialization.MapCodec<T> codec()
      Returns the value of the codec record component.
      Returns:
      the value of the codec record component

    • streamCodec

      public StreamCodec<? super RegistryFriendlyByteBuf,T> streamCodec()
      Returns the value of the streamCodec record component.
      Returns:
      the value of the streamCodec record component