For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/classes/EditorStructure.md.

Class: EditorStructure experimental

Beta

Properties

description

readonly description: string

Beta

Throws

This property can throw when used.

InvalidStructureError


displayName

readonly displayName: string

Beta

Throws

This property can throw when used.

InvalidStructureError


id

readonly id: string

Beta


isValid

readonly isValid: boolean

Beta


normalizedOrigin

readonly normalizedOrigin: Vector3

Beta

Throws

This property can throw when used.

InvalidStructureError


notes

readonly notes: string

Beta

Throws

This property can throw when used.

InvalidStructureError


offset

readonly offset: Vector3

Beta

Throws

This property can throw when used.

InvalidStructureError


originalWorldLocation

readonly originalWorldLocation: Vector3

Beta

Throws

This property can throw when used.

InvalidStructureError


size

readonly size: Vector3

Beta

Throws

This property can throw when used.

InvalidStructureError


structureFullName

readonly structureFullName: string

Beta

Throws

This property can throw when used.

InvalidStructureError


structureName

readonly structureName: string

Beta

Throws

This property can throw when used.

InvalidStructureError


structureNamespace

readonly structureNamespace: string

Beta

Throws

This property can throw when used.

InvalidStructureError

Methods

getBlockPermutation()

getBlockPermutation(location): any

Beta

Parameters

location

Vector3

Returns

any

Throws

This function can throw errors.

InvalidArgumentError

InvalidStructureError


getIsWaterlogged()

getIsWaterlogged(location): boolean

Beta

Parameters

location

Vector3

Returns

boolean

Throws

This function can throw errors.

InvalidArgumentError

InvalidStructureError


getTags()

getTags(): string[]

Beta

Returns

string[]

Throws

This function can throw errors.

InvalidStructureError


setBlockPermutation()

setBlockPermutation(location, blockPermutation, waterlogged?): void

World Mutation Beta

Parameters

location

Vector3

blockPermutation

BlockPermutation

waterlogged?

boolean

Defaults to: false

Returns

void

Remarks

Throws

This function can throw errors.

InvalidArgumentError

InvalidStructureError


setTags()

setTags(tags): void

World Mutation Beta

Parameters

tags

string[]

Returns

void

Remarks

Throws

This function can throw errors.

InvalidStructureError