Script API - v1.26.30.25
    Preparing search index...

    Class MinimapManager

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

    export class MinimapManager {
        private constructor();
        createMinimap(
            viewType: MinimapViewType,
            mapWidth: number,
            mapHeight: number,
            options?: MinimapCreateOptions,
        ): MinimapItem;
        destroyMinimap(minimapId: string): void;
        getAllMinimapIds(): string[];
        getMinimap(minimapId: string): MinimapItem;
        setVanillaBiomeColorMap(colorMap: Record<string, minecraftserver.RGB>): void;
        updateVanillaColorMap(biomeType: minecraftserver.BiomeType, color: minecraftserver.RGB): void;
    }
    Index

    Constructors

    constructor

    Methods

    createMinimap destroyMinimap getAllMinimapIds getMinimap setVanillaBiomeColorMap updateVanillaColorMap

    Constructors

    Methods

    • Parameters

      • minimapId: string

      Returns void

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

      This function can't be called in restricted-execution mode.

      This function can throw errors.

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

    • Returns string[]

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

      This function can't be called in restricted-execution mode.

      This function can throw errors.

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

    • Parameters

      • minimapId: string

      Returns MinimapItem

      Retrieve a specific minimap instance using its unique identifier.

      This function can't be called in restricted-execution mode.

      This function can throw errors.

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

    • Parameters

      • colorMap: Record<string, RGB>

      Returns void

      This function can't be called in restricted-execution mode.

      This function can throw errors.

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

    • Parameters

      Returns void

      This function can't be called in restricted-execution mode.

      This function can throw errors.

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods