Crafting Recipe (Selection GUI Crafting)

Description

Creates a recipe that is shown in the specified category. Each recipe requires at least an input and output. There can also be an optional input for either hand. The recipe can have its own frame, sounds, particles, progress bar, can specify how the sounds are played, if the recipe can be added to the crafting queue, how the output items are handed to the player, how much durability is consumed if the tool is a damageable item, the crafting time, and how much XP is rewarded. Most of these have a fallback to the category settings.

Identifier

Refer to this via any of the following:

mods.selectionguicrafting.recipe/* Used as page default */
mods.selectionguicrafting.Recipe

Adding Recipes

• Adds a new recipe:

  mods.selectionguicrafting.recipe.add(Recipe)

Recipe Builder

Just like other recipe types, the Crafting Recipe 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.selectionguicrafting.recipe.recipeBuilder()

---

• Integer. The amount of XP that will be granted to the player when the recipe is crafted. Requires greater than or equal to 0. (Default 0).

  xp(int)

• Integer. The time in ticks it takes to craft the recipe. Requires greater than or equal to 0. (Default 20).

  time(int)

• ResourceLocation. The path to the frame texture. Overrides the category frame. Textures that come with the mod. (Default selectionguicrafting:textures/gui/frame/default.png).

  frame(String)
  frame(ResourceLocation)

• RecipeInput. The input items that are required to craft the recipe. Input refers to the offhand item. You can add multiple inputs each with a different amount. The int value is the damage applied to the item, the double value is the chance the item will be damaged / consumed. Requires greater than or equal to 0.

  input(IIngredient)
  input(RecipeInput)
  input(Collection<?>)
  input(IIngredient...)
  input(RecipeInput...)
  input(IIngredient, int)
  input(IIngredient, double)
  input(IIngredient, double, int)

• String. The skills required to craft the recipe. (Requires: Reskillable).

  skill(String, int)

• Sound. The sounds that will be played when the recipe is crafted. Overrides the category sounds. The first float value is the volume, the second float value is the pitch of the sound.

  sound(Sound)
  sound(String)
  sound(SoundEvent)
  sound(ResourceLocation)
  sound(String, float, float)
  sound(SoundEvent, float, float)
  sound(ResourceLocation, float, float)

• RecipeOutput. The output items that will be given to the player. You can add multiple outputs each with a different chance. The double value is the chance of the item being dropped. Requires greater than or equal to 1.

  output(ItemStack)
  output(ItemStack...)
  output(RecipeOutput)
  output(Collection<?>)
  output(RecipeOutput...)
  output(ItemStack, double)

• String. The commands to execute after crafting the recipe.

  command(String)
  command(String...)

• RecipeInput. The offhand input that will be used to craft the recipe. The int value is the damage applied to the item, the double value is the chance the item will be damaged / consumed. Requires greater than or equal to 0 and less than or equal to 1.

  offhand(IIngredient)
  offhand(RecipeInput)
  offhand(IIngredient, int)
  offhand(IIngredient, double)
  offhand(IIngredient, double, int)

• String. The category that the recipe belongs to. Requires not null and the category must exist.

  category(String)

• RecipeInput. The mainhand input that will be used to craft the recipe. The int value is the damage applied to the item, the double value is the chance the item will be damaged / consumed. Requires greater than or equal to 0 and less than or equal to 1.

  mainhand(IIngredient)
  mainhand(RecipeInput)
  mainhand(IIngredient, int)
  mainhand(IIngredient, double)
  mainhand(IIngredient, double, int)

• Particle. The particles that will be spawned when the recipe is crafted. Overrides the category particles. The int value is the amount of particles, the float value is the speed of the particles.

  particle(String)
  particle(Particle)
  particle(EnumParticleTypes)
  particle(String, int, float)
  particle(EnumParticleTypes, int, float)

• String. The game stages required to craft the recipe. (Requires: Game Stages).

  gamestage(String)
  gamestage(String...)

• QueueType. If the recipe can be queued. Overrides the category queueable. Allowed values are either: true, false or YES, NO.

  queueable(String)
  queueable(boolean)
  queueable(QueueType)

• SoundType. How the sounds will be played. Overrides the category soundType. Allowed values are: RANDOM or COMBINED.

  soundType(String)
  soundType(SoundType)

• OutputType. How the output will be handed to the player. Overrides the category outputType. Allowed values are: DROP or INVENTORY.

  outputType(String)
  outputType(OutputType)

• ResourceLocation. The advancements required to craft the recipe.

  advancement(String)
  advancement(String...)
  advancement(ResourceLocation)
  advancement(ResourceLocation...)

• ResourceLocation. The path to the progress bar texture. Overrides the category progressBar. Textures that come with the mod. (Default selectionguicrafting:textures/gui/progress/default.png).

  progressBar(String)
  progressBar(ResourceLocation)

---

• 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 io.enderdev.selectionguicrafting.registry.recipe.Recipe).

  register()

---

Example

mods.selectionguicrafting.recipe.recipeBuilder()
    .category('dummy_category')
    .input(item('minecraft:stone') * 3)
    .output(item('minecraft:cobblestone') * 2, 0.5)
    .time(200)
    .xp(1)
    .sound('minecraft:block.anvil.land', 1.0f, 1.0f)
    .register()

mods.selectionguicrafting.recipe.recipeBuilder()
    .category('blub')
    .input(item('minecraft:diamond'))
    .output(item('minecraft:wheat_seeds') * 5, 0.5)
    .register()

mods.selectionguicrafting.recipe.recipeBuilder()
    .category('dummy_category')
    .input(item('minecraft:stone') * 32)
    .output(item('minecraft:diamond') * 50, 0.5)
    .output(item('minecraft:clay') * 2, 0.1)
    .time(200)
    .xp(10)
    .sound('minecraft:block.anvil.land', 1.0f, 1.0f)
    .register()

mods.selectionguicrafting.recipe.recipeBuilder()
    .category('dead')
    .input(item('minecraft:wheat_seeds') * 3)
    .output(item('minecraft:sand') * 2)
    .time(40)
    .queueable(false)
    .outputType('DROP')
    .xp(100)
    .register()

mods.selectionguicrafting.recipe.recipeBuilder()
    .category('dead')
    .input(item('minecraft:stick') * 3)
    .output(item('minecraft:sand') * 2)
    .frame('selectionguicrafting:textures/gui/frame/iron.png')
    .time(40)
    .queueable(false)
    .command('kill @p')
    .register()

Removing Recipes

• Removes the given recipe:

  mods.selectionguicrafting.recipe.remove(Recipe)

• Remove all recipes in a category:

  mods.selectionguicrafting.recipe.removeByCategory(String)

• Removes all recipes that match the given input:

  mods.selectionguicrafting.recipe.removeByInput(IIngredient)

• Removes all recipes that match the given output:

  mods.selectionguicrafting.recipe.removeByOutput(IIngredient)

• Removes all registered recipes:

  mods.selectionguicrafting.recipe.removeAll()

Example

mods.selectionguicrafting.recipe.removeByCategory('dummy_category')
mods.selectionguicrafting.recipe.removeByInput(item('minecraft:cobblestone'))
mods.selectionguicrafting.recipe.removeByOutput(item('minecraft:stone'))
mods.selectionguicrafting.recipe.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.selectionguicrafting.recipe.streamRecipes()

Contributors

MasterEnderman

Last edited 3 minutes ago

View full history

ca13516-Update Selection GUI Crafting docs for v3.0.0 rewrite (#37)

233e477-Docs for SelectionGUI Crafting (#32)