StructureManager

6 methods

On this page

Example
Methods
get
has
place
createFromWorld
delete
getWorldStructureIds
Used by

Class in @minecraft/server

The world’s structures.

import { StructureManager } from '@minecraft/server';

Example

import { world, type StructureManager } from '@minecraft/server';

const structureManager: StructureManager = world.structureManager;

import { world } from '@minecraft/server';

const structureManager = world.structureManager;

Methods

get

get(identifier: string): Structure | undefined;

Parameters

identifier: string

Returns

Structure | undefined

Types

Structure

has

has(identifier: string): boolean;

Whether a structure by this id is in memory, the world or the folder.

Parameters

identifier: string

Returns

boolean

place

place(structure: string | Structure, dimension: Dimension, location: Vector3, options?: StructurePlaceOptions): void;

Places a structure with its lowest corner at location.

Parameters

structure: string | Structure
dimension: Dimension
location: Vector3
optionsoptional: StructurePlaceOptions

Throws

If there’s no such structure or its chunks can’t be loaded.

Types

StructureDimensionVector3StructurePlaceOptions

createFromWorld

createFromWorld(
    identifier: string,
    dimension: Dimension,
    from: Vector3,
    to: Vector3,
    options?: StructureCreateOptions,
): Structure;

Copies the blocks between two corners, and the mobs among them if asked.

Parameters

identifier: string
dimension: Dimension
from: Vector3
to: Vector3
optionsoptional: StructureCreateOptions

Returns

Structure

Types

DimensionVector3StructureCreateOptionsStructure

delete

delete(structure: string | Structure): boolean;

Takes it out of memory and the world; files in the folder are left alone.

Parameters

structure: string | Structure

Returns

boolean

Types

Structure

getWorldStructureIds

getWorldStructureIds(): string[];

Every structure in memory, the world and the folder.

Returns

string[]

Used by

World.structureManager