@minecraft/server
    Preparing search index...

    Interface StructurePlaceOptions

    Provides additional options for StructureManager.place

    interface StructurePlaceOptions {
        animationMode?: StructureAnimationMode;
        animationSeconds?: number;
        includeBlocks?: boolean;
        includeEntities?: boolean;
        integrity?: number;
        integritySeed?: string;
        mirror?: StructureMirrorAxis;
        rotation?: StructureRotation;
        waterlogged?: boolean;
    }
    Index

    Properties

    animationMode? animationSeconds? includeBlocks? includeEntities? integrity? integritySeed? mirror? rotation? waterlogged?

    Properties

    animationMode?: StructureAnimationMode

    How the Structure should be animated when placed.

    animationSeconds?: number

    How many seconds the animation should take.

    includeBlocks?: boolean

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

    includeEntities?: boolean

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

    integrity?: number

    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?: string

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

    mirror?: StructureMirrorAxis

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

    rotation?: StructureRotation

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

    waterlogged?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties