refactor(vehicleKey): enhance key management functions with assertions, improved documentation and remove vehicle keys where they was missing

This commit is contained in:
XenoS-ITA committed 2025-08-21 01:23:58 +02:00
1 parent 3289711297
commit 9e810d4b24
13 files changed
+271 -44

No files matched your search

@@ -1,15 +1,39 @@
---@diagnostic disable: duplicate-set-field
local resourceName = "F_RealCarKeysSystem"
if GetResourceState(resourceName) == 'missing' then return end
VehicleKey = VehicleKey or {}
---Gives the player (self) the keys of the specified vehicle.
---@param vehicle number The vehicle entity handle.
---@param plate? string The plate of the vehicle.
---@return nil
VehicleKey.GiveKeys = function(vehicle, plate)
if not plate then return false end
assert(vehicle, "vehicle is nil")
assert(DoesEntityExist(vehicle), "vehicle does not exist")
if not plate then
plate = GetVehicleNumberPlateText(vehicle)
end
TriggerServerEvent('F_RealCarKeysSystem:generateVehicleKeys', plate)
end
-- TODO: Test, documentation of the script is missing
---Removes the keys of the specified vehicle from the player (self).
---@param vehicle number The vehicle entity handle.
---@param plate? string The plate of the vehicle.
---@return nil
VehicleKey.RemoveKeys = function(vehicle, plate)
return true
assert(vehicle, "vehicle is nil")
assert(DoesEntityExist(vehicle), "vehicle does not exist")
if not plate then
plate = GetVehicleNumberPlateText(vehicle)
end
TriggerServerEvent('F_RealCarKeysSystem:removeVehicleKeysByPlate', plate)
end
return VehicleKey