feat(shared): move getIsVehicleBlacklisted and getIsVehicleImmune to shared

Author: artur-michalak

client/functions.lua

@@ -1,10 +1,14 @@
 local config = require 'config.client'
 local functions = require 'shared.functions'
-local isCloseToCoords = functions.isCloseToCoords
+local getIsCloseToCoords = functions.getIsCloseToCoords
+local getIsVehicleBlacklisted = functions.getIsVehicleBlacklisted
+local getIsVehicleImmune = functions.getIsVehicleImmune
 
 local alertSend = false
 local public = {}
 
+public.getIsVehicleImmune = getIsVehicleImmune -- to prevent circular-dependency error
+
 ---Checks if player has vehicle keys
 ---@param plate string The plate number of the vehicle.
 ---@return boolean? `true` if player has vehicle keys, `nil` otherwise.
@@ -28,17 +32,12 @@ 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.
-function public.isBlacklistedVehicle(vehicle)
+function public.getIsVehicleBlacklisted(vehicle)
     if Entity(vehicle).state.ignoreLocks or GetVehicleClass(vehicle) == 13 then
         return true
     end
 
-    local vehicleHash = GetEntityModel(vehicle)
-    for i = 1, #config.noLockVehicles do
-        if vehicleHash == joaat(config.noLockVehicles[i]) then
-            return true
-        end
-    end
+    return getIsVehicleBlacklisted(vehicle)
 end
 
 function public.attemptPoliceAlert(type)
@@ -80,10 +79,10 @@ end
 ---@param bones table
 ---@param maxDistance number
 ---@return boolean? `true` if bone exists, `nil` otherwise.
-local function isCloseToAnyBone(coords, entity, bones, maxDistance)
+local function getIsCloseToAnyBone(coords, entity, bones, maxDistance)
     for i = 1, #bones do
         local boneCoords = getBoneCoords(entity, bones[i])
-        if isCloseToCoords(coords, boneCoords, maxDistance) then
+        if getIsCloseToCoords(coords, boneCoords, maxDistance) then
             return true
         end
     end
@@ -95,13 +94,13 @@ local doorBones = {'door_dside_f', 'door_dside_r', 'door_pside_f', 'door_pside_r
 ---@param vehicle number The entity number of the vehicle.
 ---@param maxDistance number The max distance to check.
 ---@return boolean? `true` if the player ped is next to an open vehicle, `nil` otherwise.
-local function isVehicleInRange(vehicle, maxDistance)
+local function getIsVehicleInRange(vehicle, maxDistance)
     local vehicles = GetGamePool('CVehicle')
     local pedCoords = GetEntityCoords(cache.ped)
     for i = 1, #vehicles do
         local v = vehicles[i]
         if not cache.vehicle or v ~= cache.vehicle then
-            if vehicle == v and isCloseToAnyBone(pedCoords, vehicle, doorBones, maxDistance) then
+            if vehicle == v and getIsCloseToAnyBone(pedCoords, vehicle, doorBones, maxDistance) then
                 return true
             end
         end
@@ -173,7 +172,7 @@ function public.lockpickDoor(isAdvancedLockedpick, maxDistance, customChallenge)
     if not isDriverSeatFree -- no one in the driver's seat
         or public.hasKeys(plate) -- player does not have keys to the vehicle
         or Entity(vehicle).state.isOpen -- the lock is locked
-        or not isCloseToAnyBone(pedCoords, vehicle, doorBones, maxDistance) -- the player's ped is close enough to the driver's door
+        or not getIsCloseToAnyBone(pedCoords, vehicle, doorBones, maxDistance) -- the player's ped is close enough to the driver's door
         or GetVehicleDoorLockStatus(vehicle) < 2 -- the vehicle is locked
         or (not isAdvancedLockedpick and config.advancedLockpickVehicleClasses[class])
     then return end
@@ -185,7 +184,7 @@ function public.lockpickDoor(isAdvancedLockedpick, maxDistance, customChallenge)
         lib.playAnim(cache.ped, 'veh@break_in@0h@p_m_one@', "low_force_entry_ds", 3.0, 3.0, -1, 16, 0, false, false, false) -- lock opening animation
         local isSuccess = customChallenge or lib.skillCheck({ 'easy', 'easy', { areaSize = 60, speedMultiplier = 1 }, 'medium' }, { '1', '2', '3', '4' })
 
-        if isVehicleInRange(vehicle, maxDistance) then -- the action will be aborted if the opened vehicle is too far.
+        if getIsVehicleInRange(vehicle, maxDistance) then -- the action will be aborted if the opened vehicle is too far.
             lockpickCallback(vehicle, isAdvancedLockedpick, isSuccess)
         end
 

client/main.lua

@@ -10,9 +10,10 @@ local hotwire = functions.hotwire
 local lockpickDoor = functions.lockpickDoor
 local attemptPoliceAlert = functions.attemptPoliceAlert
 local isBlacklistedWeapon = functions.isBlacklistedWeapon
-local isBlacklistedVehicle = functions.isBlacklistedVehicle
+local getIsVehicleBlacklisted = functions.getIsVehicleBlacklisted
 local getVehicleByPlate = functions.getVehicleByPlate
 local areKeysJobShared = functions.areKeysJobShared
+local getIsVehicleImmune = functions.getIsVehicleImmune
 
 -----------------------
 ----   Variables   ----
@@ -72,7 +73,7 @@ end
 ---@param anim any Aniation
 local function setVehicleDoorLock(vehicle, state, anim)
     if not vehicle then return end
-    if not isBlacklistedVehicle(vehicle) then
+    if not getIsVehicleBlacklisted(vehicle) then
         if hasKeys(qbx.getVehiclePlate(vehicle)) or areKeysJobShared(vehicle) then
 
             if anim then
@@ -180,7 +181,7 @@ local function showHotwiringLabel()
             local plate = qbx.getVehiclePlate(cache.vehicle)
             if cache.seat == -1
                 and not hasKeys(plate)
-                and not isBlacklistedVehicle(cache.vehicle)
+                and not getIsVehicleBlacklisted(cache.vehicle)
                 and not areKeysJobShared(cache.vehicle)
             then
                 local vehiclePos = GetOffsetFromEntityInWorldCoords(cache.vehicle, 0.0, 1.0, 0.5)
@@ -311,12 +312,7 @@ local function watchCarjackingAttempts()
                     and not IsPedAPlayer(target)
                 then
                     local targetveh = GetVehiclePedIsIn(target, false)
-                    local isVehicleImmune = false
-                    for i = 1, #config.immuneVehicles do
-                        if GetEntityModel(targetveh) == joaat(config.immuneVehicles[i]) then
-                            isVehicleImmune = true
-                        end
-                    end
+                    local isVehicleImmune = getIsVehicleImmune(targetveh)
 
                     if not isVehicleImmune
                         and GetPedInVehicleSeat(targetveh, -1) == target
@@ -367,14 +363,8 @@ engineBind = lib.addKeybind({
 
 RegisterNetEvent('QBCore:Client:VehicleInfo', function(data)
     if not LocalPlayer.state.isLoggedIn and data.event ~= 'Entering' then return end
-    if isBlacklistedVehicle(data.vehicle) then return end
-    local isVehicleImmune
-    for i = 1, #config.immuneVehicles do
-        if GetEntityModel(data.vehicle) == joaat(config.immuneVehicles[i]) then
-            isVehicleImmune = true
-        end
-    end
-
+    if getIsVehicleBlacklisted(data.vehicle) then return end
+    local isVehicleImmune = getIsVehicleImmune(data.vehicle)
     local driver = GetPedInVehicleSeat(data.vehicle, -1)
     local plate = qbx.getVehiclePlate(data.vehicle)
 

config/client.lua

@@ -178,16 +178,6 @@ return {
         }
     },
 
-    -- Vehicles that cannot be jacked
-    immuneVehicles = {
-        'stockade'
-    },
-
-    -- Vehicles that will never lock example:
-    noLockVehicles = {
-        -- 'stockade' -- example
-    },
-
     -- Weapons that cannot be used for carjacking
     noCarjackWeapons = {
         "WEAPON_UNARMED",

config/shared.lua

@@ -0,0 +1,11 @@
+return {
+    -- Vehicles that will never lock example:
+    noLockVehicles = {
+        -- 'stockade' -- example
+    },
+
+    -- Vehicles that cannot be jacked
+    immuneVehicles = {
+        'stockade'
+    },
+}

fxmanifest.lua

@@ -25,7 +25,8 @@ server_scripts {
 
 files {
     'locales/*.json',
-    'config/client.lua'
+    'config/client.lua',
+    'config/shared.lua'
 }
 
 dependencies {

shared/functions.lua

@@ -1,12 +1,33 @@
 local public = {}
+local config = require 'config.shared'
 
 --- Checks if the given two coordinates are close to each other based on distance.
 ---@param coord1 vector3[] The first set of coordinates.
 ---@param coord2 vector3[] The second set of coordinates.
 ---@param distance number The maximum allowed distance for them to be considered close.
 ---@return boolean true if the distance between two entities is less than the distance parameter.
-function public.isCloseToCoords(coord1, coord2, distance)
+function public.getIsCloseToCoords(coord1, coord2, distance)
     return #(coord1 - coord2) < distance
 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.
+function public.getIsVehicleBlacklisted(vehicle)
+    local vehicleHash = GetEntityModel(vehicle)
+    for i = 1, #config.noLockVehicles do
+        if vehicleHash == joaat(config.noLockVehicles[i]) then
+            return true
+        end
+    end
+end
+
+function public.getIsVehicleImmune(vehicle)
+    for i = 1, #config.immuneVehicles do
+        if GetEntityModel(vehicle) == joaat(config.immuneVehicles[i]) then
+            return true
+        end
+    end
+end
+
 return public