Straw (Industrial Foregoing)

Description

Converts an fluid block in-world into various effects for the player when consumed via a straw.

Identifier

Refer to this via any of the following:

mods.industrialforegoing.straw/* Used as page default */
mods.industrialforegoing.Straw

Adding Recipes

• Adds a Straw recipe in the format fluidInput, effect:

  mods.industrialforegoing.straw.add(FluidStack, Collection<PotionEffect>)

• Adds a Straw recipe in the format name, fluidInput, effect:

  mods.industrialforegoing.straw.add(String, FluidStack, Collection<PotionEffect>)

• Adds the recipe:

  mods.industrialforegoing.straw.add(StrawHandler)

Recipe Builder

Just like other recipe types, the Straw 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.industrialforegoing.straw.recipeBuilder()

---

• ResourceLocation. Sets the Resource Location of the recipe.

  name(String)
  name(ResourceLocation)

• FluidStackList. Sets the fluid inputs of the recipe. Requires exactly 1.

  fluidInput(FluidStack)
  fluidInput(FluidStack...)
  fluidInput(Collection<FluidStack>)

• Collection<PotionEffect>. Sets what potion effects are given upon consuming the fluid. Requires greater than or equal to 1.

  effect(PotionEffect)
  effect(PotionEffect...)
  effect(Collection<PotionEffect>)

---

• 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.buuz135.industrial.api.straw.StrawHandler).

  register()

---

Example

mods.industrialforegoing.straw.recipeBuilder()
    .fluidInput(fluid('if.pink_slime'))
    .effect(new PotionEffect(potion('minecraft:strength'), 1800, 3))
    .register()

Removing Recipes

• Removes the recipe with the given Resource Location:

  mods.industrialforegoing.straw.remove(ResourceLocation)

• Removes the recipe with the given String as its Resource Location:

  mods.industrialforegoing.straw.remove(String)

• Removes the recipe:

  mods.industrialforegoing.straw.remove(StrawHandler)

• Removes all registered recipes:

  mods.industrialforegoing.straw.removeAll()

Example

mods.industrialforegoing.straw.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.industrialforegoing.straw.streamRecipes()

Contributors

Waiting Idly

Last edited 3 months ago

View full history

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

8f2e8fa-Update Vanilla Registry Documentation (#36)

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

481224d-GroovyScript Improvements (#12)

a278ffd-update docs for GroovyScript 1.1.0 (#11)