Home Commands Examples Getting Started With Scripts Global Keywords
Generic Recipe Manipulation

CuttingBoard

Farmer’s Delight Cutting Board recipes.

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.

script.zs
import mods.farmersdelight.CuttingBoard;

Implemented Interfaces

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

Methods

script.zs
CuttingBoard.addJsonRecipe(name as string, mapData as MapData)
ParameterType
Parameter
name
Type
string
Parameter
mapData
Type
MapData

Add a cutting board recipe. The tool ingredient can be a ToolAction. It will get cast implicitly. This allows you to work with any tool that provides that action to Forge.

script.zs
// CuttingBoard.addRecipe(name as string, input as IIngredient, results as Percentaged<IItemStack>[], tool as IIngredient, sound as string)
<recipetype:farmersdelight:cutting>.addRecipe("cutting_board_test", <item:minecraft:gravel>, [<item:minecraft:flint>], <item:minecraft:string>, "minecraft:block.gravel.break");
ParameterTypeDescriptionOptional
Parameter
name
Type
string
Description
Name of the recipe to add
Optional
false
Parameter
input
Type
IIngredient
Description
Input ingredient
Optional
false
Parameter
results
Type
Percentaged<IItemStack>[]
Description
Output items
Optional
false
Parameter
tool
Type
IIngredient
Description
Tool ingredient
Optional
false
Parameter
sound
Type
string
Description
Sound event name
Optional
true

Return Type: stdlib.List<T>

script.zs
// CuttingBoard.getAllRecipes() as stdlib.List<T>
<recipetype:farmersdelight:cutting>.getAllRecipes();

Return Type: T

script.zs
CuttingBoard.getRecipeByName(name as string) as T
ParameterType
Parameter
name
Type
string

Return Type: T[ResourceLocation]

script.zs
// CuttingBoard.getRecipeMap() as T[ResourceLocation]
<recipetype:farmersdelight:cutting>.getRecipeMap();

Return Type: stdlib.List<T>

script.zs
CuttingBoard.getRecipesByOutput(output as IIngredient) as stdlib.List<T>
ParameterType
Parameter
output
Type
IIngredient
script.zs
CuttingBoard.remove(output as IIngredient)
ParameterType
Parameter
output
Type
IIngredient
script.zs
// CuttingBoard.removeAll()
<recipetype:farmersdelight:cutting>.removeAll();
script.zs
CuttingBoard.removeByInput(input as IItemStack)
ParameterType
Parameter
input
Type
IItemStack
script.zs
CuttingBoard.removeByModid(modid as string, exclude as Predicate<string>)
ParameterTypeOptionalDefault Value
Parameter
modid
Type
string
Optional
false
Default Value
Parameter
exclude
Type
Predicate<string>
Optional
true
Default Value
(name as string) as bool => false
script.zs
CuttingBoard.removeByName(names as string[])
ParameterType
Parameter
names
Type
string[]
script.zs
CuttingBoard.removeByRegex(regex as string, exclude as Predicate<string>)
ParameterTypeOptionalDefault Value
Parameter
regex
Type
string
Optional
false
Default Value
Parameter
exclude
Type
Predicate<string>
Optional
true
Default Value
(name as string) as bool => false

Remove a cutting board recipe with multiple outputs.

script.zs
// CuttingBoard.removeRecipe(outputs as IItemStack[])
<recipetype:farmersdelight:cutting>.removeRecipe([<item:farmersdelight:cooked_salmon_slice> * 2, <item:minecraft:bone_meal>]);
ParameterTypeDescription
Parameter
outputs
Type
IItemStack[]
Description
Output items

Properties

NameTypeHas GetterHas Setter
Name
allRecipes
Type
stdlib.List<T>
Has Getter
true
Has Setter
false
Name
recipeMap
Type
T[ResourceLocation]
Has Getter
true
Has Setter
false