Class EditorStructure

Index

Constructors

Properties

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

Methods

getBlockPermutation getIsWaterlogged getTags setBlockPermutation setTags

Constructors

`Private`constructor

new EditorStructure(): EditorStructure
Returns EditorStructure

Properties

`Readonly`description

description: string

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`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`normalizedOrigin

normalizedOrigin: Vector3

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`Readonly`notes

notes: string

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`Readonly`offset

offset: Vector3

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`Readonly`originalWorldLocation

originalWorldLocation: Vector3

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`Readonly`size

size: Vector3

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`Readonly`structureFullName

structureFullName: string

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`Readonly`structureName

structureName: string

Throws

This property can throw when used.

minecraftserver.InvalidStructureError

World Ready

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

`Readonly`structureNamespace

structureNamespace: string

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.

Class EditorStructure

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns EditorStructure

Properties

Readonlydescription

Throws

World Ready

ReadonlydisplayName

Throws

World Ready

Readonlyid

ReadonlyisValid

ReadonlynormalizedOrigin

Throws

World Ready

Readonlynotes

Throws

World Ready

Readonlyoffset

Throws

World Ready

ReadonlyoriginalWorldLocation

Throws

World Ready

Readonlysize

Throws

World Ready

ReadonlystructureFullName

Throws

World Ready

ReadonlystructureName

Throws

World Ready

ReadonlystructureNamespace

Throws

World Ready

Methods

getBlockPermutation

Parameters

Returns BlockPermutation

Throws

World Ready

getIsWaterlogged

Parameters

Returns boolean

Throws

World Ready

getTags

Returns string[]

Throws

World Ready

setBlockPermutation

Parameters

Returns void

Remarks

Write Privilege

Throws

World Ready

setTags

Parameters

Returns void

Remarks

Write Privilege

Throws

World Ready

Settings

On This Page

`Private`constructor

`Readonly`description

`Readonly`displayName

`Readonly`id

`Readonly`isValid

`Readonly`normalizedOrigin

`Readonly`notes

`Readonly`offset

`Readonly`originalWorldLocation

`Readonly`size

`Readonly`structureFullName

`Readonly`structureName

`Readonly`structureNamespace