类 Structure

Represents a loaded structure template (.mcstructure file). Structures can be placed in a world using the /structure command or the StructureManager APIs.

属性

id isValid size

方法

getBlockPermutation getIsWaterlogged saveAs saveToWorld setBlockPermutation

属性

只读id

id: string

备注

The name of the structure. The identifier must include a namespace. For structures created via the /structure command or structure blocks, this namespace defaults to "mystructure".

只读 betaisValid

isValid: boolean

备注

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

只读size

size: Vector3

备注

The dimensions of the structure. For example, a single block structure will have a size of {x:1, y:1, z:1}

抛出

This property can throw when used.

InvalidStructureError

方法

getBlockPermutation

getIsWaterlogged

  • getIsWaterlogged(location: Vector3): 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

saveAs

saveToWorld

setBlockPermutation

  • setBlockPermutation(
        location: Vector3,
        blockPermutation?: BlockPermutation,
        waterlogged?: boolean,
    ): void
    世界修改

    参数

    • location: Vector3

      The block location relative to the Structure's origin.

    • 可选blockPermutation: BlockPermutation

      The BlockPermutation to set.

    • 可选waterlogged: boolean

      Specifies whether the block should be waterlogged. Air and undefined blocks cannot be waterlogged.

    返回 void

    备注

    Sets a BlockPermutation within a Structure.

    抛出

    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

显示设置

成员可见性

目录

属性
方法