Private constructorThe name of the structure. A valid identifier must include a namespace and must be unique.
The size of the structure. For example, to create a single block structure the size should be {x:1, y:1, z:1}.
Optional saveMode: StructureSaveModeHow the Structure should be saved upon creation. Defaults to StructureSaveMode.Memory.
Returns the newly created Structure.
Creates an empty Structure in memory. Use setBlockPermutation to populate the structure with blocks and save changes with saveAs.
This function can't be called in read-only mode.
Throws if the identifier is invalid. A valid identifier must include a namespace and must be unique.
minecraftcommon.EngineError
minecraftcommon.InvalidArgumentError
The name of the structure. A valid identifier must include a namespace and must be unique.
The dimension where the blocks should be read from.
Optional options: StructureCreateOptionsAdditional options for creating a structure from the world.
Returns the newly created Structure.
Creates a new Structure from blocks in the world. This is functionally equivalent to the /structure save command.
This function can't be called in read-only mode.
Throws if the identifier is invalid. A valid identifier must include a namespace and must be unique. Throws if the structure bounds exceed the maximum size. Throws if the structure bounds contains blocks outside the world bounds.
minecraftcommon.InvalidArgumentError
The structure identifier or Structure object that should be deleted. Note, a Structure object will become invalid after it is deleted.
Returns whether the structure was removed.
Deletes a structure from memory and from the world if it exists.
This function can't be called in read-only mode.
Throws if a structure cannot be removed. For example, a structure loaded from a Behavior Pack.
minecraftcommon.InvalidArgumentError
The structure's identifier or a Structure object.
The dimension where the Structure should be placed.
The location within the dimension where the Structure should be placed.
Optional options: StructurePlaceOptionsAdditional options for Structure placement.
Places a structure in the world. Structures placed in unloaded chunks will be queued for loading.
This function can't be called in read-only mode.
Throws if the integrity value is outside of the range [0,1] Throws if the integrity seed is invalid. Throws if the placement location contains blocks that are outside the world bounds.
minecraftcommon.ArgumentOutOfBoundsError
minecraftcommon.InvalidArgumentError
Beta
The identifier of the template pool to start from.
The name of the jigsaw block to start from. This block must be included in at least one of the starting pool structure templates.
The maximum recursion depth for the jigsaw structure.
The dimension to place the jigsaw structure in.
The location where the jigsaw structure will begin generating relative to the targetJigsaw block.
Optional options: JigsawPlaceOptionsOptional settings to use when generating the jigsaw structure.
Places a partial jigsaw structure in the world. This is useful for debugging connections between jigsaw blocks.
This function can't be called in read-only mode.
Throws if maxDepth is outside of the range [1,20] Throws if generation fails due to invalid parameters or jigsaw configuration. Throws if the placement location contains blocks that are outside the world bounds.
Beta
The identifier of the jigsaw structure.
The dimension to place the jigsaw structure in.
The location where the jigsaw structure will begin generating. Note that the y value will be overridden by the structure's start height unless the ignoreStarJigsawStructurePlaceOptions ignoreStartHeight option is set.
Optional options: JigsawStructurePlaceOptionsOptional settings to use when generating the jigsaw structure.
Places a jigsaw structure in the world.
This function can't be called in read-only mode.
Throws if generation fails due to invalid parameters or jigsaw configuration. Throws if the placement location contains blocks that are outside the world bounds.
Manager for Structure related APIs. Includes APIs for creating, getting, placing and deleting Structures.