Exports

Client and server exports provided by filo_vehiclekeys for use in other resources.

Server

`GiveKeys`

Give a player a key item for a vehicle.

exports.filo_vehiclekeys:GiveKeys(source --[[number]], vehicle --[[entity]])

`GiveKeysByPlate`

Give a player a key item by plate string directly.

exports.filo_vehiclekeys:GiveKeysByPlate(source --[[number]], plate --[[string]])

`RemoveKeys`

Remove a player's key item for a vehicle.

exports.filo_vehiclekeys:RemoveKeys(source --[[number]], vehicle --[[entity]])

`RemoveKeysByPlate`

exports.filo_vehiclekeys:RemoveKeysByPlate(source --[[number]], plate --[[string]])

`GiveJobKeys`

Grant job-restricted access to a vehicle. Does not give a physical key item — access is checked at runtime against the player's current job.

exports.filo_vehiclekeys:GiveJobKeys(plate --[[string]], job --[[string]])

`RemoveJobKeys`

exports.filo_vehiclekeys:RemoveJobKeys(plate --[[string]], job --[[string]])

`SetKeysInIgnition`

Set whether keys are currently in the ignition for a vehicle. Used to grant temporary access without giving a permanent key item.

exports.filo_vehiclekeys:SetKeysInIgnition(
    plate         --[[string]],
    keysInIgnition --[[boolean]],
    canRemove     --[[boolean]]  -- whether the player can physically remove the keys
)

`IsKeysInIgnition`

Check whether keys are currently in the ignition for a vehicle.

local keysInIgnition = exports.filo_vehiclekeys:IsKeysInIgnition(entity --[[entity|netId]])

`SetLockState`

Directly set the lock state of a vehicle by net ID.

exports.filo_vehiclekeys:SetLockState(netId --[[number]], state --[[boolean]])

Client

`GiveKeys`

Give the local player a key for a vehicle entity.

exports.filo_vehiclekeys:GiveKeys(vehicle --[[entity]])
exports.filo_vehiclekeys:GiveKeysByPlate(plate --[[string]])

`RemoveKeys`

Remove the local player's key for a vehicle.

exports.filo_vehiclekeys:RemoveKeys(vehicle --[[entity]])
exports.filo_vehiclekeys:RemoveKeysByPlate(plate --[[string]])

`HasKeys`

Returns the key item if the local player has a valid key for the vehicle, or false.

local key = exports.filo_vehiclekeys:HasKeys(vehicle --[[entity]])
local key = exports.filo_vehiclekeys:HasKeysByPlate(plate --[[string]])

`HasJobKeys`

Returns true if the local player's current job grants access to the vehicle.

local hasAccess = exports.filo_vehiclekeys:HasJobKeys(vehicle --[[entity]])
local hasAccess = exports.filo_vehiclekeys:HasJobKeysByPlate(plate --[[string]])