Exports
Client-side Exports
Export to check if player has a vehicle key
exports.ic3d_vehiclekeys:hasKey(identifier)
Examples:
exports.ic3d_vehiclekeys:hasKey('ABC123')
- Check by plate stringexports.ic3d_vehiclekeys:hasKey(vehicle)
- Check by vehicle entityexports.ic3d_vehiclekeys:hasKey()
- Check for closest vehicle
Export to get player key information
exports.ic3d_vehiclekeys:GetPlayerKey(vehicle)
Returns: hasKey, vehicleEntity, inCar, playerPed
Examples:
local hasKey, entity, inCar, ped = exports.ic3d_vehiclekeys:GetPlayerKey()
- Get info for closest vehiclelocal hasKey, entity, inCar, ped = exports.ic3d_vehiclekeys:GetPlayerKey(vehicleEntity)
- Get info for specific vehicle
Export to add a key (Useful for Dealerships, Garages and Jobs)
exports.ic3d_vehiclekeys:ClientInventoryKeys('add', plate)
Export to remove a key (Useful for Garages and Jobs)
exports.ic3d_vehiclekeys:ClientInventoryKeys('remove', plate)
Server-side Exports
Export to manage inventory keys server-side
exports.ic3d_vehiclekeys:InventoryKeys(action, data)
Examples:
exports.ic3d_vehiclekeys:InventoryKeys('add', {player = playerId, plate = 'ABC123'})
- Add key to playerexports.ic3d_vehiclekeys:InventoryKeys('remove', {player = playerId, plate = 'ABC123'})
- Remove key from player
Returns true
on success, false
on failure.
Usage Notes
All plate parameters should be strings (e.g., 'ABC123')
The
hasKey
export accepts either a plate string, vehicle entity number, or no parameter for closest vehicleThe
GetPlayerKey
export is useful for getting detailed information about the player's relationship to a vehicleServer-side
InventoryKeys
requires a data table withplayer
(source ID) andplate
fieldsClient-side
ClientInventoryKeys
automatically uses the current player and triggers the server-side function
If your script doesn't have the plate defined, fetch it like this example bellow
function giveKeys(vehicle)
local plate = GetVehicleNumberPlateText(vehicle)
exports.ic3d_vehiclekeys:ClientInventoryKeys('add', plate)
end
Last updated
Was this helpful?