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

    Interface IMinimapPropertyItem

    Advertisement

    A property item which supports Minimap properties

    interface IMinimapPropertyItem {
        enable: boolean;
        id: string;
        mapId: string;
        mapImageHeight: number;
        mapImageWidth: number;
        paneId: string;
        typeName: PropertyItemType;
        visible: boolean;
        assignMarker(markerType: Multiplayer): void;
        refreshMap(): void;
        removeMarker(markerType: Multiplayer): void;
        resizeMapImage(width: number, height: number): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    enable id mapId mapImageHeight mapImageWidth paneId typeName visible

    Methods

    assignMarker refreshMap removeMarker resizeMapImage

    Properties

    enable: boolean

    If the item is enabled in the UI.

    id: string

    Unique ID for the property item.

    mapId: string

    Id of the map.

    mapImageHeight: number

    Height of the map image.

    mapImageWidth: number

    Width of the map image.

    paneId: string

    The parent pane id.

    typeName: PropertyItemType

    The type name of the target property.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Parameters

      Returns void

      Adds a marker to the minimap.

    • Returns void

      Refreshes the map.

    • Parameters

      Returns void

      Removes a marker from the minimap.

    • Parameters

      • width: number

        New width of the image.

      • height: number

        New height of the image.

      Returns void

      Updates the size of the map image.

    Advertisement
    Advertisement

    Settings

    Member Visibility

    On This Page

    Properties
    Methods