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

    Class MinimapItem

    Advertisement

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

    Index

    Constructors

    constructor

    Properties

    id isActive

    Methods

    addMarker getPlayerColor removeMarker setActive setSize setViewType

    Constructors

    Properties

    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.

    Methods

    • Parameters

      Returns void

      Add a visual marker of the specified type to the minimap display.

      This function can't be called in read-only 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

      Returns void

      Remove a previously added marker of the specified type from the minimap.

      This function can't be called in read-only 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 read-only 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 read-only 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 read-only mode.

      This function can throw errors.

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

    Advertisement
    Advertisement

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods