Package net.fabricmc.fabric.api.recipe.v1.ingredient

Interface CustomIngredientSerializer<T extends CustomIngredient>

Type Parameters:

T - the type of the custom ingredient

public interface CustomIngredientSerializer<T extends CustomIngredient>

Serializer for a CustomIngredient.

All instances must be registered using register(net.fabricmc.fabric.api.recipe.v1.ingredient.CustomIngredientSerializer<?>) for deserialization to work.

Method Summary

Modifier and Type	Method	Description
static @Nullable CustomIngredientSerializer<?>	get(Identifier identifier)	Returns the custom ingredient serializer registered with the given identifier, or null if there is no such serializer.
com.mojang.serialization.MapCodec<T>	getCodec(boolean allowEmpty)	Returns the codec.
Identifier	getIdentifier()	Returns the identifier of this serializer.
PacketCodec<RegistryByteBuf,T>	getPacketCodec()	Returns the packet codec for serializing this ingredient.
static void	register(CustomIngredientSerializer<?> serializer)	Registers a custom ingredient serializer, using the serializer's identifier.

Method Details

register

static void register(CustomIngredientSerializer<?> serializer)

Registers a custom ingredient serializer, using the serializer's identifier.

Throws:

IllegalArgumentException - if the serializer is already registered

get

@Nullable
static @Nullable CustomIngredientSerializer<?> get(Identifier identifier)

Returns the custom ingredient serializer registered with the given identifier, or null if there is no such serializer..

Returns:

the custom ingredient serializer registered with the given identifier, or null if there is no such serializer

getIdentifier

Identifier getIdentifier()

Returns the identifier of this serializer..

Returns:

the identifier of this serializer

getCodec

com.mojang.serialization.MapCodec<T> getCodec(boolean allowEmpty)

Returns the codec..

Codecs are used to read the ingredient from the recipe JSON files.

Returns:

the codec

See Also:

• Ingredient.ALLOW_EMPTY_CODEC
• Ingredient.DISALLOW_EMPTY_CODEC

getPacketCodec

PacketCodec<RegistryByteBuf,T> getPacketCodec()

Returns the packet codec for serializing this ingredient..

Returns:

the packet codec for serializing this ingredient

See Also:

• Ingredient.PACKET_CODEC