org.spongepowered.api.item.recipe.crafting

Interface ShapedCraftingRecipe

All Superinterfaces:

CatalogType, CraftingRecipe, Recipe

public interface ShapedCraftingRecipe
extends CraftingRecipe

A ShapedCraftingRecipe is a CraftingRecipe that has shape and fits into a grid.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ShapedCraftingRecipe.Builder The builder which you create ShapedCraftingRecipes through.

Method Summary

Modifier and Type	Method and Description
static ShapedCraftingRecipe.Builder	builder() Creates a new ShapedCraftingRecipe.Builder to build a ShapedCraftingRecipe.
int	getHeight() Gets the height of the grid this ShapedCraftingRecipe fits into.
Ingredient	getIngredient(int x, int y) Returns the ingredient predicate at the specified location in this recipe.
int	getWidth() Gets the width of the grid this ShapedCraftingRecipe fits into.

Methods inherited from interface org.spongepowered.api.item.recipe.crafting.CraftingRecipe

getGroup, getRemainingItems, getResult, getResult, isValid, shapedBuilder, shapelessBuilder

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

getExemplaryResult

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

builder

static ShapedCraftingRecipe.Builder builder()

Creates a new ShapedCraftingRecipe.Builder to build a ShapedCraftingRecipe.

Returns:

The new builder

getIngredient

Ingredient getIngredient(int x,
                         int y)

Returns the ingredient predicate at the specified location in this recipe.

Parameters:

x - The x coordinate counted from the left side

y - The y coordinate counted from the top

Returns:

The ingredient predicate at this position defined by the aisle

Throws:

IndexOutOfBoundsException - if the location is invalid

getWidth

int getWidth()

Gets the width of the grid this ShapedCraftingRecipe fits into.

Returns:

The width of the grid

getHeight

int getHeight()

Gets the height of the grid this ShapedCraftingRecipe fits into.

Returns:

The height of the grid