Events#

Dispatcher events#

Every after hook is also fired as a server-local event koja-dispatcher:<hook>, with the same payload, right after the hook functions ran.

AddEventHandler('koja-dispatcher:incidentEnded', function(incident)
    if incident.status == 'resolved' then
        print(('incident #%d closed: %s'):format(incident.id, incident.outcome))
    end
end)

Payload details are on the Hooks page.

koja-dispatcher:boloCreated#

Fires when a BOLO is created in the dispatcher's own list (mdt_tools.boloSource = 'internal', or auto while koja-mdt is not running), from the CAD or the CreateBolo export. BOLOs created in koja-mdt fire koja-mdt's own events instead.

{
    id = 'i12', source = 'internal', type = 'vehicle',
    title = 'Black Sultan, armed', description = nil,
    plate = 'ABC123', model = 'Sultan', colour = 'Black', priority = 1, image = nil,
    x = 215.8, y = -810.1, label = 'Legion Square', incident = 1004,
    createdBy = 'Jane Doe', createdAt = 1730000000,
}

AddEventHandler('koja-dispatcher:boloCreated', function(bolo)
    if bolo.plate then exports['my-alpr']:Watch(bolo.plate) end
end)

Events you can trigger#

koja-dispatcher:phone:call (net, client → server)#

Generic 911 entry point for any phone resource. The text is handled like a call to the service number: it goes through /911 logic, follow-up texts join the open call and dispatcher replies come back to the player (as phone messages when a supported phone is running, otherwise as normal notifications).

TriggerServerEvent('koja-dispatcher:phone:call', 'My neighbour is screaming for help')

Only phones.enabled must be on; no supported phone is needed. The same player can call once every 2 seconds (Config.Phones.cooldown). When nobody can take the call, the player gets a "no dispatchers" message.

koja-dispatcher:compat:alert (net, client → server)#

Feeds a client-side alert in the format of another dispatch script.

Rate limited to 8 alerts per 10 seconds per player (Config.Compat.rate), coordinates more than 600 m from the player's ped are replaced by the ped position (Config.Compat.maxDistance), and identical alerts within 20 s are dropped.

TriggerServerEvent('koja-dispatcher:compat:alert', 'ps-dispatch', {
    message = 'Store robbery', code = '10-90', priority = 1,
    coords = GetEntityCoords(PlayerPedId()), jobs = { 'police' },
})

Dispatch-script events#

While compat.enabled is on, koja-dispatcher answers the events of other dispatch scripts only when that script is not running (a shim from compat/ counts as not running). Existing robbery and crime scripts keep working without edits.

Server-side TriggerEvent (without a player) works too. Events sent by players use the same rate limit and 600 m clamp as koja-dispatcher:compat:alert.

Phone events#

With phones.enabled on, the dispatcher listens to the running phone:

These are the phones' own events. You do not trigger them yourself.

koja-mdt events#

With koja-mdt started and mdt.enabled on, koja-dispatcher listens to these server events. They are accepted only when koja-mdt fires them; the same events from other resources are ignored.

To create MDT calls or status changes from your own resource, use the koja-mdt exports. koja-dispatcher picks the result up through these events.

Client events#

koja-dispatcher sends these net events to the player's client. Other client scripts may listen to them, for example to show their own HUD. Register the name in your resource and add a handler; never trigger them yourself.

RegisterNetEvent('koja-dispatcher:client:fieldAssign', function(incident)
    print(('assigned to #%d: %s at %s'):format(incident.id, incident.title, incident.label or '?'))
end)

Dispatcher-only events (koja-dispatcher:client:call, incident, unit, radio, roster, ...) only reach players on shift and carry CAD data; their format can change between versions, so read the server exports instead.

Internal events#

These are part of koja-dispatcher's own client/server protocol. Never trigger them from other resources. Server handlers check the sender and rate limits, and their arguments change between versions.