From 9e810d4b247009db594e65a22c374231d54e0341 Mon Sep 17 00:00:00 2001 From: XenoS-ITA Date: Thu, 21 Aug 2025 01:23:58 +0200 Subject: [PATCH] refactor(vehicleKey): enhance key management functions with assertions, improved documentation and remove vehicle keys where they was missing --- .../F_RealCarKeysSystem/client/client.lua | 28 +++++++++++++++-- .../MrNewbVehicleKeys/client/client.lua | 24 +++++++++++++-- .../Renewed-Vehiclekeys/client/client.lua | 24 +++++++++++++-- modules/vehicleKey/_default/client/client.lua | 19 ++++++------ .../vehicleKey/cd_garage/client/client.lua | 18 +++++++++-- modules/vehicleKey/jacksam/client.lua | 28 ++++++++++++++--- .../mk_vehiclekeys/client/client.lua | 21 ++++++++++--- .../vehicleKey/okokGarage/client/client.lua | 26 ++++++++++++++-- .../qb-vehiclekeys/client/client.lua | 24 +++++++++++++-- .../qbx_vehiclekeys/client/client.lua | 27 +++++++++++++++-- .../qs-vehiclekeys/client/client.lua | 30 +++++++++++++++---- .../vehicleKey/t1ger_keys/client/client.lua | 22 +++++++++++--- .../wasabi_carlock/client/client.lua | 24 +++++++++++++-- 13 files changed, 271 insertions(+), 44 deletions(-) diff --git a/modules/vehicleKey/F_RealCarKeysSystem/client/client.lua b/modules/vehicleKey/F_RealCarKeysSystem/client/client.lua index 249c770..9426293 100644 --- a/modules/vehicleKey/F_RealCarKeysSystem/client/client.lua +++ b/modules/vehicleKey/F_RealCarKeysSystem/client/client.lua @@ -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 \ No newline at end of file diff --git a/modules/vehicleKey/MrNewbVehicleKeys/client/client.lua b/modules/vehicleKey/MrNewbVehicleKeys/client/client.lua index a05405f..bfd4a99 100644 --- a/modules/vehicleKey/MrNewbVehicleKeys/client/client.lua +++ b/modules/vehicleKey/MrNewbVehicleKeys/client/client.lua @@ -4,13 +4,33 @@ 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 + return exports.MrNewbVehicleKeys:GiveKeysByPlate(plate) end +---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) - 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 + return exports.MrNewbVehicleKeys:RemoveKeysByPlate(plate) end diff --git a/modules/vehicleKey/Renewed-Vehiclekeys/client/client.lua b/modules/vehicleKey/Renewed-Vehiclekeys/client/client.lua index 62e4da7..69653bc 100644 --- a/modules/vehicleKey/Renewed-Vehiclekeys/client/client.lua +++ b/modules/vehicleKey/Renewed-Vehiclekeys/client/client.lua @@ -4,13 +4,33 @@ 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 + return exports['Renewed-Vehiclekeys']:addKey(plate) end +---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) - 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 + return exports['Renewed-Vehiclekeys']:removeKey(plate) end diff --git a/modules/vehicleKey/_default/client/client.lua b/modules/vehicleKey/_default/client/client.lua index adb02d3..6d66938 100644 --- a/modules/vehicleKey/_default/client/client.lua +++ b/modules/vehicleKey/_default/client/client.lua @@ -1,19 +1,20 @@ ---@diagnostic disable: duplicate-set-field VehicleKey = VehicleKey or {} ----This will give keys to the specifed vehicle/plate. ----@param vehicle number The vehicle entity ID. ----@param plate string The plate of the vehicle. +---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) - return true, Prints.Error("There Is No Vehicle Key System Installed") + Prints.Info("There is no compatible vehicle key resource.") end ----This will remove keys from the specifed vehicle/plate. ----@param vehicle number The vehicle entity ID. ----@param plate string The plate of the vehicle. ----@return boolean | nil +---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, Prints.Error("There Is No Vehicle Key System Installed") + Prints.Info("There is no compatible vehicle key resource.") end return VehicleKey \ No newline at end of file diff --git a/modules/vehicleKey/cd_garage/client/client.lua b/modules/vehicleKey/cd_garage/client/client.lua index 9ab85d1..d45dc23 100644 --- a/modules/vehicleKey/cd_garage/client/client.lua +++ b/modules/vehicleKey/cd_garage/client/client.lua @@ -4,13 +4,27 @@ 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 + TriggerEvent('cd_garage:AddKeys', plate) end +---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 + Prints.Info("cd_garage doesnt support removing keys.") end return VehicleKey \ No newline at end of file diff --git a/modules/vehicleKey/jacksam/client.lua b/modules/vehicleKey/jacksam/client.lua index 0da5d3e..d47b413 100644 --- a/modules/vehicleKey/jacksam/client.lua +++ b/modules/vehicleKey/jacksam/client.lua @@ -4,14 +4,34 @@ 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 - return TriggerServerEvent("vehicles_keys:selfGiveVehicleKeys", plate) + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + if not plate then + plate = GetVehicleNumberPlateText(vehicle) + end + + TriggerServerEvent("vehicles_keys:selfGiveVehicleKeys", plate) end +---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) - if not plate then return false end - return TriggerServerEvent("vehicles_keys:selfRemoveKeys", plate) + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + if not plate then + plate = GetVehicleNumberPlateText(vehicle) + end + + TriggerServerEvent("vehicles_keys:selfRemoveKeys", plate) end return VehicleKey \ No newline at end of file diff --git a/modules/vehicleKey/mk_vehiclekeys/client/client.lua b/modules/vehicleKey/mk_vehiclekeys/client/client.lua index 0c7d643..cf2c004 100644 --- a/modules/vehicleKey/mk_vehiclekeys/client/client.lua +++ b/modules/vehicleKey/mk_vehiclekeys/client/client.lua @@ -1,16 +1,29 @@ ---@diagnostic disable: duplicate-set-field local resourceName = "mk_vehiclekeys" 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 vehicle and not DoesEntityExist(vehicle) then return false end - return exports["mk_vehiclekeys"]:AddKey(vehicle) + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + exports["mk_vehiclekeys"]:AddKey(vehicle) end +---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) - if not vehicle and not DoesEntityExist(vehicle) then return false end - return exports["mk_vehiclekeys"]:RemoveKey(vehicle) + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + exports["mk_vehiclekeys"]:RemoveKey(vehicle) end return VehicleKey \ No newline at end of file diff --git a/modules/vehicleKey/okokGarage/client/client.lua b/modules/vehicleKey/okokGarage/client/client.lua index 705c2f0..fee3fa4 100644 --- a/modules/vehicleKey/okokGarage/client/client.lua +++ b/modules/vehicleKey/okokGarage/client/client.lua @@ -4,13 +4,35 @@ 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('okokGarage:GiveKeys', plate) end +---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 + + local source = GetPlayerServerId(PlayerId()) + TriggerServerEvent("okokGarage:RemoveKeys", plate, source) end return VehicleKey \ No newline at end of file diff --git a/modules/vehicleKey/qb-vehiclekeys/client/client.lua b/modules/vehicleKey/qb-vehiclekeys/client/client.lua index 861c8d8..bc01002 100644 --- a/modules/vehicleKey/qb-vehiclekeys/client/client.lua +++ b/modules/vehicleKey/qb-vehiclekeys/client/client.lua @@ -4,13 +4,33 @@ 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("qb-vehiclekeys:server:AcquireVehicleKeys", plate) end +---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) - 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 + TriggerEvent("qb-vehiclekeys:client:RemoveKeys", plate) end diff --git a/modules/vehicleKey/qbx_vehiclekeys/client/client.lua b/modules/vehicleKey/qbx_vehiclekeys/client/client.lua index 0502ac1..69c4ac9 100644 --- a/modules/vehicleKey/qbx_vehiclekeys/client/client.lua +++ b/modules/vehicleKey/qbx_vehiclekeys/client/client.lua @@ -4,13 +4,34 @@ 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 - TriggerServerEvent('qb-vehiclekeys:server:AcquireVehicleKeys', plate) + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + if not plate then + plate = GetVehicleNumberPlateText(vehicle) + end + + TriggerServerEvent("qb-vehiclekeys:server:AcquireVehicleKeys", plate) end +---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 + + TriggerEvent("qb-vehiclekeys:client:RemoveKeys", plate) end return VehicleKey \ No newline at end of file diff --git a/modules/vehicleKey/qs-vehiclekeys/client/client.lua b/modules/vehicleKey/qs-vehiclekeys/client/client.lua index 2280713..06bdfdd 100644 --- a/modules/vehicleKey/qs-vehiclekeys/client/client.lua +++ b/modules/vehicleKey/qs-vehiclekeys/client/client.lua @@ -4,18 +4,36 @@ 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 vehicle then return false end + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + if not plate then + plate = GetVehicleNumberPlateText(vehicle) + end + local model = GetDisplayNameFromVehicleModel(GetEntityModel(vehicle)) - local verifiedPlate = GetVehicleNumberPlateText(vehicle) - return exports['qs-vehiclekeys']:GiveKeys(verifiedPlate, model, true) + return exports['qs-vehiclekeys']:GiveKeys(plate, model, true) end +---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) - if not vehicle then return false end + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + if not plate then + plate = GetVehicleNumberPlateText(vehicle) + end + local model = GetDisplayNameFromVehicleModel(GetEntityModel(vehicle)) - local verifiedPlate = GetVehicleNumberPlateText(vehicle) - return exports['qs-vehiclekeys']:RemoveKeys(verifiedPlate, model) + return exports['qs-vehiclekeys']:RemoveKeys(plate, model) end return VehicleKey \ No newline at end of file diff --git a/modules/vehicleKey/t1ger_keys/client/client.lua b/modules/vehicleKey/t1ger_keys/client/client.lua index a040a7a..e996071 100644 --- a/modules/vehicleKey/t1ger_keys/client/client.lua +++ b/modules/vehicleKey/t1ger_keys/client/client.lua @@ -4,14 +4,28 @@ 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 DoesEntityExist(vehicle) then return false end - local vehicle_display_name = GetDisplayNameFromVehicleModel(GetEntityModel(vehicle)) - return exports['t1ger_keys']:GiveTemporaryKeys(plate, vehicle_display_name, 'some_keys') + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + if not plate then + plate = GetVehicleNumberPlateText(vehicle) + end + + local model = GetDisplayNameFromVehicleModel(GetEntityModel(vehicle)) + return exports['t1ger_keys']:GiveTemporaryKeys(plate, model, '') end +---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) - + Prints.Info("t1ger_keys doesnt support removing keys.") end return VehicleKey \ No newline at end of file diff --git a/modules/vehicleKey/wasabi_carlock/client/client.lua b/modules/vehicleKey/wasabi_carlock/client/client.lua index bde20f5..328699d 100644 --- a/modules/vehicleKey/wasabi_carlock/client/client.lua +++ b/modules/vehicleKey/wasabi_carlock/client/client.lua @@ -4,13 +4,33 @@ 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 and vehicle then plate = GetVehicleNumberPlateText(vehicle) end + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + if not plate then + plate = GetVehicleNumberPlateText(vehicle) + end + exports.wasabi_carlock:GiveKey(plate) end +---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) - if not plate and vehicle then plate = GetVehicleNumberPlateText(vehicle) end + assert(vehicle, "vehicle is nil") + assert(DoesEntityExist(vehicle), "vehicle does not exist") + + if not plate then + plate = GetVehicleNumberPlateText(vehicle) + end + exports.wasabi_carlock:RemoveKey(plate) end