org.spongepowered.api.item.recipe.crafting

Class CraftingResult

java.lang.Object

org.spongepowered.api.item.recipe.crafting.CraftingResult

public final class CraftingResult
extends Object

The result of fulfilling a CraftingRecipe.

Constructor Summary

Constructors

Constructor and Description
CraftingResult(ItemStackSnapshot result, List<ItemStackSnapshot> remainingItems) Creates a new CraftingResult.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CraftingResult

public CraftingResult(ItemStackSnapshot result,
                      List<ItemStackSnapshot> remainingItems)

Creates a new CraftingResult.

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 Detail

getResult

public ItemStackSnapshot getResult()

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.

Returns:

The result of fulfilling the requirements of a CraftingRecipe

getRemainingItems

public List<ItemStackSnapshot> getRemainingItems()

Returns a list of ItemStackSnapshot to be set in the input CraftingGridInventory, contains ItemStackSnapshot.NONEs 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