T1GER Keys

View on Tebex | CFX Forum Post | YouTube Showcase | Discord

INSTALLATION

DEPENDENCIES

START

1. Extractt1ger_keys.rar and place it into your resource folder.

2. Install the SQL file into your database (⚠️see #SQL for instructions).

3. Install and ensure dependencies for the resource.

4. Setupconfig.lua (⚠️see #CONFIGURATION for instructions).

5. Addensure t1ger_keysto your server start config (place it anywhere below the dependency & framework resources).

6. Update the SetVehicleDoorsLocked() native in all your resources to use my export function instead (see instructions here)

SQL

CONFIGURATION

UTILITIES

VEHICLE LOCKED STATUS

You need to replace theSetVehicleDoorsLocked() native with my export function below. This is because my resource uses decors which syncs much better and when using the native to lock/unlock a vehicle, the decors of the vehicle aren't updated, meaning you'd face syncing issues.

exports['t1ger_keys']:SetVehicleLocked(vehicle, int)
-- vehicle is the vehicle entity that you want to execute the function on.
-- int is the lock door status interger (0 or 1 is unlocked, 2 or 10 is locked)
-- (see more here: https://docs.fivem.net/natives/?_0xB664292EAECF7FA6)

Best and easiest way to replace, is simply search forSetVehicleDoorsLocked( in your files and replace with my export function. Reminder; make sure to set the correct variables for vehicle and int, they have to be the exact same as you had in the native you replaced/about to replace.

I have added the export inside myESX.Game.SpawnVehicle() function, so all my resources using this function, will automatically set vehicles to be unlocked. For resources not using that function, you'd need to add the export in manually in the script.

ADDING KEYS

Follow these instructions to add keys for player or jobs for a vehicle.

JOB KEYS

To add job keys for a vehicle used for a job, use this export function in your client-sided files:

exports['t1ger_keys']:GiveJobKeys(plate, name, boolean, jobs)
-- plate; is the plate variable of the vehicle 
-- name; is the vehicle display name, using GetLabelText() and GetDisplayNameFromVehicleModel()
-- boolean; is true/false, where true add keys to the player, false doesnt add keys to the player
-- jobs; is a table of jobs, that should have lock/unlock access to the vehicle

Keys for player

Keys for jobs

Keys for player + jobs

This example shows how to add job keys for a player and not allowing any jobs to have access to the vehicle.

Copy

exports['t1ger_keys']:GiveJobKeys(plate, name, true)
-- plate is the vehicle plate
-- name is the vehicle display name
-- source player keeps the keys
-- last variable is indifferent, as its not for any jobs.

This example shows how to add job keys for a job or multiple jobs and auto-removes access to the spawned vehicle from players that switches job or goes off-duty.

Copy

exports['t1ger_keys']:GiveJobKeys(plate, name, false, {'police','lspd'})
-- plate is the vehicle plate
-- name is the vehicle display name
-- source player loses keys if switching jobs.
-- all players with job 'police' or 'lspd' has access to the vehicle.

This example shows how to add job keys for jobs and allowing source player to keep the keys, in case he switches jobs or goes off-duty.

Copy

exports['t1ger_keys']:GiveJobKeys(plate, name, true, {'police'})
-- plate is the vehicle plate
-- name is the vehicle display name
-- true means source player keeps the if he goes off-duty or switch job
-- all players with job 'police' have access to the vehicle.

TEMPORARY KEYS

To add temporary keys to a vehicle for player, you need to use this export function in your client-sided files.

exports['t1ger_keys']:GiveTemporaryKeys(plate, name, type)
-- plate; is the plate variable of the vehicle 
-- name; is the vehicle display name, using GetLabelText() and GetDisplayNameFromVehicleModel()
-- type; is the label shown in keys menu, after the plate.
-- I for example use: 'stolen' -for keys gotten from NPCs at gunpoint aim

OWNED KEYS

To add keys for owned vehicle, which are permanent, it requires the vehicle to be registered inowned_vehicles table in the database (of course, otherwise it wouldn't be an owned vehicle).

Server-side

Client-side

Use this export function to add keys from a server-sided environment:

Copy

exports['t1ger_keys']:UpdateKeysToDatabase(plate, state)
-- plate; plate of the vehicle in database that needs its keys state updated.
-- state; set it to true/false, where true means adding keys, false means removing keys.
-- example: https://ibb.co/vDx6czs

Use this trigger event to add keys from a client-sided environment:

Copy

TriggerServerEvent('t1ger_keys:updateOwnedKeys', plate, state)
-- plate; plate of the vehicle in database that needs its keys state updated.
-- state; set it to true/false, where true means adding keys, false means removing keys.

When triggering this event from client-sided environments, you really need to make sure that the vehicle is existing in database!

MISCELLANEOUS

CHAT COMMANDS

EXPORTS

SCRIPT NOT WORKING / ERRORS