Class MinimapManager

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

Index

Constructors

Methods

createMinimap destroyMinimap getAllMinimapIds getMinimap

Constructors

`Private`constructor

new MinimapManager(): MinimapManager
Returns MinimapManager

Methods

createMinimap

createMinimap(
    viewType: BlockView,
    mapWidth: number,
    mapHeight: number,
): MinimapItem
Parameters
- viewType: BlockView
- mapWidth: number
- mapHeight: number
Returns MinimapItem
Remarks
Create a new minimap instance with the specified view type and dimensions.

Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

destroyMinimap

destroyMinimap(minimapId: string): void
Parameters
- minimapId: string
Returns void
Remarks
Remove an existing minimap instance from the manager using its unique identifier.

Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getAllMinimapIds

getAllMinimapIds(): string[]
Returns string[]
Remarks
Retrieve a list of all active minimap identifiers currently managed by the system.

Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getMinimap

getMinimap(minimapId: string): MinimapItem
Parameters
- minimapId: string
Returns MinimapItem
Remarks
Retrieve a specific minimap instance using its unique identifier.

Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.