Class Structure

Index

Constructors

Properties

id isValid size

Methods

getBlockPermutation getIsWaterlogged saveAs saveToWorld setBlockPermutation

Constructors

`Private`constructor

new Structure(): Structure
Returns Structure

Properties

`Readonly`id

id: string

`Readonly`isValid

isValid: boolean

`Readonly`size

Throws

This property can throw errors.

InvalidStructureError

World Ready

This property can't be read in early-execution mode.

Methods

getBlockPermutation

getBlockPermutation(location: Vector3): BlockPermutation
Parameters
- location: Vector3
Returns BlockPermutation
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.InvalidArgumentError

InvalidStructureError

World Ready
This function can't be called in early-execution mode.

getIsWaterlogged

getIsWaterlogged(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.InvalidArgumentError

InvalidStructureError

World Ready
This function can't be called in early-execution mode.

saveAs

saveAs(identifier: string, saveMode?: StructureSaveMode): Structure
Parameters
- identifier: string
- OptionalsaveMode: StructureSaveMode
  Defaults to: 1
Returns Structure
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.EngineError

minecraftcommon.InvalidArgumentError

InvalidStructureError

World Ready
This function can't be called in early-execution mode.

saveToWorld

saveToWorld(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

InvalidStructureError

World Ready
This function can't be called in early-execution mode.

setBlockPermutation

setBlockPermutation(
    location: Vector3,
    blockPermutation?: BlockPermutation,
    waterlogged?: boolean,
): void
Parameters
- location: Vector3
- OptionalblockPermutation: BlockPermutation
- Optionalwaterlogged: boolean
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.InvalidArgumentError

InvalidStructureError

World Ready
This function can't be called in early-execution mode.