Generator

Phase

A phase is a part of a generator containing all the logic such as growth-time, drops, block or structure, etc..

Type

There are 5 phase types and each one has it's own behavior.

|--------------------|--------------------|--------------------|--------------------|
|                    |       Mineable     |    Transitional    |        Grows       |
|--------------------|--------------------|--------------------|--------------------|
|      Depleted      |        false       |        false       |        true        |
|      Growing       |        false       |        true        |        true        |
|      Unripe        |        true        |        true        |        true        |
|      Ripe          |        true        |        false       |        true        |
|      Regrown       |        true        |        false       |        false       |
|--------------------|--------------------|--------------------|--------------------|
circle-info

A transitional phase only appears when the generator is growing but not when it is being harvested. It is a mechanic used to create growth animations for your generators i.e. wheat growing.

type: depleted

Block

You can define a block with many options for each generator stage.

Simple Block

ItemsAdder Block

Nexo Block

circle-info

Furniture is not supported, only blocks.

CraftEngine Block

Ageable

Sets the age of crop-like blocks. At 0 the block will be at it's first age.

Possible values: cocoa: 0-2 beetroot: 0-3 melon: 0-5 pumpkin: 0-5 wheat: 0-7 potato: 0-7 carrot: 0-7

Directional

Possible values: north, east, south, west, up, down.

Axis

Possible values: x, y, z.

Open

Half

Possible values: top, bottom.

Stairs Shape

Possible values: straight, inner_left, inner_right, outer_left, outer_right.

Slab Type

Possible values: top, bottom, double.

Door Hinge

Possible values: left, right.

Bed part

Possible values: head, foot.

Bamboo Leaves

Possible values: none, small, large.


Structure

You can define a structure if you need more than one block.

Inline Structure

Custom Blocks

Custom Structure

You can save custom structures in-game. Grab the wand with /orestack wand, select two positions and execute /orestack structure save <file-name> <structure-name>. Now your structure is ready to use.


Decorative Blocks

You can define a list of blocks that will only act as decoration. Will not drop items or run functions when harvested.


Item & Exp Drops

You can define default item and exp drops so that generators behave vanilla like.

Drop Items

If set to true, when this generator stage is harvested it will drop default items.

Drop Exp

if set to true, when this generator stage is harvested it will drop default exp.

Default Drops

If set to true, when this generator stage is harvested it will drop default exp and items.


Idle

You can define a generator as idle so that it does not switch stage automatically when a generator block is mined.


Tool Damage

Define the damage done to a tool when a player mines a generator block.

circle-info

The default tool damage is 1 and can be changed inside the config.yml


Growth Time and Chance

Growth Time

The time this stage takes to grow into the next one.

Growth Chance

The chance for the generator to grow into this stage.

circle-info

If you change the stage type to regrown, and specify a chance, then if the chance is true the generator will grow into the stage and stay there until harvested instead of keep growing.


Health

You can define health as an alternative way to harvest generator, once the health reaches 0 the generator will move to the previous stage.

circle-info

If you specify the health parameter the generator will be forced into idle mode.


Decreasing Health

You can decrease health with the damageGenerator action.


Hologram

You can set an hologram for each generator stage.

circle-info

Requires DecentHolograms installed.


Function Triggers

On Break

Triggered when a generator block is mined.

circle-info

Decorative blocks are ignored.


On Click

Triggered when a generator block is clicked.

circle-info

Decorative blocks are ignored.


On Growth

Triggered when a generator grows.


On Hit

Triggered when a player left-clicks a generator block.

circle-info

Hits to decorative blocks will be ignored.

Cooldown


On Harvest

Triggered when a player-right clicks a generator block.


On Destroy

Triggered once a generator's health reaches 0.

circle-info

Generator stages without health will not trigger this event.

Last updated