Animal Harvest Fish (Roots 3)

Description

Animal Harvest Fish is another effect of the Animal Harvest ritual that applies if there are water source blocks within the ritual range.

Identifier

Refer to this via any of the following:

mods.roots.animal_harvest_fish/* Used as page default */
mods.roots.animalharvestfish
mods.roots.animalHarvestFish
mods.roots.AnimalHarvestFish

Adding Recipes

Recipe Builder

Just like other recipe types, the Animal Harvest Fish also uses a recipe builder.

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

mods.roots.animal_harvest_fish.recipeBuilder()

• ResourceLocation. Sets the Resource Location of the recipe.

  name(String)
  name(ResourceLocation)

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

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

• int. Sets the weight of the recipe to generate. Requires greater than 0. (Default 0).

  weight(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 epicsquid.roots.recipe.AnimalHarvestFishRecipe).

  register()

Example

mods.roots.animal_harvest_fish.recipeBuilder()
    .name('clay_fish')
    .weight(50)
    .output(item('minecraft:clay'))
    .register()

mods.roots.animal_harvest_fish.recipeBuilder()
    .weight(13)
    .fish(item('minecraft:gold_ingot'))
    .register()

Removing Recipes

• Removes any Animal Harvest Fish recipe with the given fish output:

  mods.roots.animal_harvest_fish.removeByFish(ItemStack)

• Removes the Animal Harvest Fish recipe with the given name:

  mods.roots.animal_harvest_fish.removeByName(ResourceLocation)

• Removes any Animal Harvest Fish recipe with the given output:

  mods.roots.animal_harvest_fish.removeByOutput(ItemStack)

• Removes all registered recipes:

  mods.roots.animal_harvest_fish.removeAll()

Example

mods.roots.animal_harvest_fish.removeByFish(item('minecraft:fish:2'))
mods.roots.animal_harvest_fish.removeByName(resource('roots:cod'))
mods.roots.animal_harvest_fish.removeByOutput(item('minecraft:fish:1'))
mods.roots.animal_harvest_fish.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.roots.animal_harvest_fish.streamRecipes()

Contributors

Waiting Idly Nullpinter

Changelog

Last edited 3 months ago

View full history

481224d-GroovyScript Improvements (#12)

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