Markers

Details

Below, you will find detailed configuration for markers.

Configuration file

config/markers.lua
---@type MarkersConfig
return {
    ---@type MarkersUnitsConfig
    units = {
        ---@type boolean
        onDispatchMap = true,

        ---@type boolean
        nativeMap = true,

        ---@type boolean
        showSelf = false,

        ---@type boolean
        reflectVehicleType = true,

        ---@type table<string, PredefinedUnitMarker>
        styling = {
            ['police'] = {
                color = 3,
                scale = 0.7,
                sprite = 1,
                headingIndicator = true
            }
        }
    },

    ---@type number
    positionUpdateInterval = 1000
}

Detailed types information

positionUpdateInterval number

Defines interval timer, when location and blips for users are updated. In miliseconds.

Units

Payload

---@class MarkersUnitsConfig
---@field onDispatchMap boolean
---@field nativeMap boolean
---@field showSelf boolean
---@field reflectVehicleType boolean
---@field styling table<string, PredefinedUnitMarker>

Detailed types information

onDispatchMap boolean

Is location shown on map. When disabled, the “Show on map” button is also hidden from units in the Units tab (and the unit map popup), so players can’t reveal an officer’s position there.

nativeMap boolean

Is blip shown on native map. When disabled, the “Show on GPS” button is also hidden from units in the Units tab (and the unit map popup).

showSelf boolean

Defines if your own marker is shown to yourself on the map.

reflectVehicleType boolean

If enabled, the marker reflects the unit’s current vehicle type instead of using the static styling sprite.

styling table<string, PredefinedUnitMarker>

Styling for markers on the map.

Unit marker styling

Payload

---@class PredefinedUnitMarker
---@field color number
---@field scale number
---@field sprite number
---@field headingIndicator? boolean

Detailed types information

color number

Blip color. Choose from Fivem Documentation

scale number

Blip scale. Usually from 0.1 to 1.0

sprite number

Blip sprite. Choose from Fivem Documentation

headingIndicator boolean

If enabled, the marker shows a heading indicator pointing in the unit’s facing direction.