Package org.spongepowered.api.item.recipe.crafting

Class RecipeResult

java.lang.Object

org.spongepowered.api.item.recipe.crafting.RecipeResult

public final class RecipeResult
extends Object

The result of fulfilling a CraftingRecipe.

Constructor Summary

Constructors

Constructor	Description
RecipeResult(ItemStackLike result, List<? extends ItemStackLike> remainingItems)	Creates a new RecipeResult.
RecipeResult(ItemStackSnapshot result, List<ItemStackSnapshot> remainingItems)	Deprecated, for removal: This API element is subject to removal in a future version. Use RecipeResult(ItemStackLike, List) instead.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
List<ItemStackSnapshot>	remainingItems()	Returns a list of ItemStackSnapshot to be set in the input CraftingGridInventory, contains ItemStackSnapshot.empty() for slots which should be cleared.
ItemStackSnapshot	result()	This method should be used instead of the Recipe.exemplaryResult() method, as it customizes the result further depending on the specified ingredient ItemStackSnapshot.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RecipeResult

@Deprecated(forRemoval=true)
public RecipeResult(ItemStackSnapshot result,
 List<ItemStackSnapshot> remainingItems)

Deprecated, for removal: This API element is subject to removal in a future version.

Use RecipeResult(ItemStackLike, List) instead.

RecipeResult

public RecipeResult(ItemStackLike result,
 List<? extends ItemStackLike> remainingItems)

Creates a new RecipeResult.

Note that this may be replaced with a static of method in the future.

Parameters:

result - The result of the crafting recipe

remainingItems - The remaining items to leave in the crafting window

Method Details

result

public ItemStackSnapshot result()

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

Returns:

The result of fulfilling the requirements of a CraftingRecipe

remainingItems

public List<ItemStackSnapshot> remainingItems()

Returns a list of ItemStackSnapshot to be set in the input CraftingGridInventory, contains ItemStackSnapshot.empty() for slots which should be cleared.

Returns:

A list of ItemStackSnapshots to be set in the input CraftingGridInventory

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object