WorkBench (Armor Plus)

Description

A normal crafting recipe, but with a 3x3 grid and in the WorkBench.

Identifier

Refer to this via any of the following:

mods.armorplus.work_bench/* Used as page default */
mods.armorplus.workbench
mods.armorplus.workBench
mods.armorplus.WorkBench

Adding Recipes

• Add the given recipe to the recipe list:

  mods.armorplus.work_bench.add(R)

Recipe Builder

Just like other recipe types, the WorkBench also uses a recipe builder.

Don't know what a builder is? Check the builder info page out.

Recipe Builder

---

• Create the Recipe Builder.

  mods.armorplus.work_bench.shapedBuilder()

---

• ResourceLocation. Sets the Resource Location of the recipe.

  name(String)
  name(ResourceLocation)

• String[]. Sets the items required in each slot of the grid as char. Requires either the key-based matrix or the ingredient-based matrix can be defined, not both.

  row(String)
  shape(String...)
  matrix(String...)

• List<List<IIngredient>>. Sets the items required in each slot in the grid as IIngredients. Requires greater than or equal to 1, less than or equal to 9, and either the key-based matrix or the ingredient-based matrix can be defined, not both.

  shape(List<List<IIngredient>>)
  matrix(List<List<IIngredient>>)

• Char2ObjectOpenHashMap<IIngredient>. Sets the item the given char corresponds to. (Default ' ' = IIngredient.EMPTY).

  key(char, IIngredient)
  key(String, IIngredient)
  key(Map<String, IIngredient>)

• ItemStack. Sets the item output. Requires not null.

  output(ItemStack)

• boolean. Sets if the recipe is horizontally mirrored. (Default false).

  mirrored()
  mirrored(boolean)

• Closure<ItemStack>. Sets an operation that modifies the input items or output item.

  recipeFunction(Closure<ItemStack>)

• Closure<Void>. Sets an operation that happens when the recipe is crafted.

  recipeAction(Closure<Void>)

---

• First validates the builder, returning null and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returns null or com.sofodev.armorplus.api.crafting.IRecipe).

  register()

Recipe Builder

---

• Create the Recipe Builder.

  mods.armorplus.work_bench.shapedBuilder()

---

• ResourceLocation. Sets the Resource Location of the recipe.

  name(String)
  name(ResourceLocation)

• String[]. Sets the items required in each slot of the grid as char. Requires either the key-based matrix or the ingredient-based matrix can be defined, not both.

  row(String)
  shape(String...)
  matrix(String...)

• List<List<IIngredient>>. Sets the items required in each slot in the grid as IIngredients. Requires greater than or equal to 1, less than or equal to 9, and either the key-based matrix or the ingredient-based matrix can be defined, not both.

  shape(List<List<IIngredient>>)
  matrix(List<List<IIngredient>>)

• Char2ObjectOpenHashMap<IIngredient>. Sets the item the given char corresponds to. (Default ' ' = IIngredient.EMPTY).

  key(char, IIngredient)
  key(String, IIngredient)
  key(Map<String, IIngredient>)

• ItemStack. Sets the item output. Requires not null.

  output(ItemStack)

• boolean. Sets if the recipe is horizontally mirrored. (Default false).

  mirrored()
  mirrored(boolean)

• Closure<ItemStack>. Sets an operation that modifies the input items or output item.

  recipeFunction(Closure<ItemStack>)

• Closure<Void>. Sets an operation that happens when the recipe is crafted.

  recipeAction(Closure<Void>)

---

• First validates the builder, returning null and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returns null or com.sofodev.armorplus.api.crafting.IRecipe).

  register()

---

Example

mods.armorplus.work_bench.shapedBuilder()
    .output(item('minecraft:stone') * 8)
    .matrix('BXX')
    .mirrored()
    .key('B', item('minecraft:stone'))
    .key('X', item('minecraft:gold_ingot'))
    .register()

Recipe Builder

---

• Create the Recipe Builder.

  mods.armorplus.work_bench.shapelessBuilder()

---

• ResourceLocation. Sets the Resource Location of the recipe.

  name(String)
  name(ResourceLocation)

• List<IIngredient>. Sets the items required for the recipe. Requires greater than or equal to 1 and less than or equal to 9.

  input(IIngredient)
  input(IIngredient...)
  input(Collection<IIngredient>)

• ItemStack. Sets the item output. Requires not null.

  output(ItemStack)

• Closure<ItemStack>. Sets an operation that modifies the input items or output item.

  recipeFunction(Closure<ItemStack>)

• Closure<Void>. Sets an operation that happens when the recipe is crafted.

  recipeAction(Closure<Void>)

---

• First validates the builder, returning null and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returns null or com.sofodev.armorplus.api.crafting.IRecipe).

  register()

Recipe Builder

---

• Create the Recipe Builder.

  mods.armorplus.work_bench.shapelessBuilder()

---

• ResourceLocation. Sets the Resource Location of the recipe.

  name(String)
  name(ResourceLocation)

• List<IIngredient>. Sets the items required for the recipe. Requires greater than or equal to 1, less than or equal to 9, and either the key-based matrix or the ingredient-based matrix can be defined, not both.

  input(IIngredient)
  input(IIngredient...)
  input(Collection<IIngredient>)

• ItemStack. Sets the item output. Requires not null.

  output(ItemStack)

• Closure<ItemStack>. Sets an operation that modifies the input items or output item.

  recipeFunction(Closure<ItemStack>)

• Closure<Void>. Sets an operation that happens when the recipe is crafted.

  recipeAction(Closure<Void>)

---

• First validates the builder, returning null and outputting errors to the log file if the validation failed, then registers the builder and returns the registered object. (returns null or com.sofodev.armorplus.api.crafting.IRecipe).

  register()

---

Example

mods.armorplus.work_bench.shapelessBuilder()
    .output(item('minecraft:clay') * 8)
    .input(item('minecraft:stone'), item('minecraft:stone'), item('minecraft:stone'))
    .register()

Removing Recipes

• Removes the given recipe from the recipe list:

  mods.armorplus.work_bench.remove(R)

• Removes all recipes that match the given output:

  mods.armorplus.work_bench.removeByOutput(IIngredient)

• Removes all registered recipes:

  mods.armorplus.work_bench.removeAll()

Example

mods.armorplus.work_bench.removeByOutput(item('armorplus:the_gift_of_the_gods'))
mods.armorplus.work_bench.removeAll()

Getting the value of recipes

• Iterates through every entry in the registry, with the ability to call remove on any element to remove it:

  mods.armorplus.work_bench.streamRecipes()

Contributors

Waiting Idly Nullpinter

Last edited 8 minutes ago

View full history

e9cab59-update docs for GroovyScript 1.3.0 (#52)

80c153e-update docs for GroovyScript 1.2.4 (#38)

e6f31de-update docs for GroovyScript 1.2.0 (#24)

481224d-GroovyScript Improvements (#12)

a278ffd-update docs for GroovyScript 1.1.0 (#11)

70357c1-docs(en): migrate grs docs (#2)