Class EditorStructure

Index

Properties

description displayName id isValid normalizedOrigin notes offset originalWorldLocation size structureFullName structureName structureNamespace

Methods

getBlockPermutation getIsWaterlogged getTags setBlockPermutation setTags

Properties

`Readonly`description

description: string

Throws

InvalidStructureError

`Readonly`displayName

displayName: string

Throws

InvalidStructureError

`Readonly`id

id: string

`Readonly`isValid

isValid: boolean

`Readonly`normalizedOrigin

normalizedOrigin: Vector3

Throws

InvalidStructureError

`Readonly`notes

notes: string

Throws

InvalidStructureError

`Readonly`offset

offset: Vector3

Throws

InvalidStructureError

`Readonly`originalWorldLocation

originalWorldLocation: Vector3

Throws

InvalidStructureError

`Readonly`size

Throws

InvalidStructureError

`Readonly`structureFullName

structureFullName: string

Throws

InvalidStructureError

`Readonly`structureName

structureName: string

Throws

InvalidStructureError

`Readonly`structureNamespace

structureNamespace: string

Throws

InvalidStructureError

Methods

getBlockPermutation

getBlockPermutation(location: Vector3): BlockPermutation
Parameters
- location: Vector3
Returns BlockPermutation

Throws
InvalidArgumentError

Throws
InvalidStructureError
- Defined in @minecraft/server-editor.d.ts:3618

getIsWaterlogged

getIsWaterlogged(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean

Throws
InvalidArgumentError

Throws
InvalidStructureError
- Defined in @minecraft/server-editor.d.ts:3624

getTags

getTags(): string[]
Returns string[]

Throws
InvalidStructureError
- Defined in @minecraft/server-editor.d.ts:3628

setBlockPermutation

setBlockPermutation(
    location: Vector3,
    blockPermutation: BlockPermutation,
    waterlogged?: boolean,
): void
World mutation
Parameters
- location: Vector3
- blockPermutation: BlockPermutation
- Optionalwaterlogged: boolean
  Defaults to: false
Returns void

Remarks

Throws
InvalidArgumentError

Throws
InvalidStructureError
- Defined in @minecraft/server-editor.d.ts:3639

setTags

setTags(tags: string[]): void
World mutation
Parameters
- tags: string[]
Returns void

Remarks

Throws
InvalidStructureError
- Defined in @minecraft/server-editor.d.ts:3650