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 table<string, PredefinedUnitMarker>
        styling = {
            ['police'] = {
                color = 3,
                scale = 0.7,
                sprite = 1
            }
        }
    },

    ---@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 styling table<string, PredefinedUnitMarker>

Detailed types information

onDispatchMap boolean

Is location shown on map.

nativeMap boolean

Is blip shown on native map.

styling table<string, PredefinedUnitMarker>

Styling for markers on the map.

enabledByDefault boolean

Defines if quick dispatch is enabled by default.