Class EditorStructureManager

Index

Constructors

Methods

createEmpty createFromClipboardItem deleteStructure getExistingTags getStructure searchStructures

Constructors

`Private`constructor

new EditorStructureManager(): EditorStructureManager

Returns EditorStructureManager

Methods

createEmpty

createEmpty(fullName: string, size: Vector3): EditorStructure
Parameters
- fullName: string
- size: Vector3
Returns EditorStructure

Remarks

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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

createFromClipboardItem

createFromClipboardItem(item: ClipboardItem, fullName: string): EditorStructure
Parameters
- item: ClipboardItem
- fullName: string
Returns EditorStructure

Remarks

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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

deleteStructure

deleteStructure(id: string): void
Parameters
- id: string
Returns void

Remarks

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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

getExistingTags

getExistingTags(): string[]

Returns string[]

Remarks

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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

getStructure

getStructure(id: string): EditorStructure
Parameters
- id: string
Returns EditorStructure

Remarks

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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

searchStructures

searchStructures(options?: EditorStructureSearchOptions): EditorStructure[]
Parameters
- Optionaloptions: EditorStructureSearchOptions
Returns EditorStructure[]

Remarks

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

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