Hydrator (Cyclic)

Description

Converts up to 4 input itemstacks and some amount of water into an output itemstack.

Identifier

Refer to this via any of the following:

mods.cyclicmagic.hydrator/* Used as page default */
mods.cyclicmagic.Hydrator
mods.cyclic.hydrator
mods.cyclic.Hydrator

Adding Recipes

• Add the given recipe to the recipe list:

  mods.cyclicmagic.hydrator.add(RecipeHydrate)

Recipe Builder

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

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

mods.cyclicmagic.hydrator.recipeBuilder()

• IngredientList<IIngredient>. Sets the item inputs of the recipe. Requires greater than or equal to 1 and less than or equal to 6.

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

• ItemStackList. Sets the item outputs of the recipe. Requires exactly 1.

  output(ItemStack)
  output(ItemStack...)
  output(Collection<ItemStack>)

• int. Sets the amount of water consumed by the Hydrator to complete a recipe. Requires greater than or equal to 0. (Default 25).

  water(int)

• 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.lothrazar.cyclicmagic.block.hydrator.RecipeHydrate).

  register()

Example

mods.cyclicmagic.hydrator.recipeBuilder()
    .input(item('minecraft:gold_ingot'))
    .output(item('minecraft:clay'))
    .register()

mods.cyclicmagic.hydrator.recipeBuilder()
    .input(ore('logWood'), ore('sand'), ore('gravel'), item('minecraft:diamond'))
    .output(item('minecraft:clay') * 8)
    .water(100)
    .register()

Removing Recipes

• Removes the given recipe from the recipe list:

  mods.cyclicmagic.hydrator.remove(RecipeHydrate)

• Removes all recipes that match the given input:

  mods.cyclicmagic.hydrator.removeByInput(IIngredient)

• Removes all recipes that match the given output:

  mods.cyclicmagic.hydrator.removeByOutput(IIngredient)

• Removes all registered recipes:

  mods.cyclicmagic.hydrator.removeAll()

Example

mods.cyclicmagic.hydrator.removeByInput(item('minecraft:dirt'))
mods.cyclicmagic.hydrator.removeByOutput(item('minecraft:clay_ball'))
mods.cyclicmagic.hydrator.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.cyclicmagic.hydrator.streamRecipes()

Contributors

Waiting Idly Nullpinter

Changelog

Last edited 2 months ago

View full history

e6f31de-update docs for GroovyScript 1.2.0 (#24)

172cf3f-update docs for GroovyScript 1.1.2 (#18)

481224d-GroovyScript Improvements (#12)

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