SmithingRecipeManager - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
 Copy
import crafttweaker.api.recipe.SmithingRecipeManager;

Implemented Interfaces

SmithingRecipeManager implements the following interfaces. That means all methods defined in these interfaces are also available in SmithingRecipeManager

IRecipeManager<SmithingRecipe>

Methods

addJsonRecipe

Name: addJsonRecipe

Adds a recipe based on a provided IData. The provided IData should represent a DataPack json, this effectively allows you to register recipes for any DataPack supporting RecipeType systems.

ZenScript
 Copy
// SmithingRecipeManager.addJsonRecipe(name as string, mapData as MapData)

smithing.addJsonRecipe("recipe_name", {
 ingredient: <item:minecraft:gold_ore>,
 result: <item:minecraft:cooked_porkchop>.registryName,
 experience: 0.35 as float,
 cookingtime:100
 });

Parameter	Type	Description
Parameter name	Type string	Description name of the recipe
Parameter mapData	Type MapData	Description data representing the json file

addTransformRecipe

Name: addTransformRecipe

Adds a new transform recipe to the smithing table.

ZenScript
 Copy
SmithingRecipeManager.addTransformRecipe(recipeName as string, result as IItemStack, template as IIngredient, base as IIngredient, addition as IIngredient)

Parameter	Type	Description
Parameter recipeName	Type string	Description Name of the recipe.
Parameter result	Type IItemStack	Description The item created by the recipe.
Parameter template	Type IIngredient	Description The template to use.
Parameter base	Type IIngredient	Description The initial ingredient for the recipe.
Parameter addition	Type IIngredient	Description The item added to the base item.

addTrimRecipe

Name: addTrimRecipe

Adds a new trim recipe to the smithing table.

ZenScript
 Copy
SmithingRecipeManager.addTrimRecipe(recipeName as string, template as IIngredient, base as IIngredient, addition as IIngredient)

Parameter	Type	Description
Parameter recipeName	Type string	Description Name of the recipe.
Parameter template	Type IIngredient	Description The template to use.
Parameter base	Type IIngredient	Description The initial ingredient for the recipe.
Parameter addition	Type IIngredient	Description The item added to the base item.

getRecipeByName

Name: getRecipeByName

Return Type: RecipeHolder<T>?

ZenScript
 Copy
SmithingRecipeManager.getRecipeByName(name as string) as RecipeHolder<T>?

Parameter	Type
Parameter name	Type string

getRecipeMap

Name: getRecipeMap

Returns a map of all known recipes.

Returns: A Map of recipe name to recipe of all known recipes.
Return Type: RecipeHolder<T>[ResourceLocation]

ZenScript
 Copy
// SmithingRecipeManager.getRecipeMap() as RecipeHolder<T>[ResourceLocation]

smithing.getRecipeMap();

getRecipesByOutput

Name: getRecipesByOutput

Return Type: stdlib.List<RecipeHolder<T>>

ZenScript
 Copy
SmithingRecipeManager.getRecipesByOutput(output as IIngredient) as stdlib.List<RecipeHolder<T>>

Parameter	Type
Parameter output	Type IIngredient

getRecipesMatching

Name: getRecipesMatching

Return Type: stdlib.List<RecipeHolder<T>>

ZenScript
 Copy
SmithingRecipeManager.getRecipesMatching(predicate as Predicate<RecipeHolder<T>>) as stdlib.List<RecipeHolder<T>>

Parameter	Type
Parameter predicate	Type Predicate<RecipeHolder<T>>

remove

Name: remove

Remove a recipe based on it's output.

ZenScript
 Copy
// SmithingRecipeManager.remove(output as IIngredient)

smithing.remove(<tag:items:minecraft:wool>);

Parameter	Type	Description
Parameter output	Type IIngredient	Description output of the recipe

removeAll

Name: removeAll

Remove all recipes in this registry

ZenScript
 Copy
// SmithingRecipeManager.removeAll()

smithing.removeAll();

removeByInput

Name: removeByInput

Removes all recipes where the input contains the given IItemStack.

ZenScript
 Copy
// SmithingRecipeManager.removeByInput(input as IItemStack)

smithing.removeByInput(<item:minecraft:iron_ingot>);

Parameter	Type	Description
Parameter input	Type IItemStack	Description The input IItemStack.

removeByModid

Name: removeByModid

Remove recipe based on Registry name modid

ZenScript
 Copy
SmithingRecipeManager.removeByModid(modid as string, exclude as Predicate<string>)

Parameter	Type	Description	Optional	Default Value
Parameter modid	Type string	Description modid of the recipes to remove	Optional false	Default Value
Parameter exclude	Type Predicate<string>	Description	Optional true	Default Value (name as string) as bool => false

removeByName

Name: removeByName

Remove recipes based on Registry names

ZenScript
 Copy
SmithingRecipeManager.removeByName(names as string[])

Parameter	Type	Description
Parameter names	Type string[]	Description registry names of recipes to remove

removeByRegex

Name: removeByRegex

Remove recipe based on regex with an added exclusion check, so you can remove the whole mod besides a few specified.

ZenScript
 Copy
// SmithingRecipeManager.removeByRegex(regex as string, exclude as Predicate<string>)

smithing.removeByRegex("\\d_\\d", (name as string) => {return name == "orange_wool";});

Parameter	Type	Description	Optional	Default Value
Parameter regex	Type string	Description regex to match against	Optional false	Default Value
Parameter exclude	Type Predicate<string>	Description	Optional true	Default Value (name as string) as bool => false

removeMatching

Name: removeMatching

Removes all recipes that match the given predicate

ZenScript
 Copy
// SmithingRecipeManager.removeMatching(predicate as Predicate<RecipeHolder<T>>)

smithing.removeMatching((holder) => "wool" in holder.id.path);

Parameter	Type	Description
Parameter predicate	Type Predicate<RecipeHolder<T>>	Description a predicate of RecipeHolder to test recipes against.

Properties

Name	Type	Has Getter	Has Setter	Description
Name allRecipes	Type stdlib.List<RecipeHolder<T>>	Has Getter true	Has Setter false	Description
Name recipeMap	Type RecipeHolder<T>[ResourceLocation]	Has Getter true	Has Setter false	Description Returns a map of all known recipes.