类 StructureManager

Manager for Structure related APIs. Includes APIs for creating, getting, placing and deleting Structures.

索引

方法

createEmpty createFromWorld delete get getWorldStructureIds place placeJigsaw placeJigsawStructure

方法

createEmpty

createEmpty(
    identifier: string,
    size: Vector3,
    saveMode?: StructureSaveMode,
): Structure
世界修改
参数
- identifier: string
  The name of the structure. A valid identifier must include a namespace and must be unique.
- size: Vector3
  The size of the structure. For example, to create a single block structure the size should be {x:1, y:1, z:1}.
- 可选saveMode: StructureSaveMode
  How the Structure should be saved upon creation. Defaults to StructureSaveMode.Memory. Defaults to: 0
返回 Structure
Returns the newly created Structure.

备注
Creates an empty Structure in memory. Use Structure.setBlockPermutation to populate the structure with blocks and save changes with Structure.saveAs.

抛出
Throws if the identifier is invalid. A valid identifier must include a namespace and must be unique.

minecraftcommon.EngineError

minecraftcommon.InvalidArgumentError
- 定义于 @minecraft/server.d.ts:17226

createFromWorld

createFromWorld(
    identifier: string,
    dimension: Dimension,
    from: Vector3,
    to: Vector3,
    options?: StructureCreateOptions,
): Structure
世界修改
参数
- identifier: string
  The name of the structure. A valid identifier must include a namespace and must be unique.
- dimension: Dimension
  The dimension where the blocks should be read from.
- from: Vector3
- to: Vector3
- 可选options: StructureCreateOptions
  Additional options for creating a structure from the world.
返回 Structure
Returns the newly created Structure.

备注
Creates a new Structure from blocks in the world. This is functionally equivalent to the /structure save command.

抛出
Throws if the identifier is invalid. A valid identifier must include a namespace and must be unique. Throws if the structure bounds exceed the maximum size. Throws if the structure bounds contains blocks outside the world bounds.

minecraftcommon.InvalidArgumentError
- 定义于 @minecraft/server.d.ts:17253

delete

delete(structure: string | Structure): boolean
世界修改
参数
- structure: string | Structure
  The structure identifier or Structure object that should be deleted. Note, a Structure object will become invalid after it is deleted.
返回 boolean
Returns whether the structure was removed.

备注
Deletes a structure from memory and from the world if it exists.

抛出
Throws if a structure cannot be removed. For example, a structure loaded from a Behavior Pack.

minecraftcommon.InvalidArgumentError
- 定义于 @minecraft/server.d.ts:17279

get

get(identifier: string): Structure
世界修改
参数
- identifier: string
  The name of the structure to get.
返回 Structure
Returns a Structure if it exists, otherwise undefined.

备注
Gets a Structure that is saved to memory or the world.
- 定义于 @minecraft/server.d.ts:17291

getWorldStructureIds

getWorldStructureIds(): string[]
世界修改
返回 string[]
备注
- 定义于 @minecraft/server.d.ts:17297

place

place(
    structure: string | Structure,
    dimension: Dimension,
    location: Vector3,
    options?: StructurePlaceOptions,
): void
世界修改
参数
- structure: string | Structure
  The structure's identifier or a Structure object.
- dimension: Dimension
  The dimension where the Structure should be placed.
- location: Vector3
  The location within the dimension where the Structure should be placed.
- 可选options: StructurePlaceOptions
  Additional options for Structure placement.
返回 void
备注
Places a structure in the world. Structures placed in unloaded chunks will be queued for loading.

抛出
Throws if the integrity value is outside of the range [0,1] Throws if the integrity seed is invalid. Throws if the placement location contains blocks that are outside the world bounds.

minecraftcommon.ArgumentOutOfBoundsError

minecraftcommon.InvalidArgumentError

InvalidStructureError
- 定义于 @minecraft/server.d.ts:17326

placeJigsaw

placeJigsaw(
    pool: string,
    targetJigsaw: string,
    maxDepth: number,
    dimension: Dimension,
    location: Vector3,
    options?: JigsawPlaceOptions,
): BlockBoundingBox
世界修改
参数
- pool: string
  The identifier of the template pool to start from.
- targetJigsaw: string
  The name of the jigsaw block to start from. This block must be included in at least one of the starting pool structure templates.
- maxDepth: number
  The maximum recursion depth for the jigsaw structure.
- dimension: Dimension
  The dimension to place the jigsaw structure in.
- location: Vector3
  The location where the jigsaw structure will begin generating relative to the targetJigsaw block.
- 可选options: JigsawPlaceOptions
  Optional settings to use when generating the jigsaw structure.
返回 BlockBoundingBox
Returns a BlockBoundingBox object which represents the maximum bounds of the jigsaw structure.

备注
Places a partial jigsaw structure in the world. This is useful for debugging connections between jigsaw blocks.

抛出
Throws if maxDepth is outside of the range [1,20] Throws if generation fails due to invalid parameters or jigsaw configuration. Throws if the placement location contains blocks that are outside the world bounds.

PlaceJigsawError
- 定义于 @minecraft/server.d.ts:17367

placeJigsawStructure

placeJigsawStructure(
    identifier: string,
    dimension: Dimension,
    location: Vector3,
    options?: JigsawStructurePlaceOptions,
): BlockBoundingBox
世界修改
参数
- identifier: string
  The identifier of the jigsaw structure.
- dimension: Dimension
  The dimension to place the jigsaw structure in.
- location: Vector3
  The location where the jigsaw structure will begin generating. Note that the y value will be overridden by the structure's start height unless the ignoreStarJigsawStructurePlaceOptions ignoreStartHeight option is set.
- 可选options: JigsawStructurePlaceOptions
  Optional settings to use when generating the jigsaw structure.
返回 BlockBoundingBox
Returns a BlockBoundingBox object which represents the maximum bounds of the jigsaw structure.

备注
Places a jigsaw structure in the world.

抛出
Throws if generation fails due to invalid parameters or jigsaw configuration. Throws if the placement location contains blocks that are outside the world bounds.

PlaceJigsawError
- 定义于 @minecraft/server.d.ts:17405

类 StructureManager

索引

方法

方法

createEmpty

参数

返回 Structure

备注

抛出

createFromWorld

参数

返回 Structure

备注

抛出

delete

参数

返回 boolean

备注

抛出

get

参数

返回 Structure

备注

getWorldStructureIds

返回 string[]

备注

place

参数

返回 void

备注

抛出

placeJigsaw

参数

返回 BlockBoundingBox

备注

抛出

placeJigsawStructure

参数

返回 BlockBoundingBox

备注

抛出

显示设置

目录