Class ClipboardItem

Index

Constructors

Properties

id isEmpty normalizedOrigin originalWorldLocation size

Methods

clear getPredictedWriteVolume readFromStructure readFromWorld writeToWorld

Constructors

`Private`constructor

new ClipboardItem(): ClipboardItem
Returns ClipboardItem

Properties

`Readonly`id

id: string

`Readonly`isEmpty

isEmpty: boolean

`Readonly`normalizedOrigin

normalizedOrigin: Vector3

`Readonly`originalWorldLocation

originalWorldLocation: Vector3

`Readonly`size

Methods

clear

clear(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

getPredictedWriteVolume

getPredictedWriteVolume(
location: Vector3,
options?: ClipboardWriteOptions,
): RelativeVolumeListBlockVolume
Parameters
- location: Vector3
- Optionaloptions: ClipboardWriteOptions
Returns RelativeVolumeListBlockVolume
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

readFromStructure

readFromStructure(structure: EditorStructure): void
Parameters
- structure: EditorStructure
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

readFromWorld

readFromWorld(source: BlockVolumeBase | RelativeVolumeListBlockVolume): void
Parameters
- source: BlockVolumeBase | RelativeVolumeListBlockVolume
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

writeToWorld

writeToWorld(location: Vector3, options?: ClipboardWriteOptions): boolean
Parameters
- location: Vector3
- Optionaloptions: ClipboardWriteOptions
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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