类 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)

属性

id isEmpty

方法

clear getPredictedWriteAsCompoundBlockVolume getPredictedWriteAsSelection getSize readFromSelection readFromStructure readFromWorld writeToWorld

属性

只读id

id: string

只读isEmpty

isEmpty: boolean

备注

Return whether there is any block content in the item

抛出

This property can throw when used.

方法

clear

getPredictedWriteAsCompoundBlockVolume

getPredictedWriteAsSelection

  • getPredictedWriteAsSelection(
        location: Vector3,
        options?: ClipboardWriteOptions,
    ): Selection
    世界修改

    参数

    • location: Vector3

      A world location to which the ClipboardItem may potentially be written (nothing is actually written as part of this operation)

    • 可选options: ClipboardWriteOptions

      An optional set of write parameters which govern how the ClipboardItem should be potentially applied to the world

    返回 Selection

    A Selection which represents the occupied block volumes within the ClipboardItem as they would be written to the world with the specified ClipboardWriteOptions

    备注

    Create a Selection container which represents the occupied block volumes within the ClipboardItem. This function does not perform any write operations, and instead returns only a prediction of the volume area which would be affected as part of a write operation with a given set of write options.

    抛出

    This function can throw errors.

getSize

readFromSelection

  • readFromSelection(selection: Selection): void
    世界修改

    参数

    • selection: Selection

      A volume which represents the area to be copied

    返回 void

    备注

    Copy the contents of the area represented by a Selection volume into the ClipboardItem

    抛出

    This function can throw errors.

readFromStructure

readFromWorld

  • readFromWorld(from: Vector3, to: Vector3): void
    世界修改

    参数

    • from: Vector3

      The world location of one corner of a bounding volume

    • to: Vector3

      The world location of the opposite corner of a bounding volume

    返回 void

    备注

    Copy the contents of a rectangular volume into the Clipboard Item

    抛出

    This function can throw errors.

writeToWorld

  • writeToWorld(location: Vector3, options?: ClipboardWriteOptions): boolean
    世界修改

    参数

    • 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

    • 可选options: ClipboardWriteOptions

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

    返回 boolean

    Success or Failure

    备注

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

    抛出

    This function can throw errors.

显示设置

成员可见性

目录

属性
方法