Class EditorStructure

Index

Constructors

Properties

displayName id isValid size

Methods

getBlockPermutation getIsWaterlogged getTags setBlockPermutation setTags

Constructors

`Private`constructor

new EditorStructure(): EditorStructure
Returns EditorStructure

Properties

`Readonly`displayName

displayName: string

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`Readonly`id

id: string

`Readonly`isValid

isValid: boolean

`Readonly`size

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

Methods

getBlockPermutation

getBlockPermutation(location: Vector3): BlockPermutation
Parameters
- location: Vector3
Returns BlockPermutation
Throws
This function can throw errors.

minecraftcommon.InvalidArgumentError

minecraftserver.InvalidStructureError

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

getIsWaterlogged

getIsWaterlogged(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Throws
This function can throw errors.

minecraftcommon.InvalidArgumentError

minecraftserver.InvalidStructureError

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

getTags

getTags(): string[]
Returns string[]
Throws
This function can throw errors.

minecraftserver.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
- blockPermutation: BlockPermutation
- Optionalwaterlogged: boolean
  Defaults to: false
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.InvalidArgumentError

minecraftserver.InvalidStructureError

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

setTags

setTags(tags: string[]): void
Parameters
- tags: string[]
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftserver.InvalidStructureError

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