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

方法

clear getPredictedWriteVolume readFromStructure readFromWorld writeToWorld

属性

`只读`id

id: string

`只读`isEmpty

isEmpty: boolean

备注

Return whether there is any block content in the item

`只读`size

方法

clear

clear(): void
世界修改
返回 void
备注
Clear the contents of the item

抛出
This function can throw errors.
- 定义于 @minecraft/server-editor.d.ts:1883

getPredictedWriteVolume

getPredictedWriteVolume(
location: Vector3,
options?: ClipboardWriteOptions,
): RelativeVolumeListBlockVolume
世界修改
参数
- location: Vector3
- 可选options: ClipboardWriteOptions
返回 RelativeVolumeListBlockVolume
备注
抛出
This function can throw errors.
- 定义于 @minecraft/server-editor.d.ts:1890

readFromStructure

readFromStructure(structure: EditorStructure): void
世界修改
参数
- structure: EditorStructure
返回 void
备注
抛出
This function can throw errors.
- 定义于 @minecraft/server-editor.d.ts:1900

readFromWorld

readFromWorld(source: BlockVolumeBase | RelativeVolumeListBlockVolume): void
世界修改
参数
- source: BlockVolumeBase | RelativeVolumeListBlockVolume
返回 void
备注
Copy the contents of a rectangular volume into the Clipboard Item

抛出
This function can throw errors.
- 定义于 @minecraft/server-editor.d.ts:1910

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.
- 定义于 @minecraft/server-editor.d.ts:1931