For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/classes/MinimapManager.md.

Class: MinimapManager experimental

Beta

Manage minimap instances within the editor, providing functionality to create, destroy, and retrieve minimap displays.

Methods

createMinimap()

createMinimap(viewType, mapWidth, mapHeight, options?): MinimapItem

World Mutation Beta

Parameters

viewType

MinimapViewType

mapWidth

number

mapHeight

number

options?

MinimapCreateOptions

Returns

MinimapItem

Remarks

Create a new minimap instance with the specified view type and dimensions.

Throws

This function can throw errors.


destroyMinimap()

destroyMinimap(minimapId): void

World Mutation Beta

Parameters

minimapId

string

Returns

void

Remarks

Remove an existing minimap instance from the manager using its unique identifier.

Throws

This function can throw errors.


getAllMinimapIds()

getAllMinimapIds(): string[]

World Mutation Beta

Returns

string[]

Remarks

Retrieve a list of all active minimap identifiers currently managed by the system.

Throws

This function can throw errors.


getMinimap()

getMinimap(minimapId): MinimapItem

World Mutation Beta

Parameters

minimapId

string

Returns

MinimapItem

Remarks

Retrieve a specific minimap instance using its unique identifier.

Throws

This function can throw errors.


setVanillaBiomeColorMap()

setVanillaBiomeColorMap(colorMap): void

World Mutation Beta

Parameters

colorMap

Record<string, RGB>

Returns

void

Remarks

Throws

This function can throw errors.


updateVanillaColorMap()

updateVanillaColorMap(biomeType, color): void

World Mutation Beta

Parameters

biomeType

BiomeType

color

RGB

Returns

void

Remarks

Throws

This function can throw errors.