Vehicle Control

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.

Buy Here

FiveM Forums Post

YouTube Showcase Video

YouTube Walkthrough Video

Translate

• Click here to translate this page.

• How do I change language?

INSTALLATION GUIDE

Step 0 - First Steps

1. Download your resource from FiveM’s Keymaster.

2. Unzip the cd_vehiclecontrol.zip folder and place this folder in your server's resource folder.

3. Add the resource to your server start config (server.cfg): ensure cd_vehiclecontrol. If you are using a framework, it must be placed anywhere below your framework resource e.g., es_extended, not above.

ensure es_extended
ensure cd_vehiclecontrol

Step 1 - Fxmanifest

Depending on your framework and dependencies, you may need to make some changes to the [cd_vehiclecontrol/fxmanifest.lua]. We have made this easier by commenting on the lines you possibly need to change.

Step 2 - Configure Resource

You MUST read all configurable options inside the [cd_vehiclecontrol/configs/config.lua] file 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.

The most important sections are the options under the Framework and Important sections at the top of the config.lua. Everything else is optional.

NEW: Auto Framework Detect!

Introducing our new 'auto_detect' feature! It automatically identifies your Framework and applies the appropriate default settings.

Step 3 - Configure Key Binds

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.

Where can I configure my key binds?

You can configure key binds in the Keys and Commands section near the bottom of the [cd_vehiclecontrol/configs/config.lua].

Why do I need to do this?

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 key binds on keyboards or controllers. You can also check out the Default Keybinds for this resource.

Step 4 - Vehicle Lock

What is the vehicle lock display?

This clickable button on the UI allows players to lock/unlock their vehicle from the UI itself.

Do you want to use the vehicle lock display?

NO = You can skip this step.

YES = A few small modifications are required; read below for more information.

1. Enable Config.VehicleLock in the [configs/config.lua] file.

2. This screenshot shows the 2 functions that must be modified in the [configs/client_customise_me.lua] file. Read the ”commented out help text” for further information.

Do you use cd_garage and its built-in keys feature?

Then you don't need to make any changes. We have already pre-configured this for you.

INFORMATION

Default Key Binds

These keys can be modified and/or disabled in the Keys and Commands section of the [configs/config.lua].

Please make sure you understand how Key Mapping works.

Key	Description
K	Open the vehicle control's UI.

Chat Commands

These chat commands can be renamed and/or disabled in the Keys and Commands section of the [configs/config.lua].

The exact usage for each command will be displayed in the chat suggestions when using the commands in-game.

Command	Description
/vehcontrol	Open the vehicle control's UI.

Events

These events are completely optional; you can use them if needed.

client-side to client-side

Open the UI

Open the vehicle control's UI.

TriggerEvent('cd_vehiclecontrol:OpenUI')

Close the UI

Close the vehicle control's UI.

TriggerEvent('cd_vehiclecontrol:CloseUI')

server-side to client-side

Open the UI

Open the vehicle control's UI.

TriggerClientEvent('cd_vehiclecontrol:OpenUI', source)

Close the UI

Close the vehicle control's UI.

TriggerClientEvent('cd_vehiclecontrol:CloseUI', source)

COMMON ISSUES

Please check out our Troubleshooting Guide before contacting our support.

🔔 Folder Name Make sure the name of the folder is cd_vehiclecontrol.

🔔 Encrypted Files Do not edit the encrypted files in any way.

Some extras such as lightbars not working?

eg., the lightbar extra for example can be toggled off, but when toggled back on it's not visible.

✔️ Sometimes extras such as lightbars will only be visible if the car is fully repaired first.

To fix this you can set Config.Extras.extras_workaround_fix to true in the configs/config.lua.

There is a downside with this though; because to overcome this issue we fully repair the vehicle. After the extra has been enabled we re-aply most of the damage such as broken doors, broken windows and popped tyres. But we are unable to re-apply the minor visual body damage such as dints, bumps or scratches. So some players may abuse this to repair minor visual body damage on their vehicles.

ERROR CODES

If you see an error code not listed below, please open a script support ticket in the Codesign Discord.

Server

N/A

Client

5467 - This means the GetVehicleLockState() function in the configs/client_customise_me.lua is is not returning what the script expects. It should return either “locked” or “unlocked” as a string.

9833 - This means the DoesPlayerHaveKeys() function in the configs/client_customise_me.lua is not returning what the script expects. It should be returning either true or false as a boolean. This usually happens when you have enabled the Config.VehicleLock in the config, but you have not edited the function to work with your vehicle lock script.

CHANGELOG

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_vehiclecontrol folder, download and add in the latest version, reconfigure the configs folder and restart your server.

• All Files Except config.lua - This means you should do all of the above (in the All Files section) but additionally make a backup of the config.lua file and replace the new config.lua file with the one you made a backup of.

• Specific Files - This means you can 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.

Skipping Updates

If you are attempting to update to the latest version but have skipped previous updates, you should update all files just to be safe. For example., let's say you are currently on v4.0.1, you did not update when v4.0.2 was released, and now v4.0.3 is released, and you want to update; you should always use the “All Files” update method.

v1.0.0

29/06/2022

Files Changed:

• All Files

• All Files Except config.lua

• Specific Files

Update Type:

• Mandatory

• Optional

Changelog:

STATUS

• Development Stage: COMPLETE

• Alpha Test Stage: COMPLETE

• Beta Test Stage: COMPLETE

v1.0.1

26/08/2022

Files Changed:

• All Files

• All Files Except config.lua

• Specific Files

Update Type:

• Mandatory

• Optional

Changelog:

Add

• Added a config option to disable the use of toggling liveries, extras or neons on the ui.

• Disabled the option to toggle extras when in a helicopter.

v1.0.2

11/01/2023

Files Changed:

• All Files

• All Files Except config.lua

• Specific Files

Update Type:

• Mandatory

• Optional

Changelog:

Add

• Job-restricted Usage: You can allow all players to be able to use this part of the UI to toggle extras and liveries or you can restrict it to certain jobs only (you can choose multiple jobs).

• Location Restricted Usage: You can allow players to be able to use this part of the UI to toggle extras and liveries anywhere on the map or you can restrict it to certain areas around the map (you can choose multiple locations).

• Note: The 2 usage-restricting features above^^ can work independently of each other or in combination with each other; (for example., only police and ambulance jobs can use the UI to toggle extras but also they can only do this in certain areas around the map.)

• Bugged Extras (lightbars) Fix 1: If your vehicle is in full health you will now be able to toggle on the bugged extras such as lightbars.

• Bugged Extras (lightbars) Fix 2: Added a new config option Config.Extras.extras_workaround_fix which will also fix this issue on vehicles that are damaged but do have small side effects #Common Issues.

Edit

• Changed the default key from N to K as n had some issues with the chat.

v1.0.3

09/02/2023

Files Changed:

• All Files

• All Files Except config.lua

• Specific Files

Update Type:

• Mandatory

• Optional

Changelog:

Add

• Auto Framework Detection - We have added a new feature we are calling 'auto_detect', which will automatically identify your framework resource and framework notifications and apply the appropriate default settings.

• Added the option to restrict the use of extras and liveries to certain vehicle models.

• Added a config option to blacklist neon light colours. By default, all cars have neons enabled and default colours, so we will disable the default colours and only allow custom ones.

• Added a config option to prevent auto seat shuffle.

Edit

• Restricted passengers from using the extras, liveries, engine toggle, indicators and neons.

• Added debug prints.

Fix

• Fixed the "no NUI callback captured" warnings.

• Fixed some minor bugs with the UI.

• Fixed the toggle engine being visible even if you don't have keys.

v1.0.4

25/06/2023

Files Changed:

• All Files

• All Files Except config.lua

• Specific Files

Update Type:

• Mandatory

• Optional

Changelog:

Add

• Added the ability to use the vehicle control UI when standing outside the vehicle. However, this does have limited options when compared to sitting inside the vehicle.

• Added Config.Extras.disable_extras_in_heli to allow servers to choose whether they want to disable extras in helicopters (some servers wanted this disabled due to players removing the helicopter blades).

• Added a function EngineToggled() to the client_customise_me, which is triggered every time the engine is toggled on/off in a vehicle. This is optional and can be used if needed for compatibility with other resources.

• Added pre-configured notifications for multiple notification resources.

v1.0.5

26/06/2023

Files Changed:

• All Files

• All Files Except config.lua

• Specific Files

fxmanifest.lua
client/client.lua

Update Type:

• Mandatory

• Optional

Changelog:

Fix

• Fixed extras not working in vehicles.