Advanced Vehiclekeys

A comprehensive vehicle key management system for FiveM servers with ESX, QBCore, and QBX support.

Client Exports

Utilize these client-side exports to interact with the vehicle keys system:

Key Management

-- Check for possession of vehicle keys
local hasKeys = exports['ejj_vehiclekeys']:hasKeys(vehicle)

-- Acquire vehicle keys by plate number
local hasKeys = exports['ejj_vehiclekeys']:hasKeysForPlate('ABC123')

-- Grant vehicle keys to a player
exports['ejj_vehiclekeys']:giveKeys('ABC123')

-- Remove vehicle keys from a player
exports['ejj_vehiclekeys']:removeKeys('ABC123')

Vehicle Operations

-- Retrieve current player vehicle
local vehicle = exports['ejj_vehiclekeys']:getCurrentVehicle()

-- Verify if inside a vehicle
local inVehicle = exports['ejj_vehiclekeys']:isInVehicle()

Functional Actions

-- Access keys management menu
exports['ejj_vehiclekeys']:openKeysMenu()

-- Initiate lockpicking feature
exports['ejj_vehiclekeys']:performLockpick()

-- Dispatch alert notification to police
exports['ejj_vehiclekeys']:policeDispatch({
    coords = vector3(x, y, z),
    street = "Street Name",
    plate = "ABC123",
    success = false
})

Server Exports

Incorporate these server-side exports in your scripts:

Key Management

-- Assign keys to a specific player
exports['ejj_vehiclekeys']:giveKeys(playerId, 'ABC123')

-- Revoke keys from a specific player
exports['ejj_vehiclekeys']:removeKeys(playerId, 'ABC123')

-- Determine if a player holds keys
local hasKeys = exports['ejj_vehiclekeys']:hasKeys(playerId, 'ABC123')

-- Verify player access to vehicle
local canUse = exports['ejj_vehiclekeys']:canUseVehicle(playerId, 'ABC123')

-- Retrieve all keys held by a player
local keys = exports['ejj_vehiclekeys']:getPlayerKeys(playerId)

Hotwire System

-- Mark vehicle as hotwired
exports['ejj_vehiclekeys']:setHotwired('ABC123')

-- Determine hotwire status of vehicle
local isHotwired = exports['ejj_vehiclekeys']:isHotwired('ABC123')

-- Reset hotwire status
exports['ejj_vehiclekeys']:clearHotwired('ABC123')

Integration Examples

Garage System

-- Grant keys upon garage retrieval
exports['ejj_vehiclekeys']:giveKeys(plate)

-- Remove keys when storing vehicle
exports['ejj_vehiclekeys']:removeKeys(plate)

Job Functionality

-- Issue vehicle keys based on job role
if playerJob == 'police' then
    exports['ejj_vehiclekeys']:giveKeys(policeVehiclePlate)
end

For customized configurations and advanced features, adjust settings within config.lua.