fix: small issues

- Added getVehicleByPlate function
- Adjusted main client loop to check for player ownership when parked
- Added plate to givekey
- Fixed commands not grabbing name from locale
- Made vehicleList be populated by the database on start

Author: BerkieBb

client/functions.lua

@@ -5,7 +5,7 @@ local getHash, isCloseToCoords in functions
 local alertSend = false
 local public = {}
 
---- Checks if the current player has a key for the specified vehicle.
+---Checks if the current player has a key for the specified vehicle.
 ---@param vehicle number The entity number of the vehicle to check for a key.
 ---@return boolean? `true` if the player has a key for the vehicle, nil otherwise.
 function HasKey(vehicle)
@@ -15,31 +15,31 @@ function HasKey(vehicle)
     return ent.state.keys[QBX.PlayerData.citizenid]
 end
 
---- Attempt to Give a key to a target player for the specified vehicle.
+---Attempt to Give a key to a target player for the specified vehicle.
 ---@param targetPlayerId number The ID of the target player who will receive the key.
 ---@param vehicle number The entity number of the vehicle for which the key is being given.
 function GiveKey(targetPlayerId, vehicle)
     -- This function is not yet implemented
     -- Will call the corresponding callback
 end
 
---- Attempt to Remove a key from a target player for the specified vehicle.
+---Attempt to Remove a key from a target player for the specified vehicle.
 ---@param targetPlayerId number The ID of the target player from whom the key is being removed.
 ---@param vehicle number The entity number of the vehicle from which the key is being removed.
 function RemoveKey(targetPlayerId, vehicle)
     -- This function is not yet implemented
     -- Will call the corresponding callback
 end
 
---- Toggles the state of a vehicle's doors. If a door is open, it will be closed, and if it's closed, it will be opened.
+---Toggles the state of a vehicle's doors. If a door is open, it will be closed, and if it's closed, it will be opened.
 ---@param vehicle number The entity number of the vehicle for which the door state is being toggled.
 function ToggleVehicleDoor(vehicle)
     -- This function is not yet implemented
     -- Will call the corresponding callback
 end
 
---- Checking weapon on the blacklist.
---- @return boolean? `true` if the vehicle is blacklisted, nil otherwise.
+---Checking weapon on the blacklist.
+---@return boolean? `true` if the vehicle is blacklisted, nil otherwise.
 function public.isBlacklistedWeapon()
     local weapon = GetSelectedPedWeapon(cache.ped)
 
@@ -48,9 +48,9 @@ function public.isBlacklistedWeapon()
     end
 end
 
---- Checking vehicle on the blacklist.
---- @param vehicle number The entity number of the vehicle.
---- @return boolean? `true` if the vehicle is blacklisted, nil otherwise.
+---Checking vehicle on the blacklist.
+---@param vehicle number The entity number of the vehicle.
+---@return boolean? `true` if the vehicle is blacklisted, nil otherwise.
 function public.isBlacklistedVehicle(vehicle)
     if Entity(vehicle).state.ignoreLocks or GetVehicleClass(vehicle) == 13 then return true end
 
@@ -76,10 +76,10 @@ function public.attemptPoliceAlert(type)
     end
 end
 
---- Gets bone coords
---- @param vehicle number The entity number of the vehicle.
---- @param boneName string The entity bone name.
---- @return vector3 Bone coords if exists, entity coords otherwise.
+---Gets bone coords
+---@param vehicle number The entity number of the vehicle.
+---@param boneName string The entity bone name.
+---@return vector3 Bone coords if exists, entity coords otherwise.
 local function getBoneCoords(vehicle, boneName)
     local boneIndex = GetEntityBoneIndexByName(vehicle, boneName)
 
@@ -90,10 +90,10 @@ local function getBoneCoords(vehicle, boneName)
     end
 end
 
---- Checking whether the character is close enough to the vehicle driver door.
---- @param vehicle number The entity number of the vehicle.
---- @param maxDistance number The max distance to check.
---- @return boolean? `true` if the ped is out of a vehicle and in the range of the opened vehicle, nil otherwise.
+---Checking whether the character is close enough to the vehicle driver door.
+---@param vehicle number The entity number of the vehicle.
+---@param maxDistance number The max distance to check.
+---@return boolean? `true` if the ped is out of a vehicle and in the range of the opened vehicle, nil otherwise.
 local function isVehicleInRange(vehicle, maxDistance)
     local vehicles = GetGamePool('CVehicle')
     local pedCoords = GetEntityCoords(cache.ped)
@@ -108,9 +108,9 @@ local function isVehicleInRange(vehicle, maxDistance)
     end
 end
 
---- The function will be execuded when the opening of the lock succeeds.
---- @param vehicle number The entity number of the vehicle.
---- @param plate string The plate number of the vehicle.
+---The function will be execuded when the opening of the lock succeeds.
+---@param vehicle number The entity number of the vehicle.
+---@param plate string The plate number of the vehicle.
 local function lockpickSuccessCallback(vehicle, plate)
     TriggerServerEvent('hud:server:GainStress', math.random(1, 4))
 
@@ -123,12 +123,12 @@ local function lockpickSuccessCallback(vehicle, plate)
     end
 end
 
---- Operations done after the LockpickDoor quickevent done.
---- @param vehicle number The entity number of the vehicle.
---- @param plate string The plate number of the vehicle.
---- @param isAdvancedLockedpick boolean Determines whether an advanced lockpick was used.
---- @param maxDistance number The max distance to check.
---- @param isSuccess boolean? Determines whether the lock has been successfully opened.
+---Operations done after the LockpickDoor quickevent done.
+---@param vehicle number The entity number of the vehicle.
+---@param plate string The plate number of the vehicle.
+---@param isAdvancedLockedpick boolean Determines whether an advanced lockpick was used.
+---@param maxDistance number The max distance to check.
+---@param isSuccess boolean? Determines whether the lock has been successfully opened.
 local function lockpickCallback(vehicle, plate, isAdvancedLockedpick, maxDistance, isSuccess)
     if not isVehicleInRange(vehicle, maxDistance) then return end -- the action will be aborted if the opened vehicle is too far.
     if isSuccess then
@@ -152,8 +152,9 @@ local function lockpickCallback(vehicle, plate, isAdvancedLockedpick, maxDistanc
 end
 
 local lockpickingSemaphore = 0
---- Lockpicking quickevent.
---- @param isAdvancedLockedpick boolean Determines whether an advanced lockpick was used
+
+---Lockpicking quickevent.
+---@param isAdvancedLockedpick boolean Determines whether an advanced lockpick was used
 function public.lockpickDoor(isAdvancedLockedpick)
     local maxDistance = 2
     local pedCoords = GetEntityCoords(cache.ped)
@@ -165,7 +166,7 @@ function public.lockpickDoor(isAdvancedLockedpick)
     local isDriverSeatFree = IsVehicleSeatFree(vehicle, -1)
     local doorCoords = getBoneCoords(vehicle, 'door_dside_f')
 
-    --- player may attempt to open the lock if:
+    -- player may attempt to open the lock if:
     if not vehicle
         or not plate
         or not isDriverSeatFree                                               -- no one in the driver's seat
@@ -182,7 +183,7 @@ function public.lockpickDoor(isAdvancedLockedpick)
     Wait(0)
 
     CreateThread(function()
-        --- lock opening animation
+        -- lock opening animation
         lib.requestAnimDict('veh@break_in@0h@p_m_one@')
         TaskPlayAnim(cache.ped, 'veh@break_in@0h@p_m_one@', "low_force_entry_ds", 3.0, 3.0, -1, 16, 0, false, false, false)
 
@@ -195,4 +196,17 @@ function public.lockpickDoor(isAdvancedLockedpick)
     lockpickingSemaphore = 0
 end
 
-return public
+---Get a vehicle in the players scope by the plate
+---@param plate string
+---@return integer?
+function public.getVehicleByPlate(plate)
+    local vehicles = GetGamePool('CVehicle')
+    for i = 1, #vehicles do
+        local vehicle = vehicles[i]
+        if qbx.getVehiclePlate(vehicle) == plate then
+            return vehicle
+        end
+    end
+end
+
+return public

client/main.lua

@@ -4,7 +4,7 @@
 
 local config = require 'config.client'
 local functions = require 'client.functions'
-local lockpickDoor, attemptPoliceAlert, isBlacklistedWeapon, isBlacklistedVehicle in functions
+local lockpickDoor, attemptPoliceAlert, isBlacklistedWeapon, isBlacklistedVehicle, getVehicleByPlate in functions
 
 -----------------------
 ----   Variables   ----
@@ -38,14 +38,13 @@ end
 local function hasKeys(plate)
     return KeysList[plate]
 end
+
 exports('HasKeys', hasKeys)
 
 local function getVehicleInDirection(coordFromOffset, coordToOffset)
-    local coordFrom = GetOffsetFromEntityInWorldCoords(cache.ped, coordFromOffset.x, coordFromOffset.y, coordFromOffset
-    .z)
+    local coordFrom = GetOffsetFromEntityInWorldCoords(cache.ped, coordFromOffset.x, coordFromOffset.y, coordFromOffset.z)
     local coordTo = GetOffsetFromEntityInWorldCoords(cache.ped, coordToOffset.x, coordToOffset.y, coordToOffset.z)
-    local rayHandle = CastRayPointToPoint(coordFrom.x, coordFrom.y, coordFrom.z, coordTo.x, coordTo.y, coordTo.z, 10,
-        cache.ped, 0)
+    local rayHandle = CastRayPointToPoint(coordFrom.x, coordFrom.y, coordFrom.z, coordTo.x, coordTo.y, coordTo.z, 10, cache.ped, 0)
     local _, _, _, _, vehicle = GetShapeTestResult(rayHandle)
     return vehicle
 end
@@ -63,7 +62,7 @@ local function getVehicle()
 
     local count = 0
     while not vehicle and count < #RaycastOffsetTable do
-        count = count + 1
+        count += 1
         vehicle = getVehicleInDirection(RaycastOffsetTable[count]['fromOffset'], RaycastOffsetTable[count]['toOffset'])
     end
 
@@ -102,10 +101,9 @@ local function setVehicleDoorLock(veh, state, anim)
                 end
 
                 TriggerServerEvent("InteractSound_SV:PlayWithinDistance", 5, "lock", 0.3)
-
                 NetworkRequestControlOfEntity(veh)
                 if state then
-                    state = state == true and 2 or 1
+                    state = not state and 1 or 2
                     TriggerServerEvent('qb-vehiclekeys:server:setVehLockState', NetworkGetNetworkIdFromEntity(veh), state)
                     exports.qbx_core:Notify(state == 2 and locale("notify.vehicle_locked") or locale("notify.vehicle_unlocked"), 'inform')
                 else
@@ -117,6 +115,7 @@ local function setVehicleDoorLock(veh, state, anim)
                         exports.qbx_core:Notify(locale("notify.vehicle_unlocked"), 'inform')
                     end
                 end
+
                 SetVehicleLights(veh, 2)
                 Wait(250)
                 SetVehicleLights(veh, 1)
@@ -132,7 +131,8 @@ local function setVehicleDoorLock(veh, state, anim)
         end
     end
 end
-exports("SetVehicleDoorLock", setVehicleDoorLock)
+
+exports('SetVehicleDoorLock', setVehicleDoorLock)
 
 local function getOtherPlayersInVehicle(vehicle)
     local otherPeds = {}
@@ -164,17 +164,16 @@ end
 local function hotwire(vehicle, plate)
     local hotwireTime = math.random(config.minHotwireTime, config.maxHotwireTime)
     isHotwiring = true
+
     SetVehicleAlarm(vehicle, true)
     SetVehicleAlarmTimeLeft(vehicle, 2)
 
     SetTimeout(hotwireTime * 2, function()
-        if not DoesEntityExist(vehicle) then return end
-        if not IsEntityAVehicle(vehicle) then return end
-        if isHotwiring then return end
-        if IsVehicleAlarmActivated(vehicle) then
-            SetVehicleAlarm(vehicle, false)
-        end
+        if not DoesEntityExist(vehicle) or not IsEntityAVehicle(vehicle) or isHotwiring or not IsVehicleAlarmActivated(vehicle) then return end
+
+        SetVehicleAlarm(vehicle, false)
     end)
+
     if lib.progressCircle({
         duration = hotwireTime,
         label = locale("progress.searching_keys"),
@@ -297,20 +296,18 @@ CreateThread(function()
         local sleep = 1000
         if LocalPlayer.state.isLoggedIn then
             sleep = 100
-
-
             local entering = GetVehiclePedIsTryingToEnter(cache.ped)
             local carIsImmune = false
             if entering ~= 0 and not isBlacklistedVehicle(entering) then
                 sleep = 2000
                 local plate = qbx.getVehiclePlate(entering)
-
                 local driver = GetPedInVehicleSeat(entering, -1)
-                for _, veh in ipairs(config.immuneVehicles) do
-                    if GetEntityModel(entering) == joaat(veh) then
+                for i = 1, #config.immuneVehicles do
+                    if GetEntityModel(entering) == joaat(config.immuneVehicles[i]) then
                         carIsImmune = true
                     end
                 end
+
                 -- Driven vehicle logic
                 if driver ~= 0 and not IsPedAPlayer(driver) and not hasKeys(plate) and not carIsImmune then
                     if IsEntityDead(driver) then
@@ -342,14 +339,15 @@ CreateThread(function()
 
                         --Make passengers flee
                         local pedsInVehicle = getPedsInVehicle(entering)
-                        for _, pedInVehicle in pairs(pedsInVehicle) do
+                        for i = 1, #pedsInVehicle do
+                            local pedInVehicle = pedsInVehicle[i]
                             if pedInVehicle ~= GetPedInVehicleSeat(entering, -1) then
                                 makePedFlee(pedInVehicle)
                             end
                         end
                     end
                 -- Parked car logic
-                elseif driver == 0 and not Entity(entering).state.isOpen and not hasKeys(plate) and not isTakingKeys then
+                elseif driver == 0 and Entity(entering).state.isOpen == false and not hasKeys(plate) and not isTakingKeys and not lib.callback.await('vehiclekeys:server:IsPlayerOwned', false, plate) then
                     if config.lockNPCParkedCars then
                         TriggerServerEvent('qb-vehiclekeys:server:setVehLockState', NetworkGetNetworkIdFromEntity(entering), 2)
                     else
@@ -381,11 +379,12 @@ CreateThread(function()
                 if aiming and (target ~= nil and target ~= 0) then
                     if DoesEntityExist(target) and IsPedInAnyVehicle(target, false) and not IsEntityDead(target) and not IsPedAPlayer(target) then
                         local targetveh = GetVehiclePedIsIn(target, false)
-                        for _, veh in ipairs(config.immuneVehicles) do
-                            if GetEntityModel(targetveh) == joaat(veh) then
+                        for i = 1, #config.immuneVehicles do
+                            if GetEntityModel(targetveh) == joaat(config.immuneVehicles[i]) then
                                 carIsImmune = true
                             end
                         end
+
                         if GetPedInVehicleSeat(targetveh, -1) == target and not isBlacklistedWeapon() then
                             local pos = GetEntityCoords(cache.ped, true)
                             local targetpos = GetEntityCoords(target, true)
@@ -397,6 +396,7 @@ CreateThread(function()
                 end
             end
         end
+
         Wait(sleep)
     end
 end)
@@ -436,7 +436,6 @@ RegisterNetEvent('qb-vehiclekeys:client:AddKeys', function(plate)
 
     if cache.vehicle then
         local vehicleplate = qbx.getVehiclePlate(cache.vehicle)
-
         if plate == vehicleplate then
             SetVehicleEngineOn(cache.vehicle, false, false, false)
         end
@@ -459,8 +458,8 @@ RegisterNetEvent('qb-vehiclekeys:client:ToggleEngine', function()
     end
 end)
 
-RegisterNetEvent('qb-vehiclekeys:client:GiveKeys', function(id)
-    local targetVehicle = getVehicle()
+RegisterNetEvent('qb-vehiclekeys:client:GiveKeys', function(id, plate)
+    local targetVehicle = plate and getVehicleByPlate(plate) or cache.vehicle or getVehicle()
 
     if targetVehicle then
         local targetPlate = qbx.getVehiclePlate(targetVehicle)
@@ -492,4 +491,4 @@ end)
 RegisterNetEvent('vehiclekeys:client:SetOwner', function(plate)
     TriggerServerEvent('qb-vehiclekeys:server:AcquireVehicleKeys', plate)
 end)
--- Backwards Compatibility ONLY -- Remove at some point --
+-- Backwards Compatibility ONLY -- Remove at some point --

locales/cs.json

@@ -8,6 +8,8 @@
     "givekeys": "Předejte někomu klíče. Pokud nemáte průkaz totožnosti, dejte je nejbližší osobě nebo všem ve vozidle.",
     "givekeys_id": "ID",
     "givekeys_id_help": "ID hráče",
+    "givekeys_plate": "SPZ",
+    "givekeys_plate_help": "SPZ",
     "remove_keys": "Odebrat někomu klíče od vozidla.",
     "remove_keys_id": "id",
     "remove_keys_id_help": "ID hráče",

locales/de.json

@@ -8,6 +8,8 @@
     "givekeys": "Übergebe die Schlüssel an jemanden. Wenn keine Bürger-ID angegeben, geht er an die nächstgelegene Person oder an alle Personen im Fahrzeug.",
     "givekeys_id": "id",
     "givekeys_id_help": "Bürger-ID",
+    "givekeys_plate": "kennzeichen",
+    "givekeys_plate_help": "Kennzeichen",
     "remove_keys": "Jemandem die Schlüssel eines Fahrzeugs abnehmen.",
     "remove_keys_id": "id",
     "remove_keys_id_help": "Bürger-ID",

locales/en.json

@@ -8,6 +8,8 @@
     "givekeys": "Hand over the keys to someone. If no ID, gives to closest person or everyone in the vehicle.",
     "givekeys_id": "id",
     "givekeys_id_help": "Player ID",
+    "givekeys_plate": "plate",
+    "givekeys_plate_help": "Plate",
     "remove_keys": "Remove keys to a vehicle for someone.",
     "remove_keys_id": "id",
     "remove_keys_id_help": "Player ID",

locales/es.json

@@ -8,6 +8,8 @@
     "givekeys": "Entregar llaves a alguien. Si no hay ID, entregar a la persona más cercana o a todos en el vehículo.",
     "givekeys_id": "id",
     "givekeys_id_help": "ID de jugador",
+    "givekeys_plate": "placa",
+    "givekeys_plate_help": "Placa",
     "remove_keys": "Quitar llaves de un vehículo a alguien.",
     "remove_keys_id": "id",
     "remove_keys_id_help": "ID de jugador",

locales/et.json

@@ -8,6 +8,8 @@
     "givekeys": "Andke võtmed kellelegi üle. Kui isikut tõendav dokument puudub, annab see lähimale inimesele või kõigile sõidukis viibijatele.",
     "givekeys_id": "id",
     "givekeys_id_help": "Mängija ID",
+    "givekeys_plate": "Numbrimärk",
+    "givekeys_plate_help": "Numbrimärk",
     "remove_keys": "Eemaldage kellegi jaoks sõiduki võtmed.",
     "remove_keys_id": "id",
     "remove_keys_id_help": "Mängija ID",