api

APIs

Also see note for better understanding.

Function Tags

These APIs are function tags. Add your functions into these tags.

#block-morph:api/create/start

Triggered when starting the creation of the structure, regardless of whether the targeted block is valid.

Execution Context:

Context	Value
Executor	The player who creates the structure
Dimension	The player's current dimension
Position	The position of the player
Rotation	The rotation of the player
Anchor	feet

---

#block-morph:api/create/loop

Triggered during post-updates for valid blocks in the structure, immediately before removing the blocks. Each block update triggers this tag once. Invalid blocks will not respond.

Execution Context:

Context	Value
Executor	Player (1st update) / Block displays or item displays (subsequent updates)
Dimension	The player's current dimension
Position	The position of the block
Rotation	The rotation of the player
Anchor	feet

---

#block-morph:api/create/finish

Triggered when finishing the creation of the structure. Will not trigger if the targeted block is invalid.

Execution Context:

Context	Value
Executor	The player who creates the structure
Dimension	The player's current dimension
Position	The position of the player
Rotation	The rotation of the player
Anchor	feet

---

#block-morph:api/blockify/start

Triggered when starting to transform the structure into blocks.

Execution Context:

Context	Value
Executor	The player who blockifies the structure
Dimension	The player's current dimension
Position	The position of the player
Rotation	The rotation of the player
Anchor	feet

---

#block-morph:api/blockify/loop

Triggered during blockifying the structure, immediately after placing the blocks. Each block/item display triggers this tag once.

Execution Context:

Context	Value
Executor	Block display or item display
Dimension	The root's current dimension
Position	The position of the root
Rotation	The rotation of the root
Anchor	feet

---

#block-morph:api/blockify/finish

Triggered when finishing blockifying the structure.

Execution Context:

Context	Value
Executor	The player who creates the structure
Dimension	The player's current dimension
Position	The position of the player
Rotation	The rotation of the player
Anchor	feet

Block Tags

These APIs are block tags. Add new blocks into these tags.

#block-morph:structure_disallowed

Blocks that are invalid in structures. Most of them are commmon in a normal world.

---

#block-morph:tinted

Blocks that will transform into item displays instead of block displays.

Blocks that will use tinted models.

Note: you still need to define an overridden item model mappings for that block. You can check Python scripts in the resourcepack branch.

Predicates

These APIs are predicates. Call them directly as needed.

block-morph:is_in_morph

Check whether the player is morphed.