Class ClipboardItem

A ClipboardItem is a handle to an object which represents a set of blocks in a contained bounding area (most likely copied from the world)

Hierarchy

  • ClipboardItem

Constructors

constructor

Properties

id isEmpty size

Methods

clear getPredictedWriteVolume readFromStructure readFromWorld writeToWorld

Constructors

Private constructor

Properties

Readonly id

id: string

Readonly isEmpty

isEmpty: boolean

Remarks

Return whether there is any block content in the item

Readonly size

size: Vector3

Methods

clear

  • Returns void

    Remarks

    Clear the contents of the item

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

getPredictedWriteVolume

readFromStructure

  • Parameters

    Returns void

    Remarks

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

readFromWorld

  • Parameters

    Returns void

    Remarks

    Copy the contents of a rectangular volume into the Clipboard Item

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

writeToWorld

  • Parameters

    • location: Vector3

      The root point of the world location to which the ClipboardItem is written (this is modified by the various anchor, offset and rotation parameters of the ClipboardWriteOptions

    • Optional options: ClipboardWriteOptions

      An optional set of write parameters which modify the properties of the ClipboardItem as it is applied to the world

    Returns boolean

    Success or Failure

    Remarks

    Apply the contents of a ClipboardItem to the world at a given location using a set of write options

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

    Error

Settings

Member Visibility

Theme

On This Page