RecipeFunction.java

/*
 * Copyright (c) 2015 NOVA, All rights reserved.
 * This library is free software, licensed under GNU Lesser General Public License version 3
 *
 * This file is part of NOVA.
 *
 * NOVA is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * NOVA is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with NOVA.  If not, see <http://www.gnu.org/licenses/>.
 */package nova.core.recipes.crafting;

import nova.core.item.Item;
import nova.core.item.ItemFactory;

import java.util.Map;
import java.util.Optional;

/**
 * Created by Stan on 31/01/2015.
 */
@FunctionalInterface
public interface RecipeFunction {

	/**
	 * Do the crafting.
	 *
	 * @param craftingGrid The crafting grid.
	 * @param taggedIngredients The ingredients.
	 * @param output The factory of the output.
	 * @return The new item, or an empty optional, if the custom implementation
	 * of the crafting prohibits this specific crafting task.
	 */
	Optional<Item> doCrafting(CraftingGrid craftingGrid, Map<String, Item> taggedIngredients, ItemFactory output);
}