Skip to content

STRUCTURE_TARGET.md

Latest commit

 

History

History
80 lines (52 loc) · 2.56 KB

STRUCTURE_TARGET.md

File metadata and controls

80 lines (52 loc) · 2.56 KB

Structure Target

--target structure emits a Minecraft structure file (.nbt) containing command blocks loaded with the compiled output. This is useful when you want to place the compiler output directly in-world with a Structure Block or /place structure, instead of copying loose command blocks by hand.

Workflow

Compile a source file into a raw structure NBT:

redscript compile --target structure src/examples/arena.mcrs -o arena.nbt

Then copy the generated file into your datapack's structures/ folder, for example:

world/datapacks/my_pack/structures/arena.nbt

After reloading the datapack, place it in-game:

/place structure my_pack:arena ~ ~ ~

You can also preview and load the same file with a Structure Block.

Layout

Each non-comment, non-blank line from each generated .mcfunction file becomes one command block. Blocks are laid out eastward, then wrapped row-by-row in a snake-friendly grid with a maximum width of 16.

Layer Y=0

[0,0,0] [1,0,0] [2,0,0] ... [15,0,0]
[0,0,1] [1,0,1] [2,0,1] ... [15,0,1]
[0,0,2] [1,0,2] [2,0,2] ... [15,0,2]

Palette usage:

  • Impulse command block: first command in a non-tick function
  • Chain command block: subsequent commands in the same function
  • Repeating command block: first command in __tick, with auto: 1b

Optimizations

The structure target runs an extra optimization pass after normal IR optimization. It rewrites simple control flow into native command block chaining so the placed structure can branch without extra helper functions.

Conditional chain blocks:

  • A plain chain command block always runs after the previous block.
  • A conditional chain command block runs only if the previous block succeeded.
  • RedScript uses this to flatten small if / else bodies directly into the chain.

Before:

execute if score $cond rs matches 1.. run function demo:test/then_0

After:

execute if score $cond rs matches 1..
say big
give @s diamond

The first command block is unconditional. The following inlined blocks are emitted as conditional chain command blocks, so they run only when the guard succeeds.

Inlining threshold:

  • RedScript inlines small branch targets up to 8 commands.
  • Larger branches still fall back to helper function calls.

Limitations

  • Minecraft structures are practical only up to roughly 32k placed blocks before they become awkward to manage.
  • Individual command block commands are still limited to 32767 characters.
  • The structure target serializes command blocks only; it does not gzip the output.