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

    Class MinimapItem

    A MinimapItem represents an individual minimap instance that manages map data, controls display state, and provides configuration for markers and visual properties.

    export class MinimapItem {
        private constructor();
        readonly freeCenter: minecraftserver.VectorXZ;
        readonly id: string;
        readonly isActive: boolean;
        readonly yLevel: number;
        addCustomMarker(iconIdentifier: string, data: MinimapMarkerData[], dimensionId: string): void;
        addLocationMarker(data: MinimapMarkerData[], dimensionId: string): void;
        addMultiplayerMarker(): void;
        getMarkerTypes(): MinimapMarkerType[];
        getPlayerColor(playerId: string): minecraftserver.RGBA;
        hasCustomGroup(iconIdentifier: string): boolean;
        hasMarkerOfType(type: MinimapMarkerType): boolean;
        removeAllCustomMarkers(dimensionId: string): void;
        removeCustomMarker(iconIdentifier: string, dimensionId: string): void;
        removeLocationMarker(dimensionId: string): void;
        removeMultiplayerMarker(): void;
        setActive(active: boolean): void;
        setFreeCenter(center: minecraftserver.VectorXZ): void;
        setSize(mapWidth: number, mapHeight: number): void;
        setTrackingMode(mode: MinimapTrackingMode): void;
        setViewType(viewType: MinimapViewType): void;
        setYLevel(yLevel: number): void;
    }
    Index

    Constructors

    constructor

    Properties

    freeCenter id isActive yLevel

    Methods

    addCustomMarker addLocationMarker addMultiplayerMarker getMarkerTypes getPlayerColor hasCustomGroup hasMarkerOfType removeAllCustomMarkers removeCustomMarker removeLocationMarker removeMultiplayerMarker setActive setFreeCenter setSize setTrackingMode setViewType setYLevel

    Constructors

    Properties

    freeCenter: VectorXZ
    id: string
    isActive: boolean

    Indicate whether this minimap instance is currently active and being displayed to the player.

    This property can't be read in early-execution mode.

    yLevel: number

    Methods

    • 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.

    • 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.

    • 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

      • playerId: string

      Returns RGBA

      Retrieve the color assigned to a specific player on the minimap.

      This function can throw errors.

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

    • Parameters

      • iconIdentifier: string

      Returns boolean

    • Parameters

      • dimensionId: string

      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

      • iconIdentifier: string
      • dimensionId: string

      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

      • dimensionId: string

      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.

    • 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

      • active: boolean

      Returns void

      Control whether the minimap is currently active and visible to the player.

      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.

    • Parameters

      • mapWidth: number
      • mapHeight: number

      Returns void

      Adjust the width and height dimensions of the minimap display.

      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

      Change the visual perspective or style of the minimap view.

      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

      • yLevel: number

      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
    Properties
    Methods