API reference

Three client exports, three server exports, one event, six commands, three key mappings.

Client exports

GetDetectorSignature

This is the whole contract a radar detector reads. tDetector already lists tRadar in its Config.radarResources, so there is nothing to install on either side.

local sig = exports.tRadar:GetDetectorSignature()
-- false, or:
{
    active    = true,      -- always true when a table is returned
    band      = 'ka',      -- 'x' | 'k' | 'ka'
    frequency = 34.7,      -- GHz, the spot frequency inside that band
    mode      = 'instant', -- 'instant' | 'constant'
    range     = 150.0,     -- metres this gun can clock an ordinary car
}

Those five keys are the whole shape. Silence is false, not a table with active = false.

It reports transmission, not power. A unit is on the air when it is powered and out of transmit hold and not mid-cold-self-test and not faulted.

mode is derived, not configured. It is 'instant' while the transmitter has been up for less than Config.instantOnWindowMs (4000 ms), and 'constant' after. The clock is stamped on the transmit edge only, so re-stating a state the unit is already in does not restart it; keying off and on again is a new edge and a new burst. Config.instantOnWindowMs = 0 means the unit never claims instant-on.

range is the gun's capability, Config.maxRange (150.0 m). A detector hears a gun at roughly twice that, and tDetector clamps the result to its own Config.detectionRangeMax.

band and frequency are resolved fresh on every call, in this order:

1. The installed skin, if Config.layoutBands names it. An entry naming a band but no frequency takes that band's default, never Config.frequency.
2. Otherwise Config.band and Config.frequency.
3. An unknown band becomes Ka, and takes Ka's frequency.
4. A missing or invalid frequency becomes the band default. nil, a non-number, NaN, zero and anything negative all fall back.

Changing the radar skin re-resolves the band immediately.

IsRadarActive

The bare boolean form of the same question.

if exports.tRadar:IsRadarActive() then
    -- a beam is on the air
end

Both are client exports and answer for the local player's unit only. Poll them — there is no event. tDetector reads once per its own Config.radarStateInterval (500 ms).

setPlateFlag

Answers a plate read. Call it from a handler for tradar:plateRead.

exports.tRadar:setPlateFlag('12ABC345', {
    level  = 'alert',        -- 'info' | 'warn' | 'alert' | 'unknown'
    label  = 'STOLEN',
    source = 'tCAD',
})

exports.tRadar:setPlateFlag('12ABC345', nil)   -- clears it

Use unknown when your lookup timed out, was rate limited or failed — see CAD and ALPR.

A flag applies only to a window currently showing that exact plate, including a locked one. An answer arriving after the car has gone is dropped. The call returns false when plate is not a string, is empty, or is over 8 characters; an over-long label is truncated and still returns true.

Events

tradar:plateRead

Fires on every new plate read. Client-side.

AddEventHandler('tradar:plateRead', function(plate, side, info)
    if info.speed > 80 then
        exports.tRadar:setPlateFlag(plate, {
            level  = 'warn',
            label  = ('%d %s'):format(math.floor(info.speed), info.unit:upper()),
            source = 'tCAD',
        })
    end
end)

The BOLO events (tradar:boloList, tradar:boloAdd, tradar:boloRemove, tradar:boloRequest, tradar:boloHit) and the CAD bridge's two (tradar:plateQuery, tradar:plateAnswer) are internals. Use the server exports below and setPlateFlag instead.

The built-in BOLO list

Officers manage it in the BOLO tab of /tradar, which appears when Config.plateReaderEnabled is on. The list is server-owned, shared, persisted in data.json, and gated on the same access check as the radar.

Call these from a server script:

RegisterNetEvent('mdt:boloIssued', function(plate)
    exports.tRadar:addBoloPlate(plate)
end)

Discord. Config.boloWebhook posts when a plate is added, removed or seen by a reader. Anything that is not a https://discord.com/api/webhooks/... URL is treated as unset and reported at startup.

Commands

add_ace group.admin command.tradar_diag allow

tradar_diag output goes to the server console, and to the caller when there was one. It is safe to paste into a support thread: no credential and no player identity.

/radar and /radarfork are removed.

Key mapping

F5 walks the unit: deploy → open the remote → close the remote. ESC does the third step too, and the unit is stowed from the remote's STOW key, so F5 never switches it off. With Config.remoteEnabled = false the second press stows.

Deploying re-checks access, so it is rate-limited to one call a second. Keypad mode — F5's second press — takes NUI focus with input kept, so you can still drive; the mouse look and attack controls are suppressed while it is up, so the cursor cannot swing your camera or fire out of the window.

The radar log

tradar_save keeps whatever is on the glass — both windows, both plates, any lock, patrol speed, band, unit, and the colour and model of each plate's vehicle — in the Log tab of /tradar. The last 25, newest first, surviving a restart.

It records what the window said: a held window logs the held number, a blanked patrol window logs as blank. Captures are refused, with a reason, when the unit is stowed or the glass empty.

Layout actions

Layouts name actions in data-hud-btn rather than calling exports. The full list is in Layouts.

Next

• Troubleshooting — No such export and the other failures these calls produce.
• CAD and ALPR — the shipped answerer for tradar:plateRead.