Skip to content

Events ​

Note


These events are entirely optional and can be triggered as needed to integrate cd_dispatch3d with your own scripts or custom systems.

Client ​

Client-Side Events


  • Defined with RegisterNetEvent or AddEventHandler in client files.
  • Triggered using TriggerEvent (if from client) or TriggerClientEvent (if from server).
  • Run only on one player’s game client (the player’s PC).

Panic Button ​

Activates your panic alert.

client-side to client-side
lua
TriggerEvent('cd_dispatch:PanicButtonEvent')
server-side to client-side
lua
TriggerClientEvent('cd_dispatch:PanicButtonEvent', source)

Toggle Quick View UI ​

Toggles the visibility of the quick view dispatch UI.

client-side to client-side
lua
TriggerEvent('cd_dispatch:KEY_smallui')
server-side to client-side
lua
TriggerClientEvent('cd_dispatch:KEY_smallui', source)

Hide Quick View UI ​

Hides the quick view dispatch UI.

client-side to client-side
lua
TriggerEvent('cd_dispatch:KEY_smallui_hide')
server-side to client-side
lua
TriggerClientEvent('cd_dispatch:KEY_smallui_hide', source)

Show Quick View UI ​

Shows the quick view dispatch UI.

client-side to client-side
lua
TriggerEvent('cd_dispatch:KEY_smallui_show')
server-side to client-side
lua
TriggerClientEvent('cd_dispatch:KEY_smallui_show', source)

Open Main Dispatch UI ​

Opens the main dispatch interface.

client-side to client-side
lua
TriggerEvent('cd_dispatch:KEY_largeui')
server-side to client-side
lua
TriggerClientEvent('cd_dispatch:KEY_largeui', source)

Responding ​

Marks the player as responding to a notification.

client-side to client-side
lua
TriggerEvent('cd_dispatch:KEY_responding')
server-side to client-side
lua
TriggerClientEvent('cd_dispatch:GpsTrackerDisable', source)

Disable GPS Tracker ​

Disables a player’s access to the dispatch system.

client-side to client-side
lua
TriggerEvent('cd_dispatch:GpsTrackerDisable')
server-side to client-side
lua
TriggerClientEvent('cd_dispatch:GpsTrackerDisable', source)

Enable GPS Tracker ​

Restores a player’s access to the dispatch system after being disabled.

client-side to client-side
lua
TriggerEvent('cd_dispatch:GpsTrackerEnable')
server-side to client-side
lua
TriggerClientEvent('cd_dispatch:GpsTrackerEnable', source)

Server ​

Server-Side Events


  • Defined with RegisterServerEvent or AddEventHandler in server files.
  • Triggered using TriggerEvent (if from server) or TriggerServerEvent (if from client).
  • Run on the server, not on any individual player’s game client.

Radio Channel Event ​

Used to update a player’s radio channel on the dispatch system.
This event should be triggered from your radio resource whenever a player joins, leaves, or changes a radio channel.

@parameters
lua
--- @param radioChannel string or number The player’s current radio channel.
--- @example
--- local radioChannel = 1
--- TriggerServerEvent('cd_dispatch:GetRadioChannel', radioChannel)
client-side to server-side
lua
TriggerServerEvent('cd_dispatch:GetRadioChannel', radioChannel)
server-side to server-side
lua
TriggerEvent('cd_dispatch:GetRadioChannel', radioChannel, source)

Player Responding Event ​

This event is triggered when a player starts or stops responding to a dispatch call. Listen for this event on the server side to receive updates.

@parameters
lua
--- @param data table The dispatch response data.
--- @param data.action string The response action, either `'add'` or `'remove'`.
--- @param data.unique_id string The unique ID of the dispatch call, e.g. `'DH47-DHWK-PR84-12JDU'`.
--- @param data.job_table table The jobs associated with the dispatch call, e.g. `{ "police", "bcso" }`.
--- @param data.source number The server ID of the responding player, e.g. `1`.
server-side
lua
AddEventHandler('cd_dispatch:PlayerResponding', function(data)
    local action = data.action -- 'add' or 'remove'
    local unique_id = data.unique_id -- 'DH47-DHWK-PR84-12JDU'
    local job_table = data.job_table -- { "police", "bcso" }
    local source = data.source -- 1
end)

Hello!