Recipe.java

/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered <https://www.spongepowered.org>
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.item.recipe;

import org.spongepowered.api.ResourceKey;
import org.spongepowered.api.block.BlockTypes;
import org.spongepowered.api.block.entity.carrier.Campfire;
import org.spongepowered.api.block.entity.carrier.furnace.BlastFurnace;
import org.spongepowered.api.block.entity.carrier.furnace.Furnace;
import org.spongepowered.api.block.entity.carrier.furnace.Smoker;
import org.spongepowered.api.item.ItemTypes;
import org.spongepowered.api.item.inventory.ItemStackSnapshot;
import org.spongepowered.api.item.inventory.crafting.CraftingInventory;
import org.spongepowered.api.item.recipe.cooking.CookingRecipe;
import org.spongepowered.api.item.recipe.crafting.CraftingRecipe;
import org.spongepowered.api.item.recipe.crafting.Ingredient;
import org.spongepowered.api.item.recipe.crafting.RecipeInput;
import org.spongepowered.api.item.recipe.crafting.RecipeResult;
import org.spongepowered.api.item.recipe.crafting.ShapedCraftingRecipe;
import org.spongepowered.api.item.recipe.crafting.ShapelessCraftingRecipe;
import org.spongepowered.api.item.recipe.crafting.SpecialCraftingRecipe;
import org.spongepowered.api.item.recipe.single.StoneCutterRecipe;
import org.spongepowered.api.item.recipe.smithing.SmithingRecipe;
import org.spongepowered.api.world.server.ServerWorld;

import java.util.List;
import java.util.Optional;

/**
 * A general interface for recipes.
 * <p>Currently supported recipe types are:</p>
 * <p>{@link ShapelessCraftingRecipe} for recipes with simple ingredients/result without pattern in a {@link CraftingInventory}</p>
 * <p>{@link ShapedCraftingRecipe} for recipes with simple ingredients/result in a pattern in a {@link CraftingInventory}</p>
 * <p>{@link SpecialCraftingRecipe} for recipes with complex ingredients and result in a {@link CraftingInventory}</p>
 * <p>{@link CookingRecipe} for recipes in {@link Furnace}, {@link BlastFurnace}, {@link Smoker} and {@link Campfire}</p>
 * <p>{@link StoneCutterRecipe} for recipes in a {@link BlockTypes#STONECUTTER} block</p>
 * <p>{@link SmithingRecipe} for recipes in a {@link BlockTypes#SMITHING_TABLE} block</p>
 */
public interface Recipe<T extends RecipeInput> {

    /**
    * Provides the registered key for this recipe
    *
    * @return The key the recipe is registered with
    */
    Optional<ResourceKey> key();

    /**
     * Checks if the given inventory fits the required constraints to make a valid recipe
     *
     * @param inventory The inventory to check for validity
     * @param world The world this recipe would be used in
     *
     * @return True if the given input matches this recipe's requirements
     */
    boolean isValid(T inventory, ServerWorld world);

    /**
     * The result of this recipe. This method should only be called if
     * {@link #isValid(RecipeInput, ServerWorld)} returns {@code true}.
     *
     * <p>This method is preferred over the {@link CraftingRecipe#exemplaryResult()} method,
     * as it may customize the result further depending on the context.</p>
     *
     * @param inventory The input inventory
     *
     * @return The result of this recipe
     */
    ItemStackSnapshot result(T inventory);

    /**
     * A general result of this recipe. This result may be customized depending on the context.
     * See {@link #result(RecipeInput)}
     *
     * @return The exemplary result of this recipe
     */
    ItemStackSnapshot exemplaryResult();

    /**
     * The remaining items result of this recipe.
     * This method should only be called if {@link #isValid(RecipeInput, ServerWorld)} returns {@code true}.
     *
     * <p>A list of items to be added to the inventory of the player when they craft the result.
     * For example, if a player crafts a {@link ItemTypes#CAKE}, the empty buckets are returned to
     * their inventory.</p>
     *
     * @param inventory The input inventory
     * @return The list of items to be added to the inventory of the player
     *         when the recipe has been fulfilled (possibly empty)
     */
    List<ItemStackSnapshot> remainingItems(T inventory);

    /**
     * Returns the {@link RecipeResult} for the given inventory and world.
     *
     * <p>Returns {@link Optional#empty()} if the arguments do not satisfy
     * {@link #isValid(RecipeInput, ServerWorld)}.</p>
     *
     * @param inventory The input inventory
     * @param world The world this recipe would be used in
     *
     * @return A {@link RecipeResult} if the arguments satisfy
     *     {@link #isValid(RecipeInput, ServerWorld)}, or
     *     {@link Optional#empty()} if not
     */
    default Optional<RecipeResult> result(T inventory, ServerWorld world) {
        if (this.isValid(inventory, world)) {
            return Optional.of(new RecipeResult(this.result(inventory), this.remainingItems(inventory)));
        }
        return Optional.empty();
    }

    /**
     * Gets the ingredients for this recipe.
     *
     * @return An unmodifiable list of the ingredients.
     */
    List<Ingredient> ingredients();

    /**
     * Returns true if the recipe is dynamic.
     * <p>Dynamic recipes are not displayed in the recipe book.</p>
     *
     * @return Whether this recipe is dynamic.
     */
    boolean isDynamic();

    /**
     * Gets the {@link RecipeType} of this recipe.
     *
     * @return The recipe type.
     */
    RecipeType<? extends Recipe<?>> type();

}