类 Structure实验性

只读 实验性id

只读 实验性size

getBlockPermutation

• getBlockPermutation(location): BlockPermutation
• 实验性

  参数

  • location: Vector3

    The block location relative to the Structure's origin.

  返回 BlockPermutation

  Returns a BlockPermutation. Returns undefined if a block does not exist at the given location.

  备注

  Returns a BlockPermutation representing the block contained within the Structure at the given location.

  抛出

  Throws if the location is outside the structure's bounds. Throws if the Structure has been deleted.

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

getIsWaterlogged

• getIsWaterlogged(location): boolean
• 实验性

  参数

  • location: Vector3

    The block location relative to the Structure's origin.

  返回 boolean

  Returns whether the block at the given location is waterlogged. Returns false if a block does not exist at the given location.

  备注

  Returns whether the block at the given location is waterlogged.

  抛出

  Throws if the location is outside the structure's bounds. Throws if the Structure has been deleted.

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

isValid

• isValid(): boolean
• 实验性

  返回 boolean

  Returns whether the Structure is valid.

  备注

  Returns whether the Structure is valid. The Structure may become invalid if it is deleted.

saveAs

• saveAs(identifier, saveMode?): Structure
• 实验性

  参数

  • identifier: string

    The name of the newly created Structure.
  • 可选saveMode: StructureSaveMode

    Determines how the Structure should be saved. Defaults to saving to the world.

  返回 Structure

  Returns the newly created structure.

  备注

  Creates a copy of a Structure and saves it with a new name.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  Throws if the identifier is invalid. A valid identifier must include a namespace and must be unique. Throws if the Structure has been deleted.

  minecraftcommon.EngineError

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

saveToWorld

• saveToWorld(): void
• 实验性

  返回 void

  备注

  Saves a modified Structure to the world file.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  Throws if the Structure has been deleted.

  InvalidStructureError

setBlockPermutation

• setBlockPermutation(location, blockPermutation?): void
• 实验性

  参数

  • location: Vector3

    The block location relative to the Structure's origin.
  • 可选blockPermutation: BlockPermutation

    The BlockPermutation to set.

  返回 void

  备注

  Sets a BlockPermutation within a Structure.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  Throws if the type of block is StructureVoid. Throws if the block is undefined and waterlogged is set to true. Throws if the block is air and waterlogged is set to true. Throws if the location is outside the structure's bounds. Throws if the Structure has been deleted.

  minecraftcommon.InvalidArgumentError

  InvalidStructureError