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

Interface CraftingRecipe

All Superinterfaces:

Keyed, Recipe, ResourceKeyed

All Known Subinterfaces:

ShapedCraftingRecipe, ShapelessCraftingRecipe, SpecialCraftingRecipe

public interface CraftingRecipe
extends Recipe

A CraftingRecipe represents some craftable recipe in the game.

Currently supported crafting recipe types are:

ShapelessCraftingRecipe for recipes with simple ingredients/result without pattern in a CraftingInventory

ShapedCraftingRecipe for recipes with simple ingredients/result in a pattern in a CraftingInventory

SpecialCraftingRecipe for recipes with complex ingredients and result in a CraftingInventory

Method Summary

Modifier and Type	Method	Description
Optional<String>	group()	The group this CraftingRecipe belongs to or Optional.empty() if not defined.
static ShapedCraftingRecipe.Builder	shapedBuilder()	Provides a builder for a ShapedCraftingRecipe.
static ShapelessCraftingRecipe.Builder	shapelessBuilder()	Provides a builder for a ShapelessCraftingRecipe.
static SpecialCraftingRecipe.Builder	specialBuilder()	Provides a builder for a SpecialCraftingRecipe
RecipeType<? extends CraftingRecipe>	type()	Gets the RecipeType of this recipe.

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

exemplaryResult, ingredients, isDynamic, isValid, remainingItems, result, result

Methods inherited from interface org.spongepowered.api.ResourceKeyed

key

Method Details

type

RecipeType<? extends CraftingRecipe> type()

Description copied from interface: Recipe

Gets the RecipeType of this recipe.

Specified by:

type in interface Recipe

Returns:

The recipe type.

group

Optional<String> group()

The group this CraftingRecipe belongs to or Optional.empty() if not defined.

This value is used to group recipes in the recipe book.

Returns:

The group this Recipe belongs to.

shapedBuilder

static ShapedCraftingRecipe.Builder shapedBuilder()

Provides a builder for a ShapedCraftingRecipe.

Returns:

The builder.

shapelessBuilder

static ShapelessCraftingRecipe.Builder shapelessBuilder()

Provides a builder for a ShapelessCraftingRecipe.

Returns:

The builder.

specialBuilder

static SpecialCraftingRecipe.Builder specialBuilder()

Provides a builder for a SpecialCraftingRecipe

Returns:

The builder.