Excavator (Immersive Engineering)

Description

Adds a Mineral Mix with the given name, weight, fail chance, ores, and allowed dimensions. A Mineral Mix can be mined by an Excavator Multiblock and scanned via a Core Sample Drill.

Warning

Reloading will not change chunks already 'discovered'.

Identifier

The identifier mods.immersiveengineering.excavator will be used as the default on this page.

All Identifiers

Any of these can be used to refer to this compat:

mods.ie.excavator
mods.ie.Excavator
mods.immersiveengineering.excavator/* Used as page default */
mods.immersiveengineering.Excavator

Adding Entries

• Adds entries in the format name, mineralWeight, failChance, ores, chances:

  mods.immersiveengineering.excavator.add(String, int, float, String[], float[])

Recipe Builder

Just like other recipe types, the Excavator 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.immersiveengineering.excavator.recipeBuilder()

---

• float. Sets the chance that a given mining attempt with output nothing instead of an ore. Requires greater than or equal to 0 and less than or equal to 1. (Default 0.0f).

  fail(float)

• String. Sets the unique name of the vein.

  name(String)

• List<String>. Sets the valid oredicts output. Requires exactly equal to the number of elements in ores.

  ore(String, float)
  ore(OreDictIngredient, float)

• int. Sets the weight the Mineral Mix has to spawn in its allowed dimensions. (Default 0).

  weight(int)

• FloatArrayList. Sets the chance a given block output will contain the corresponding entry in ores. Requires exactly equal to the number of elements in chances.

  ore(String, float)
  ore(OreDictIngredient, float)

• boolean. Sets if the dimensions property indicates allowed dimensions (false) or blocked dimensions (true). (Default false).

  blacklist()
  blacklist(boolean)

• List<Integer>. Sets the list of dimension ids the vein can generate in (if blacklist is false) or are prevented from generating in (if blacklist is true).

  dimension(int)
  dimension(int...)
  dimension(Collection<Integer>)

---

• 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 blusunrize.immersiveengineering.api.tool.ExcavatorHandler$MineralMix).

  register()

---

Example

mods.immersiveengineering.excavator.recipeBuilder()
    .name('demo')
    .weight(20000)
    .fail(0.5)
    .ore(ore('blockDiamond'), 50)
    .ore('blockGold', 10)
    .dimension(0, 1)
    .register()

mods.immersiveengineering.excavator.recipeBuilder()
    .name('demo')
    .weight(2000)
    .fail(0.1)
    .ore(ore('blockDiamond'), 50)
    .dimension(-1, 1)
    .blacklist()
    .register()

Removing Entries

• Removes all Mineral Mix entries containing any of the given ores:

  mods.immersiveengineering.excavator.removeByOres(String...)

• Removes all Mineral Mix entries containing any of the given ores:

  mods.immersiveengineering.excavator.removeByOres(OreDictIngredient...)

• Removes the Mineral Mix entry with the given name:

  mods.immersiveengineering.excavator.removeByMineral(String)

• Removes all registered recipes:

  mods.immersiveengineering.excavator.removeAll()

Example

mods.immersiveengineering.excavator.removeByOres(ore('oreAluminum'))
mods.immersiveengineering.excavator.removeByMineral('silt')
mods.immersiveengineering.excavator.removeAll()

Getting the value of entries

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

  mods.immersiveengineering.excavator.streamRecipes()

Contributors

Waiting Idly Nullpinter

Last edited 9 minutes ago

View full history

044601a-update docs for GroovyScript 1.3.2 (#54)

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

e6f31de-update docs for GroovyScript 1.2.0 (#24)

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

481224d-GroovyScript Improvements (#12)

a278ffd-update docs for GroovyScript 1.1.0 (#11)

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