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       |
|--------------------|--------------------|--------------------|--------------------|

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

block: dirt

ItemsAdder Block

itemsadder-block: ruby_ore

# or
ia-block: ruby_ore

Nexo Block

Furniture is not supported, only blocks.

nexo-block: ruby_ore 

# or
nx-block: ruby_ore

CraftEngine Block

craft-engine-block: default:topaz_ore

# or
ce-block: default:topaz_ore

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

block: wheat
age: 3

Directional

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

block: oak_stairs
direction: north

Axis

Possible values: x, y, z.

block: oak_log
axis: x

Open

block: oak_door
open: true

Half

Possible values: top, bottom.

block: oak_door
half: top

Stairs Shape

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

block: oak_stairs
stair-shape: inner_right

Slab Type

Possible values: top, bottom, double.

block: oak_slab
slab: double 

Door Hinge

Possible values: left, right.

block: oak_door
door-hinge: left

Bed part

Possible values: head, foot.

block: red_bed
bed-part: head

Bamboo Leaves

Possible values: none, small, large.

block: bamboo
bamboo-leaves: small

---

Structure

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

Inline Structure

blocks:   # alias: structure
  - oak_log
  - oak_log offsetY=1
  - oak_log offsetY=2
  - oak_leaves offsetY=3

Custom Blocks

blocks:   # alias: structure
  - itemsAdderBlock=ruby_ore   # alias: iaBlock
  - nexoBlock=ruby_ore offsetY=1   # alias: nxBlock
  - craftEngineBlock=topaz_ore offsetY=2   # alias: ceBlock

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.

structure: structure_name   # The name is the same as <structure-name> used earlier

---

Decorative Blocks

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

decorative-blocks: [oak_leaves, dirt, oak_slab]

# or block format
decorative-block:
  - oak_leaves
  - dirt
  - oak_slab

---

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-items: true   # default is false

Drop Exp

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

drop-exp: true   # default is false

Default Drops

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

default-drops: true   # default is false

---

Idle

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

idle: true

---

Tool Damage

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

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

# fixed amount
tool-damage: 2

# range
tool-damage: 1-3

# random
tool-damage: 1;3;5

---

Growth Time and Chance

Growth Time

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

# hours, minutes, seconds
growth: 3h 12m 3s

# just minutes and seconds
growth: 12m 3s

# just seconds
growth: 3s

# or in ticks
growth: 60

Growth Chance

The chance for the generator to grow into this stage.

chance: 0.5   # 50%

chance: 0.2   # 20%

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.

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

health: 20.0

---

Decreasing Health

You can decrease health with the damageGenerator action.

on-break:
  do: damageGenerator 1-3   # Will do 1 to 3 damage when you break a generator block

# Another example
on-break:
  do: damageGenerator   # If you leave it blank it will use config.yml damage options
                        # i.e. damage-by-tool-type, apply-efficiency, default-damage, etc..

---

Hologram

You can set an hologram for each generator stage.

hologram: {}

Requires DecentHolograms installed.

---

Function Triggers

On Break

Triggered when a generator block is mined.

Decorative blocks are ignored.

on-break:
  # Function 1
  - if-not: blockTypeEquals dirt
    do:
      - sendChat <You can only mine dirt.>
      - cancelEvent   # Cancel the event so the generator stays on this stage
      - stop
  
  # Function 2
  - do: sendChat <You mined dirt.>

---

On Click

Triggered when a generator block is clicked.

Decorative blocks are ignored.

on-click:
  - if-not: clickTypeEquals right_click sneak=true
    do: return
    
  - do: chatMessage <You clicked (Shift + Right Click) this generator.>
    

---

On Growth

Triggered when a generator grows.

on-growth:
  do:
    - spawnParticle some_particle
    - playSound some_sound

---

On Hit

Triggered when a player left-clicks a generator block.

Hits to decorative blocks will be ignored.

on-hit:
  do: sendChat <You hit a generator block.>

Cooldown

hit-cooldown: 7   # The cooldown between each hit

---

On Harvest

Triggered when a player-right clicks a generator block.

---

On Destroy

Triggered once a generator's health reaches 0.

Generator stages without health will not trigger this event.

on-destroy:
  do:
    - giveItem diamond amount=1-3
    - sendChat <Harvesting...>