Recipes
Link to recipes
Recipe Types
Link to recipe-types
There are several types of recipes:
Shaped Recipes
Link to shaped-recipes
Shaped Recipes are recipes, where it matters, which item goes into which slot. For example, you can't just arrange 7 iron ingots in any order to create iron leggings. The shape matters, thus it is a shaped recipe.
Mirrored Recipe
Link to mirrored-recipe
Mirrored Recipes are shaped recipes. Only difference is that the recipe can be mirrored along the horizontal or vertical axes.
Shapeless Recipes
Link to shapeless-recipes
Shapeless Recipes are recipes, where only the items you put in the crafting grid matter, whereas the shape is of no importance. For example, blue and yellow dye create green dye. This recipe doesn't care about where you put which item.
Remove Recipes
Link to remove-recipes
There are several ways of removing recipes.
remove
Link to remove
ZenScript Copyrecipes.remove(output, NBTMatch);
This will crafting table recipes for the given output
.
If NBTMatch
is true, it will only remove recipes that result in items with the same NTB-Data as provided
Output
is an IIngredient.
NBTMatch
is a boolan and optional (Will be the same as false if not specified).
removeShaped
Link to removeshaped
ZenScript Copyrecipes.removeShaped(output, inputs);
This one is more strict on which recipes to remove and will only remove shaped recipes that craft output
with input
.
output
is an IIngredient
inputs
is an IIngredient[][] (e.g.[[iron,iron,iron],[iron,null,iron],[iron,null,iron]])
Furthermore, inputs
is optional. If omitted, the function will do the same as recipe.remove
, though it will only remove shaped Recipes.
inputs
can contain wildcard characters: [[<*>,<*>,<*>],[<*>,<*>,<*>],[<*>,<*>,<*>]]
would refer a recipe whose items, as long as each slot is filled, don't matter.
removeShapeless
Link to removeshapeless
ZenScript Copyrecipes.removeShapeless(output, inputs, wildcard);
This one is more strict on which recipes to remove and will only remove shapeless recipes that craft output
with input
.
If wildcard
is true, it will remove shapeless recipes that craft output
with input
and other, non-specified items (for example you could disable all shapeless recipe that contain, among others, Lapis as ingredient).
output
is an IIngredient
inputs
is an IIngredient[]
wildcard
is a boolan and optional (Will be the same as false if not specified)
Furthermore, inputs
is optional. If omitted, the function will do the same as recipe.remove
, though it will only remove shapeless Recipes.
removeAll
Link to removeall
Removes all crafting recipes in the game.
A bit overkill, don't you think?
ZenScript Copyrecipes.removeAll();
Remove by name
Link to remove-by-name
As 1.12 introduces naming recipes, you can also remove recipes once you know their name. You can also use regex to remove multiple recipes at once. And no, if you don't know what regular expressions are, I won't explain it here!
ZenScript Copyrecipes.removeByRegex("name[1-9]");
recipes.removeByRecipeName("modid:recipename");
Remove by mod
Link to remove-by-mod
You can also remove all recipes that were added by the mod specified.
You need to provide the mod's modid as string.
ZenScript Copyrecipes.removeByMod("modularmachinery");
Remove by input
Link to remove-by-input
Removes all recipes that contain specified ingredient as input
ZenScript Copyrecipes.removeByInput(<minecraft:iron_ingot>);
Add Recipes
Link to add-recipes
Notes On 1.12
Link to notes-on-112
On 1.12, each added recipe requires a UNIQUE identifier, because the forge dev team wanted it that way.
This means, all add functions now require an additional parameter name
at the start (which cannot be omitted).
This means recipe.addShaped(output,input);
now is recipe.addShaped(name,output,input);
All other functionality stay the same. Remember that name
needs to be unique!
name
is a string.
addShaped
Link to addshaped
ZenScript Copy//pre-1.12
recipes.addShaped(output,inputs,function,action);
//1.12
recipes.addShaped(name,output,inputs,function,action);
This creates a shaped recipe for output
using inputs
as Ingredients.
If a function
is added as third parameter, you can also use a function to determinate the output.
If an action
function is added as forth parameter, you can also determine, what will happen, if the item is crafted.
name
is a string and needs to be unique but is also optional output
is an IItemStack
inputs
is an IIngredient[][] (see below)
function
is a IRecipeFunction. Please refer to the respecting wiki entry for more information on functions.
action
is a IRecipeAction. Please refer to the respecting wiki entry for more information on actions.
inputs
is a 2 Dimensional IIngredient Array.
So the recipe for Iron Leggings would be written as [[iron,iron,iron],[iron,null,iron],[iron,null,iron]]
If that looks to confusing, try splitting the arrays up into one array per line
ZenScript Copyval iron = <minecraft:iron_ingot>;
val leggings = <minecraft:iron_leggings>;
recipes.addShaped("CTLeggings", leggings,
[[iron,iron,iron],
[iron,null,iron],
[iron,null,iron]]);
addShapedMirrored
Link to addshapedmirrored
ZenScript Copy//Normal pre 1.12 syntax
recipes.addShapedMirrored(output,inputs,function,action);
//Recommended 1.12 syntax
recipes.addShapedMirrored(name,output,inputs,function,action);
Same as addShaped
, only that the recipe created this way is a mirrored recipe.
addShapeless
Link to addshapeless
ZenScript Copy//Normal pre 1.12 syntax
recipes.addShapeless(output,inputs,function,action)
//Recommended 1.12 syntax
recipes.addShapeless(name,output,inputs,function,action)
This creates a shapeless recipe for output
using inputs
as Ingredients.
If a function
is added as third parameter, you can also use a function to determinate the output.
If an action
function is added as forth parameter, you can also determine, what will happen, if the item is crafted.
name
is a string and needs to be unique output
is an IItemStack
inputs
is an IIngredient[] (e.g. [minecraft:dye:1,minecraft:dye:2])
function
is a IRecipeFunction. Please refer to the respecting wiki entry for more information on functions. This is optional.
action
is a IRecipeAction. Please refer to the respecting wiki entry for more information on actions. This is optional.
addHidden
Link to addhidden
ZenScript CopyaddHiddenShapeless(String name, IItemStack output, IIngredient[] ingredients, @Optional IRecipeFunction function, @Optional IRecipeAction action);
addHiddenShaped(String name, IItemStack output, IIngredient[][] ingredients, @Optional IRecipeFunction function, @Optional IRecipeAction action, @Optional boolean mirrored);
This creates a shapeless recipe for output
using inputs
as Ingredients that is named name
.
If a function
is added as third parameter, you can also use a function to determinate the output.
If an action
function is added as forth parameter, you can also determine, what will happen, if the item is crafted.
For the shapeless variant you can also set if the recipe is mirrored
, if omitted, it will not.
Other Functionality
Link to other-functionality
Get all registered Crafting recipes.
Link to get-all-registered-crafting-recipes
You can use this to get a List<ICraftingRecipe>
that contains ALL registered crafting recipes.
Copyrecipes.all;
Get all recipes for a given IIngredient
Link to get-all-recipes-for-a-given-iingredient
You can use this to get a List<ICraftingRecipe>
that contains ALL registered crafting recipes for the given IIngredient.
Copy//recipes.getRecipesFor(IIngredient ingredient);
recipes.getRecipesFor(<minecraft:iron_ingot>);
Replace all item ingredients with another one
Link to replace-all-item-ingredients-with-another-one
You can use this to replace all ingredients in a recipe with another one, for example all sticks with stones. It also accepts an optional third parameter that matches agains the recipe outputs. If the recipe
Copy//recipes.replaceAllOccurences(IIngredient toReplace, IIngredient replaceWith, @Optional IIngredient forOutput);
//replaces every stick with stone
recipes.replaceAllOccurences(<minecraft:stick>, <minecraft:stone>);
//Explicitly uses any output, replaces gold ingots with gold blocks
recipes.replaceAllOccurences(<ore:ingotGold>, <ore:blockGold>, <*>);
//Only replaces in recipes with a diamond_sword as output
recipes.replaceAllOccurences(<ore:gemDiamond>, <ore:blockDiamond>, <minecraft:diamond_sword>);
//conditions work as well -> replaces in recipes for any recipe output except tnt
recipes.replaceAllOccurences(<ore:gunpowder>, <minecraft:tnt>, <*>.only(function(item) {
return !isNull(item) & !<minecraft:tnt>.matches(item);
}));
Craft
Link to craft
You can even craft from inside recipes
! The function will return an IItemStack or null
depending if a recipe is found or not.
Copy//recipes.craft(IItemStack[][]content);
recipes.craft([[<minecraft:iron_ingot>]]);