Dispatch
Step-by-step installation guide, common issues & solutions, code snippets, error codes, config previews, locales previews, SQL previews, and changelogs; all in 1 easily accessible place.
1. Unzip the
cd_dispatch.zip folder and place this folder in your server's resource folder.2. Add the resource to your server start config:
ensure cd_dispatch (it must be placed anywhere below your framework resource eg., es_extended, not above).3. WARNING The name of the folder must not be changed or the resource will not function correctly.
4. WARNING Do not edit the encrypted files in any way.
You MUST import the SQL file to your database. This SQL file is located inside the
READ_ME_AFTER_PURCHASING folder, the file is named SQL_main.sql. Watch this video if you are unsure how to do this HeidiSQL / PHPMyAdmin.
You may need to make some changes to the fxmanifest.lua, depending on your framework and dependencies. We have made this easier for you by commenting on the lines which you may need to change.
You MUST read all of the configurable options inside the
config.lua and configure them to suit your server's needs. Please read the ”commented out help text” at the end of each line so you can understand what each config option does.
Before starting this resource on your main/live server we highly advise you to configure your key binds because this resource uses Fivem's Key Mapping.
Why? Well long story short;- once a player has joined your server with this resource running you can no longer force change their key binds for this resource through the
config.lua, only they can change it in the in-game pause menu settings. Although it will change for the players who join after you have changed it.The benefit of this system is that it's much more optimised and players can easily change their own key binds on keyboards or controllers. You can also check out the Default Keybinds for this resource.
We need to replace your existing code for police alerts with the code snippet provided below.
PLEASE READ
- Below we provide you with 2 different methods of triggering notifications; 1 from the client-side and 1 from the server-side. You DON’T need add both code snippets to trigger the same notification. Choose 1 or the other, but we recommend you use the client-side method as it’s more simple.
- You need to trigger the event on the client (criminal) performing the action, not the police on duty. You don’t want to trigger the event in an existing register event that gets triggered from the server-side and affects all cop clients, as that will cause multiple of the same police alerts to be sent.
- To sum up the above, basically how this works is; you need to target where the player starts the interaction, place the code snippet there and the event from cd_dispatch will do the backend work of noting who is a cop.
Client-side (recommended)
Server-side
NOTES: With this new client-side method you don't need to add any code to the server side (as seen in the old version), this is now done automatically.
EXAMPLE: Here is an example of how to implement the code snippet below into your robbery/criminal resources to replace your old police alerts. Not every resource will look identical to this, but the general idea is the same.
- Yellow = Remove the old police alert code.
- Red = Copy the code snippet below and paste it as a replacement for the old code you removed above^.
GUIDE:
Step 1: Open the client-side file in the resource you want to replace the police alert.
Step 2: Search for the code which triggers a server event to send a police alert. You can press Control + F and search for "police". Specifically you are looking for the part of the code where, for example a criminal starts robbing a bank and the police are called. This will most likely trigger a server event. The key here is to look for the start of the robbery.
Step 3: Follow the example above and replace the old code you have just found in step 3 with the code snippet below.
CODE SNIPPET:
local data = exports['cd_dispatch']:GetPlayerInfo()
TriggerServerEvent('cd_dispatch:AddNotification', {
job_table = {'police'},
coords = data.coords,
title = '10-15 - Store Robbery',
message = 'A '..data.sex..' robbing a store at '..data.street,
flash = 0,
unique_id = tostring(math.random(0000000,9999999)),
blip = {
sprite = 431,
scale = 1.2,
colour = 3,
flashes = false,
text = '911 - Store Robbery',
time = (5*60*1000),
sound = 1,
}
})
NOTES: We recommend you use the client-side method, but if you NEED to trigger the notification from the server-side, you can use the code snippet below.
TriggerClientEvent('cd_dispatch:AddNotification', -1, {
job_table = {'police'},
coords = vector3(0, 0, 0),
title = '10-15 - Store Robbery',
message = 'A person robbing a store',
flash = 0,
unique_id = tostring(math.random(0000000,9999999)),
blip = {
sprite = 431,
scale = 1.2,
colour = 3,
flashes = false,
text = '911 - Store Robbery',
time = (5*60*1000),
sound = 1,
}
})
- job_table = Everyone who has this job will receive this notification. You can add multiple jobs to the table.
- Example:
{'police', 'sheriff'}
- coords = You can change the coordinates to a vector3 format only.
- Example:
vector3(0, 0, 0)
- title = The title of the notification, normally your police 10 codes are used here.
- flash = Set to
1to make the UI flash, used for panic button calls etc. - unique_id = DON’T change this.
- blip:
- scale = Size of the blip.
- flashes - If set to true the blip will flash on the pause menu/mini-map, used for more important calls.
- time - The amount of time until the blip fades (default is 5 mins.)
- sound - The sound when receiving a notification:
- 1 =
x1 sound alert, 2 =x2 sound alert's, 3 =panic button alert sound. - You can change the sounds in the
configs/client_customise_me/BlipSound.
The export used in the code snippet above will return this table. This can be customised in the
client/main/functions.lua.local data = exports['cd_dispatch']:GetPlayerInfo()
--The export above will return these values for you to display on the UI.
data.ped --The players id: eg., 123456789.
data.coords --The players coordinates: eg., vector3(1,2,3).
data.street_1 --The street name: eg., “Palomino Ave”.
data.street_2 --The streets area name: eg., “Legion Square”.
data.street --Both the street name & area name: eg., “Palomino Ave, Legion Square”.
data.sex --The players ped’s sex; eg., “Male”.
--If the player is in a vehicle you can use the vehicle data.
data.vehicle --The vehicle id: eg., 123456789.
data.vehicle_label --The vehicle name: eg., “Audi RS7”.
data.vehicle_colour --The vehicles colour: eg., “Blue”.
data.vehicle_plate --The vehicles license plate: eg., “ABCD1234”.
data.heading --The vehicle's direction: eg., “North”.
data.speed --The vehicles speed: eg., “70MPH”.
What are radio channels?This option will allow players to see which radio channels other players are in. You will of course need to be using some sort of voice radio resource. By default we have added compatibility with tokovoip, mumble and pmavoice.
This event needs to be triggered from your radio resource, specifically when a player (who has access to use the dispatch) joins/leaves/changes a radio channel, and it needs to send the players new radio channel in the first argument.
client-side to server-side
RADIO_CHANNEL_HERE needs to be a string or a number.
TriggerServerEvent('cd_dispatch:GetRadioChannel', RADIO_CHANNEL_HERE)
What is the duty locales method?Do your players always have the same job but you use locals in your framework or other resources to check if a player is on/off duty? (Most people will not need to use this, it's just optional).
NOTE: This already comes pre-installed and pre-configured in cd_dispatch if you are using ESX Legacy 1.6+ and QBCore.
client-side to client-side
server-side to client-side
Boolean means (true or false).
TriggerEvent('cd_dispatch:OnDutyChecks', BOOLEAN)
Boolean means (true or false).
TriggerClientEvent('cd_dispatch:OnDutyChecks', source, BOOLEAN)
Key | Description |
U | Toggles the small dispatch UI. |
G | Respond to a notification. |
Left/Right Arrows | Scroll through the notifications on the small dispatch UI. |
L | Opens the large dispatch UI. |
All of these chat commands can be renamed and disabled/enabled in the config/code.
If a command isn't working, make sure the config option for the said feature is enabled in the config.lua.
Command | Description |
/dispatchsmall | Toggles the small dispatch UI. |
/dispatchlarge | Opens the large dispatch UI. |
/respond | Respond to a notification. |
/movemode | Allows you to move the small UI on your screen. |
/panic | Press your panic button. |
/reply | Reply to job calls such as /911 calls etc. |
/dispatchtest | (Test Command) This is a test command which triggers a police notification. |
These events are completely optional, you can use them if needed. These are less important events, the more important events are documented in the other sections above.
client-side to client-side
Panic Button
Activates the panic button.
TriggerEvent('cd_dispatch:PanicButtonEvent')
🔔 Folder Name Make sure the name of the folder is
cd_dispatch.SQL Default Value Error?eg., if you see an error similar to this example when inserting an SQL query into your database -“BLOB/TEXT column 'callsign' can't have a default value”.✔️ You can use “VARCHAR(256)” instead of “LONGTEXT” in the SQL query.
SQL Unknown Column Error?eg., if you see an SQL error in the server console similar to this example -ER_BAD_FIELD_ERROR: Unknown colum 'callsign' in 'where clause'.✔️ You are missing one of the required database columns. The SQL file can be found in the "READ_ME_AFTER_PURCHASING" folder.
Script Loading?eg., if you see this notification at least 10-20 seconds after loading in or restarting the script - “The resource is still loading. Please try again in a few seconds”.✔️ There will usually be a server side error which will be pretty self explanatory, usually a database error or because your Config.FrameworkTriggers were not configured correctly.
NUI "drawImage" error?✔️ This means you have chosen a blip colour that is not supported by default in: Config.lua/Config.BlipData/largeui_blip_colour. To fix this change it to one of the supported colours.
If you see an error code which isn't listed below please open a script support ticket in the Codesign Discord.
Server
Client
N/A
3651 - This error code can be ignored, it does not effect anything, it's just trying to delete a notification that has just been deleted.
Files Changed: Not every update requires you to replace the whole folder. We do this because we understand it's a pain to redo the configs for every update.
- All Files - This means you should delete your old
cd_dispatchfolder, download and add in the latest version, reconfigure the configs folder and restart your server. - Specific Files - This means you can simply copy and paste the SPECIFIC new files over the old ones and restart the server.
Update Type: On rare occasions, you are forced to update to the latest version. Mostly due to authentication updates where the old versions will no longer work.
- Mandatory - This means you MUST update to this new version or the old versions will no longer work.
- Optional - This means it's completely your choice whether you wish to update to the latest version. But we do not offer support for old versions for obvious reasons; they are old.
v3.0.0
v409 beta
v410 beta
v411 beta
v4.2.0
v4.2.1
v3.0.0 - v3.0.5
Files Changed:
- All files
- Specific Files
Update Type:
- Mandatory
- Optional
Changelog:
Add
- Added locales for the /911 etc chat commands.
- Added the ability to rename all esx events such as the setjob and playerloaded events.
Edit
- Minor script cleanups.
- Updated the codesign error handlers.
- Removed the need to cache individual players data when going on/off duty.
- Added compatibility for oxmysql.
Fix
- Fixed random server error on server start.
- Minor bug fixes.
- Fixed errors with the /callsign command.
- Fixed error when using the UI before the script has loaded fully.
- Fixed random server error on server start.
- Temporary fix for the canary issue until the new Tebex FiveM license system is ready to launch, when this is released we will be fully switching over to the new system.
- Fixed the random client side error that happens sometimes when pressing G to respond.
Files Changed:
- All files
- Specific Files
Update Type:
- Mandatory
- Optional
Changelog:
Authentication
- We are now using the official Authentication System provided by FiveM. The old auth system will be taken offline 1 week from now (give or take a few days if needed).
Add
- Large map zoom On the large UI map you can now zoom in and out and move around with the mouse. The blips of calls and other officers will always stay in the exact same position.
- Grouped units On the large UI, if 2(or more) officers are patrolling together, they can create a group, which will show the other officers that they are patrolling together.
- Vehicle type status The vehicle type icon on the large UI units list will change depending on what vehicle type a player has set in the settings.
- Player status The players status on the large UI units list will be visible when you right click a players name on the unit list. Also, the background of the radio channel is also a quick way of viewing a players status as it will change colour when a player changes their status. You can configure add/remove/change statuses in the config, along with configuring the colour of each status.
- Multi job compatibility You can configure it so multiple jobs can see each other on the large UI and pause menu blips menu. So for example if you have 2 police jobs (police and sheriff) or (police and ambulance), they will now be able to see each other on the maps.
- Quick join/leave radio channels On the large UI, you can right click a players name on the units list and you have the option to join their radio channel or leave your radio channel.
- New dispatcher mode When a call is initially received, only the dispatcher can see the call. Dispatchers can enable voice mode while the large UI is enabled to communicate over radio to other officers to see who is available to take calls (the large ui can stay enabled the whole time and everything will be instantly updated on the ui), dispatchers then can drag-and-drop a unit (single unit or grouped unit) onto the call and only that unit will receive the call. If there is no dispatcher logged in, the dispatch will function exactly like it currently does now in previous versions, where all online officers will receive the calls.
- Pause menu player blips We have added a built in player blips system, which works on OneSync (legacy+infinity)/non OneSync . Your blip icon will change depending on what you have set your vehicle type to on the large UI settings. When your vehicles emergency lights are on your player blip will flash (flashing colours are configurable for each job). Your current radio channel will also be displayed on your player blip. Everything is fully synced across all players.
- Gunshot, stolen car, speed trap alerts We have added a built in gunshot, stolen car and speed trap alerts, this is all fully configurable in the config.
- View responding units On the large UI, you will be able to click on a notification and see which units are responding, it will show their name, callsign, how long ago they clicked respond etc.
- Set GPS location On the large UI, you can right click a players name on the units list and it will set a waypoint to this players location on the pause menu/mini-map.
- Live Map Added the ability to enable the player blips on the large UI to auto refresh while the UI is open.
- Multi job notifications When creating notifications from other scripts, instead of only being able to choose 1 job to send the notification too, you can choose multiple, this also is the same for the built in job command calls eg., (/911). But don’t worry, this wont force you to update all of our scripts, as the previous single job format can also be used.
Fix
- Fixed the on/off duty locals method showing blips on the map and playing the alert sound when a notification comes through when the player is off duty.
- The callsign command is now removed and has been moved onto the settings tab on the large UI.
Edit
- Added more data to the GetPlayerInfo() export.
Files Changed:
- All files
- Specific Files
Update Type:
- Mandatory
- Optional
Changelog:
PLEASE READ IMPORTANT!!!
The method of adding notifications has changed. Please see here for the new method. To use this, and future versions this does mean that you will need to REDO ALL OF YOUR CURRENT NOTIFICATIONS. Its a fairly quick process though, just a lot of copy paste.
This does have a couple of benefits such as being more optimised and more user friendly but we had to do this to fix a syncing issue.
Edit
- If no blip data is sent, the blip will not show on the pause menu map; to allow the use of /311 calls to not show the location etc.
- Optimised the client side of police alerts and the framework
getjobcode. - Updated compatibility with the new oxmysql method.
- Optimised and simplified the UI notifications integrated into your other scripts.
- Added checks for duplicate notifications in list.
Fix
- Fixed some locales on the UI.
- Fixed the units list not being scrollable.
- Fixed the
IsDispatcherclient error. - Fixed an issue with assigning calls to a user as a dispatcher where it would show the user responding to the wrong call.
- Disabled the ability to enable radio voice for non dispatchers on the large UI.
- Fixed the client side
playerblipserror. - Fixed a server side related to the duty checks being triggered too early.
- Fixed the issue where when responding to calls, it would show other users that you responded to the wrong call.
- Fixed an error where when a dispatcher logged off it would not allow non dispatchers to receive calls.
- Fixed an issue where when you logged in as a "non authorised job" and then switched to an "authorised job" it would not allow you to enable dispatcher mode.
- Fixed hovering over notification blips when zoomed.
- Fixed dispatcher sending wrong notification to group.
- Fixed clicking on a notification not changing blip colour to green.
- Fixed different screen resolutions.
- Fixed an issue with getting the closest vehicle returning the wrong vehicle.
- Fixed some issues with JS locales.
- Fixed the units list not scrolling when full.
Files Changed:
- All files
- Specific Files
Update Type:
- Mandatory
- Optional
Changelog:
Add
- Added the option to choose a boat as your vehicle in the UI's settings.
- Added a new option in the UI's settings to mute sound from notifications.
Edit
- Add a config option to the police alerts to only find players who are speeding if they own the vehicle.
Fix
- Fixed selecting multiple notifications when only clicking on one.
- Fixed drag/drop being interrupted randomly.
- Fixed matching notifications to pins when clicking on either one.
Files Changed:
- All files
- Specific Files
fxmanifest.lua - (IMPORTANT)
client/main/client.lua - (IMPORTANT)
html (FULL FOLDER) - (IMPORTANT)
configs/client_customise_me.lua
Update Type:
- Mandatory
- Optional
Changelog:
Add
- Added compatibility with esx's built-in duty system.
Fix
- Fixed the distance counter not working for the first notification.
- Security fixes for the UI to prevent people from abusing the chat commands with js code.
Last modified 4d ago