org.spongepowered.api.item.recipe.smelting

Interface SmeltingRecipe

All Superinterfaces:

CatalogType, Recipe

public interface SmeltingRecipe
extends Recipe, CatalogType

A general interface for furnace recipes. You can implement it manually to suit your creative needs, or you can simply use the SmeltingRecipe.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SmeltingRecipe.Builder Builds a simple furnace recipe.

Method Summary

Modifier and Type	Method and Description
static SmeltingRecipe.Builder	builder() Builds a simple furnace recipe.
ItemStackSnapshot	getExemplaryIngredient() An exemplary ItemStackSnapshot, which will always make isValid(ItemStackSnapshot) return true.
default String	getId() Gets the unique identifier of this CatalogType.
default String	getName() Gets the human-readable name of this individual CatalogType.
Optional<SmeltingResult>	getResult(ItemStackSnapshot ingredient) Returns the SmeltingResult containing the resulting ItemStackSnapshot and the amount of experience released.
boolean	isValid(ItemStackSnapshot ingredient) Checks if the given ItemStackSnapshot fits the required constraints to craft this SmeltingRecipe.

Methods inherited from interface org.spongepowered.api.item.recipe.Recipe

getExemplaryResult

Method Detail

builder

static SmeltingRecipe.Builder builder()

Builds a simple furnace recipe. Note, that you can implement the SmeltingRecipe manually, too.

Returns:

A SmeltingRecipe builder

getId

default String getId()

Description copied from interface: CatalogType

Gets the unique identifier of this CatalogType. The identifier is case insensitive, thus there cannot be another instance with a different character case. The id of this instance must remain the same for the entire duration of its existence. The identifier can be formatted however needed.

A typical id format follows the pattern of `modId:name` or `minecraft:name`. However the prefix may be omitted for default/vanilla minecraft types.

Specified by:

getId in interface CatalogType

Returns:

The unique identifier of this dummy type

getName

default String getName()

Description copied from interface: CatalogType

Gets the human-readable name of this individual CatalogType. This name is not guaranteed to be unique. This value should not be used for serialization.

Specified by:

getName in interface CatalogType

Returns:

The human-readable name of this dummy type

getExemplaryIngredient

ItemStackSnapshot getExemplaryIngredient()

An exemplary ItemStackSnapshot, which will always make isValid(ItemStackSnapshot) return true.

Returns:

The ItemStackSnapshot as explained above

isValid

boolean isValid(ItemStackSnapshot ingredient)

Checks if the given ItemStackSnapshot fits the required constraints to craft this SmeltingRecipe.

Parameters:

ingredient - The ingredient to check against

Returns:

Whether this ingredient can be used to craft the result

getResult

Optional<SmeltingResult> getResult(ItemStackSnapshot ingredient)

Returns the SmeltingResult containing the resulting ItemStackSnapshot and the amount of experience released.

This method should be used instead of the Recipe.getExemplaryResult() method, as it customizes the result further depending on the specified ingredient ItemStackSnapshot. It is advised to use the output of Recipe.getExemplaryResult(), modify it accordingly, and return it.

Parameters:

ingredient - The ItemStackSnapshot currently being smelted

Returns:

The SmeltingResult, or Optional.empty() if the recipe is not valid according to isValid(ItemStackSnapshot).