Skip to content

@minecraft/server


@minecraft/server / StructurePlaceOptions

Interface: StructurePlaceOptions ​

Defined in: @minecraft/server/index.d.ts:24816

Provides additional options for StructureManager.place

Properties ​

animationMode? ​

optional animationMode?: StructureAnimationMode

Defined in: @minecraft/server/index.d.ts:24822

Remarks ​

How the Structure should be animated when placed.


animationSeconds? ​

optional animationSeconds?: number

Defined in: @minecraft/server/index.d.ts:24828

Remarks ​

How many seconds the animation should take.


includeBlocks? ​

optional includeBlocks?: boolean

Defined in: @minecraft/server/index.d.ts:24835

Remarks ​

Whether blocks should be included in the structure. Defaults to true.


includeEntities? ​

optional includeEntities?: boolean

Defined in: @minecraft/server/index.d.ts:24842

Remarks ​

Whether entities should be included in the structure. Defaults to true.


integrity? ​

optional integrity?: number

Defined in: @minecraft/server/index.d.ts:24851

Remarks ​

What percentage of blocks should be placed. A value of 1 will place 100% of the blocks while a value of 0 will place none. The blocks are chosen randomly based on the StructurePlaceOptions.integritySeed.


integritySeed? ​

optional integritySeed?: string

Defined in: @minecraft/server/index.d.ts:24858

Remarks ​

Seed that determines which blocks are randomly chosen to be placed. Defaults to a random seed.


mirror? ​

optional mirror?: StructureMirrorAxis

Defined in: @minecraft/server/index.d.ts:24865

Remarks ​

Which axes the Structure should be mirrored on when placed. Defaults to StructureMirrorAxis.None.


rotation? ​

optional rotation?: StructureRotation

Defined in: @minecraft/server/index.d.ts:24872

Remarks ​

How the Structure should be rotated when placed. Defaults to AxisAlignedRotation.None.


waterlogged? ​

optional waterlogged?: boolean

Defined in: @minecraft/server/index.d.ts:24880

Remarks ​

Whether the structure should be waterlogged when placed. Defaults to false. If true, blocks will become waterlogged when placed in water.