Version Bump

`2.0.11` - `2.0.12`

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: jixelpatterns
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: ['https://jimathy666.tebex.io/']

.github/workflows/notify-discord.yml

@@ -0,0 +1,17 @@
+name: Discord Commit Notifier
+
+on:
+  push:
+    branches:
+      - '*'  # triggers on all branches
+
+jobs:
+  notify:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Discord Commits
+        uses: Sniddl/discord-commits@v1.6
+        with:
+          webhook: ${{ secrets.DISCORD_WEBHOOK }}
+          template: "avatar-with-link"
+          include-extras: true

_versioncheck.lua

@@ -0,0 +1,54 @@
+local function parseVersion(version)
+    local parts = {}
+    for num in version:gmatch("%d+") do
+        table.insert(parts, tonumber(num))
+    end
+    return parts
+end
+
+local function compareVersions(current, newest)
+    local currentParts = parseVersion(current)
+    local newestParts = parseVersion(newest)
+    for i = 1, math.max(#currentParts, #newestParts) do
+        local c = currentParts[i] or 0
+        local n = newestParts[i] or 0
+        if c < n then return -1
+        elseif c > n then return 1 end
+    end
+    return 0 -- equal
+end
+
+function CheckBridgeVersion()
+    if IsDuplicityVersion() then
+		CreateThread(function()
+			Wait(4000)
+			local currentVersionRaw = GetResourceMetadata("jim_bridge", 'version')
+			PerformHttpRequest('https://raw.githubusercontent.com/jimathy/jim_bridge/master/version.txt', function(err, newestVersionRaw, headers)
+				if not newestVersionRaw then
+					print("^1Unable to run version check for ^7'^3jim_bridge^7' (^3"..currentVersionRaw.."^7)")
+					return
+				end
+
+				newestVersionRaw = newestVersionRaw:match("[^\r\n]+")
+				local compareResult = compareVersions(currentVersionRaw, newestVersionRaw)
+
+				if compareResult == 0 then
+					print("^7'^3jim_bridge^7' - ^2You are running the latest version^7. ^7(^3"..currentVersionRaw.."^7)")
+				elseif compareResult < 0 then
+					-- Made the check a bit more obvious
+					print("^1----------------------------------------------------------------------^7")
+					print("^7'^3jim_bridge^7' - ^1You are running an outdated version^7! ^7(^3"..currentVersionRaw.."^7 → ^3"..newestVersionRaw.."^7)")
+					print("^1----------------------------------------------------------------------^7")
+					SetTimeout(1200000, function()
+						-- Do a naughty repeat message every 20 minutes until the the script is updated
+						CheckBridgeVersion()
+					end)
+				else
+					print("^7'^3jim_bridge^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..newestVersionRaw.."^7)")
+				end
+			end)
+		end)
+	end
+end
+
+CheckBridgeVersion()

fxmanifest.lua

@@ -1,14 +1,19 @@
-name "Jim_Bridge"
+name "Jim_Bridge"
-author "Jimathy"
+author "Jimathy"
-version "2.0"
+version "2.0.12"
-description "Framework Bridge By Jimathy"
+description "Framework Bridge By Jimathy"
-fx_version "cerulean"
+fx_version "cerulean"
-game "gta5"
+rdr3_warning 'I acknowledge that this is a prerelease build of RedM, and I am aware my resources *will* become incompatible once RedM ships.'
-lua54 'yes'
+games { 'gta5', 'rdr3' }
-
+lua54 'yes'
-files {
+
-    'starter.lua',
+
-    'shared/*.lua',
+files {
-    'shared/make/*.lua',
+    'starter.lua',
-    'shared/scaleforms/*.lua',
+    'shared/*.lua',
-}
+    'shared/make/*.lua',
+    'shared/scaleforms/*.lua',
+}
+
+-- Version checker
+server_scripts { '_versioncheck.lua' }

shared/_eventDebug.lua

@@ -1,149 +1,149 @@
--- IN NO WAY PERFECT -- ** Experimental debugging
+-- IN NO WAY PERFECT -- ** Experimental debugging
-function toggleDebug()
+function toggleDebug()
-    Config.System.Debug = not Config.System.Debug
+    Config.System.Debug = not Config.System.Debug
-    print("Debug Prints = "..tostring(Config.System.Debug))
+    print("Debug Prints = "..tostring(Config.System.Debug))
-end
+end
-exports("toggleDebug", toggleDebug)
+exports("toggleDebug", toggleDebug)
-
+
-function getDebug() return Config.System.Debug end
+function getDebug() return Config.System.Debug end
-exports("getDebug", getDebug)
+exports("getDebug", getDebug)
-
+
-local origRegisterNetEvent = RegisterNetEvent
+local origRegisterNetEvent = RegisterNetEvent
-local origTriggerEvent = TriggerEvent
+local origTriggerEvent = TriggerEvent
-local origTriggerServerEvent = TriggerServerEvent
+local origTriggerServerEvent = TriggerServerEvent
-local origTriggerClientEvent = TriggerClientEvent
+local origTriggerClientEvent = TriggerClientEvent
-local origExecuteCommand = ExecuteCommand
+local origExecuteCommand = ExecuteCommand
-local origRegisterCommand = RegisterCommand
+local origRegisterCommand = RegisterCommand
-local origPairs = pairs
+local origPairs = pairs
-local origiPairs = ipairs
+local origiPairs = ipairs
-
+
-function getDebugInfo(info)
+function getDebugInfo(info)
-    local info = info
+    local info = info
-    local level = 2
+    local level = 2
-    if info and info.short_src:match("scheduler.lua") then
+    if info and info.short_src:match("scheduler.lua") then
-        repeat
+        repeat
-            info = debug.getinfo(level, "nSl")
+            info = debug.getinfo(level, "nSl")
-            level += 1
+            level += 1
-            local found = false
+            local found = false
-            for _, v in pairs({
+            for _, v in pairs({
-                "deffered.lua",
+                "deffered.lua",
-                "scheduler.lua",
+                "scheduler.lua",
-                "_eventDebug.lua",
+                "_eventDebug.lua",
-                "targets.lua",
+                "targets.lua",
-                "init.lua",
+                "init.lua",
-                "MySQL.lua",
+                "MySQL.lua",
-                "helpers.lua",
+                "helpers.lua",
-            }) do
+            }) do
-                if info and info.short_src:match(v) then
+                if info and info.short_src:match(v) then
-                    found = true
+                    found = true
-                end
+                end
-            end
+            end
-        until not info or (info.short_src and found == false)
+        until not info or (info.short_src and found == false)
-    end
+    end
-
+
-    return " ^7[^3"..(info and info.short_src:match("^.+/(.+)$") or "unknown").."^7:^3"..(info and info.currentline or "unknown").."^7]"
+    return " ^7[^3"..(info and info.short_src:match("^.+/(.+)$") or "unknown").."^7:^3"..(info and info.currentline or "unknown").."^7]"
-end
+end
-
+
---This is just a for debugging, not important, just announces which events are being registered triggered when these functions are used
+--This is just a for debugging, not important, just announces which events are being registered triggered when these functions are used
-function RegisterNetEvent(name, funct)
+function RegisterNetEvent(name, funct)
-    if Config.System.EventDebug then
+    if Config.System.EventDebug then
-        if name:find("__ox_cb_") then
+        if name:find("__ox_cb_") then
-            print("^6Bridge^7: ^2Registered ^3"..(isServer() and "Server" or "Client").." ^2Callback^7: ^6"..name:gsub("__ox_cb_", ""):gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^6Bridge^7: ^2Registered ^3"..(isServer() and "Server" or "Client").." ^2Callback^7: ^6"..name:gsub("__ox_cb_", ""):gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        else
+        else
-            print("^6Bridge^7: ^2Registering ^3"..(isServer() and "Server" or "Client").." ^2Net event^7: ^6"..name:gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^6Bridge^7: ^2Registering ^3"..(isServer() and "Server" or "Client").." ^2Net event^7: ^6"..name:gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        end
+        end
-    end
+    end
-    origRegisterNetEvent(name, funct)
+    origRegisterNetEvent(name, funct)
-end
+end
-
+
-function TriggerEvent(name, ...)
+function TriggerEvent(name, ...)
-    local data = {...}
+    local data = {...}
-    if Config.System.EventDebug then
+    if Config.System.EventDebug then
-        if name:find("__cfx_export") then
+        if name:find("__cfx_export") then
-            print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3"..(isServer() and "Server" or "Client").." ^2Export^7: ^6"..name:gsub("__cfx_export_", ""):gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3"..(isServer() and "Server" or "Client").." ^2Export^7: ^6"..name:gsub("__cfx_export_", ""):gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        else
+        else
-            print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3"..(isServer() and "Server" or "Client").." ^2Net event^7: ^6"..name:gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3"..(isServer() and "Server" or "Client").." ^2Net event^7: ^6"..name:gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        end
+        end
-        for i, value in ipairs(data) do
+        for i, value in ipairs(data) do
-            if value then
+            if value then
-                local valueStr = (type(value) == "table" and json.encode(value) or tostring(value))
+                local valueStr = (type(value) == "table" and json.encode(value) or tostring(value))
-                print(string.format("^6Bridge^7: ^7[^3%d^7]: ^7(^5%s^7): %s".."^7", i, type(value), valueStr))
+                print(string.format("^6Bridge^7: ^7[^3%d^7]: ^7(^5%s^7): %s".."^7", i, type(value), valueStr))
-            end
+            end
-        end    end
+        end    end
-    origTriggerEvent(name, ...)
+    origTriggerEvent(name, ...)
-end
+end
-
+
-function TriggerServerEvent(name, ...) -- Client side, trigger a server event
+function TriggerServerEvent(name, ...) -- Client side, trigger a server event
-    local data = {...}
+    local data = {...}
-    if Config.System.EventDebug then
+    if Config.System.EventDebug then
-        if name:find("__ox_cb") then
+        if name:find("__ox_cb") then
-            print("^6Bridge^7: "..GetPrintTime().." ^2Triggered ^3Server ^2Callback: ^6"..name:gsub("__ox_cb_", "").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^6Bridge^7: "..GetPrintTime().." ^2Triggered ^3Server ^2Callback: ^6"..name:gsub("__ox_cb_", "").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        else
+        else
-            print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3Server ^2Net event^7: ^6"..name:gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3Server ^2Net event^7: ^6"..name:gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        end
+        end
-        for i, value in ipairs(data) do
+        for i, value in ipairs(data) do
-            if value then
+            if value then
-                local valueStr = (type(value) == "table" and json.encode(value) or tostring(value))
+                local valueStr = (type(value) == "table" and json.encode(value) or tostring(value))
-                print(string.format("^6Bridge^7: ^7[^3%d^7]: ^7(^5%s^7): %s".."^7", i, type(value), valueStr))
+                print(string.format("^6Bridge^7: ^7[^3%d^7]: ^7(^5%s^7): %s".."^7", i, type(value), valueStr))
-            end
+            end
-        end    end
+        end    end
-    origTriggerServerEvent(name, ...)
+    origTriggerServerEvent(name, ...)
-end
+end
-
+
-function TriggerClientEvent(name, ...) -- Server side, trigger a client event
+function TriggerClientEvent(name, ...) -- Server side, trigger a client event
-    local data = {...}
+    local data = {...}
-    if Config.System.EventDebug then
+    if Config.System.EventDebug then
-        if name:find("__ox_cb") then
+        if name:find("__ox_cb") then
-            print("^6Bridge^7: "..GetPrintTime().." ^2Triggered ^3Client ^2Callback: ^6"..name:gsub("__ox_cb_", "").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^6Bridge^7: "..GetPrintTime().." ^2Triggered ^3Client ^2Callback: ^6"..name:gsub("__ox_cb_", "").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        else
+        else
-            print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3Client ^2Net event^7: ^6"..name:gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3Client ^2Net event^7: ^6"..name:gsub("%:", "^7:^4").."^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        end
+        end
-        for i, value in ipairs(data) do
+        for i, value in ipairs(data) do
-            if value then
+            if value then
-                local valueStr = (type(value) == "table" and json.encode(value) or tostring(value))
+                local valueStr = (type(value) == "table" and json.encode(value) or tostring(value))
-                print(string.format("^6Bridge^7: ^7[^3%d^7]: ^7(^5%s^7): %s".."^7", i, type(value), valueStr))
+                print(string.format("^6Bridge^7: ^7[^3%d^7]: ^7(^5%s^7): %s".."^7", i, type(value), valueStr))
-            end
+            end
-        end    end
+        end    end
-    origTriggerClientEvent(name, ...)
+    origTriggerClientEvent(name, ...)
-end
+end
-
+
-function RegisterCommand(command, funct, restrict)
+function RegisterCommand(command, funct, restrict)
-    if Config.System.EventDebug then
+    if Config.System.EventDebug then
-        print("^6Bridge^7: ^2Registering ^2Command^7: /"..command.." ^7| ^4Funct^7: "..tostring(funct):gsub("function: ", "").." ^7| ^4Admin^7: "..(restict and "true" or "false")..getDebugInfo(debug.getinfo(2, "nSl")))
+        print("^6Bridge^7: ^2Registering ^2Command^7: /"..command.." ^7| ^4Funct^7: "..tostring(funct):gsub("function: ", "").." ^7| ^4Admin^7: "..(restict and "true" or "false")..getDebugInfo(debug.getinfo(2, "nSl")))
-    end
+    end
-    origRegisterCommand(command, funct, restrict)
+    origRegisterCommand(command, funct, restrict)
-end
+end
-
+
-function ExecuteCommand(comm) -- Client side, execute /command
+function ExecuteCommand(comm) -- Client side, execute /command
-    if Config.System.EventDebug then
+    if Config.System.EventDebug then
-        print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3ExecuteCommand^7: /"..comm..getDebugInfo(debug.getinfo(2, "nSl")))
+        print("^6Bridge^7: "..GetPrintTime().." ^2Triggering ^3ExecuteCommand^7: /"..comm..getDebugInfo(debug.getinfo(2, "nSl")))
-    end
+    end
-    origExecuteCommand(comm)
+    origExecuteCommand(comm)
-end
+end
-
+
-function pairs(tbl)
+function pairs(tbl)
-    if not tbl then
+    if not tbl then
-        print("^1Error^7: ^1nil ^2for ^3pairs^7(), ^2setting to ^7{} ^2to prevent break^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+        print("^1Error^7: ^1nil ^2for ^3pairs^7(), ^2setting to ^7{} ^2to prevent break^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        return origPairs({})
+        return origPairs({})
-    end
+    end
-    return origPairs(tbl)
+    return origPairs(tbl)
-end
+end
-
+
-function ipairs(tbl)
+function ipairs(tbl)
-    local tbl = tbl
+    local tbl = tbl
-    if not tbl then
+    if not tbl then
-        if Config.System.EventDebug then
+        if Config.System.EventDebug then
-            print("^1Error^7: ^3iPairs^7() ^1nil ^2recieved^7, ^2setting to ^7{} ^2to prevent break^7"..getDebugInfo(debug.getinfo(2, "nSl")))
+            print("^1Error^7: ^3iPairs^7() ^1nil ^2recieved^7, ^2setting to ^7{} ^2to prevent break^7"..getDebugInfo(debug.getinfo(2, "nSl")))
-        end
+        end
-        tbl = {}
+        tbl = {}
-    end
+    end
-    return pairsByKeys(tbl) -- change to pairsByKeys for less errors
+    return pairsByKeys(tbl) -- change to pairsByKeys for less errors
-end
+end
-
+
---[[
+--[[
-local origPrint = print
+local origPrint = print
-function print(...)
+function print(...)
-    origPrint(getDebugInfo(debug.getinfo(2, "nSl"))..":")
+    origPrint(getDebugInfo(debug.getinfo(2, "nSl"))..":")
-    origPrint(...)
+    origPrint(...)
-end
+end
 ]]

shared/_loaders.lua

@@ -1,110 +1,209 @@
---- Executes a function when the player character is loaded into the game.
+--[[
----
+    Player & Resource Event Utility Functions
---- This function sets up event listeners for player loading based on the game framework detected (e.g., QB, ESX, OX).
+    -------------------------------------------
----
+    This module provides functions to:
---- If `onStart` is `true`, it will also attempt to execute the function on resource start after ensuring the player is logged in. (Helpful for debugging)
+      • Execute code when the player character is loaded or unloaded.
----
+      • Execute code on resource start and stop.
---- @param func function The function to execute when the player is loaded.
+      • Wait for the player to be logged in before proceeding.
---- @param onStart boolean (optional) If `true`, the function will also execute on resource start. Default is `false`.
+]]
----
+
---- @usage
+-------------------------------------------------------------
---- ```lua
+-- Player Loaded and Unloaded Events
---- onPlayerLoaded(function()
+-------------------------------------------------------------
----     -- Your code here
+
---- end, true)
+--- Executes a function when the player character is loaded.
---- ```
+--- If onStart is true, the function will also run on resource start (after ensuring the player is logged in).
-function onPlayerLoaded(func, onStart)
+---
-    local onPlayerName = ""
+--- @param func function The function to execute when the player is loaded.
-    local loaded = false
+--- @param onStart boolean (optional) If true, also execute on resource start. Default is false.
-    if onStart then
+--- @usage
-        onResourceStart(function()
+--- ```lua
-            if not LocalPlayer.state.isLoggedIn then
+--- onPlayerLoaded(function()
-                Wait(3000)
+---     print("Player logged in")
-                if not LocalPlayer.state.isLoggedIn then -- If the player is not logged in after waiting, skip execution
+---     -- Your initialization code here.
-                    return
+--- end, true)
-                end
+--- ```
-            end
+function onPlayerLoaded(func, onStart)
-            loaded = true -- Mark as already loaded
+    local onPlayerFramework = ""
-            debugPrint("^6Bridge^7: ^2Loading ^3onResourceStart^7() ^2through ^3onPlayerLoaded^7()")
+    local loaded = false
-            Wait(2000)
+
-            func()
+    if onStart then
-        end, true)
+        onResourceStart(function()
-    end
+            if not waitForLogin() then return end
-    if not loaded then
+
-        local tempFunc = function()
+            loaded = true
-            debugPrint("^6Bridge^7: ^2Executing ^3onPlayerLoaded^7()")
+            debugPrint("^6Bridge^7: ^3onResourceStart^7()^2 executed through ^3onPlayerLoaded^7()")
-            func()
+            Wait(2000)
-        end
+            func()
-        if isStarted(QBExport) or isStarted(QBXExport) then onPlayerName = QBExport
+        end, true)
-            AddEventHandler('QBCore:Client:OnPlayerLoaded', tempFunc)
+    end
-        elseif isStarted(ESXExport) then onPlayerName = ESXExport
+
-            AddEventHandler('esx:playerLoaded', tempFunc)
+    if not loaded then
-        elseif isStarted(OXCoreExport) then onPlayerName = OXCoreExport
+        local tempFunc = function()
-            AddEventHandler('ox:playerLoaded', tempFunc)
+            Wait(2000)
-        end
+            debugPrint("^6Bridge^7: ^2Executing onPlayerLoaded")
-        if onPlayerName ~= "" then
+            func()
-            debugPrint("^6Bridge^7: ^2Registering ^3onPlayerLoaded^2 with ^7"..onPlayerName)
+        end
-        else
+
-            print("^4ERROR^7: ^2No Core detected for onPlayerLoaded ^7- ^2Check ^3exports^1.^2lua^7")
+        if isStarted(QBExport) or isStarted(QBXExport) then
-        end
+            onPlayerFramework = QBExport
-    end
+            AddEventHandler('QBCore:Client:OnPlayerLoaded', tempFunc)
-end
+        elseif isStarted(ESXExport) then
-
+            onPlayerFramework = ESXExport
---- Executes a function when the resource starts.
+            AddEventHandler('esx:playerLoaded', function()
----
+                if waitForSharedLoad() then
---- This function wraps the `onResourceStart` event, allowing you to execute code when the resource starts.
+                    if isStarted(ESXExport) then Wait(11000) end
----
+                    tempFunc()
---- @param func function The function to execute on resource start.
+                end
---- @param thisScript boolean (optional) If `true`, only runs the function when this resource starts. Default is `true`.
+            end
----
+        )
---- @usage
+        elseif isStarted(OXCoreExport) then
---- ```lua
+            onPlayerFramework = OXCoreExport
---- onResourceStart(function()
+            AddEventHandler('ox:playerLoaded', tempFunc)
----     -- Your code here
+        elseif isStarted(RSGExport) then
---- end, true)
+            onPlayerFramework = RSGExport
---- ```
+            AddEventHandler('RSGCore:Client:OnPlayerLoaded', tempFunc)
-function onResourceStart(func, thisScript)
+        end
-    debugPrint("^6Bridge^7: ^2Registering ^3onResourceStart^2")
+
-    AddEventHandler('onResourceStart', function(resourceName)
+        if onPlayerFramework ~= "" then
-        if getScript() == resourceName and (thisScript or true) then
+            debugPrint("^6Bridge^7: ^2Registering ^3onPlayerLoaded^7()^2 with ^3" .. onPlayerFramework.."^7")
-            func()
+        else
-        end
+            print("^4ERROR^7: No supported core detected for onPlayerLoaded - Check starter.lua")
-    end)
+        end
-end
+    end
-
+end
---- Executes a function when the resource stops.
+
----
+--- Executes a function when the player character is unloaded.
---- This function wraps the `onResourceStop` event, allowing you to execute code when the resource stops.
+--- @param func function The function to execute when the player unloads.
----
+--- @usage
---- @param func function The function to execute on resource stop.
+--- ```lua
---- @param thisScript boolean (optional) If `true`, only runs the function when this resource stops. Default is `true`.
+--- onPlayerUnload(function()
----
+---     print("Player has logged out of their character")
---- @usage
+---     -- Your cleanup code here.
---- ```lua
+--- end)
---- onResourceStop(function()
+--- ```
----     -- Cleanup code here
+function onPlayerUnload(func)
---- end, true)
+    AddEventHandler('QBCore:Client:OnPlayerUnload', function() func() end)
---- ```
+    AddEventHandler('ox:playerLogout', function() func() end)
-function onResourceStop(func, thisScript)
+    AddEventHandler('RSGCore:Client:OnPlayerUnload', function() func() end)
-    debugPrint("^6Bridge^7: ^2Registering ^3onResourceStop^2")
+
-    AddEventHandler('onResourceStop', function(resourceName)
+    --AddEventHandler('esx:playerLogout', function() func() end)
-        if getScript() == resourceName and (thisScript or true) then
+    -- ^ Only server side for now, need a way to send it to client if not already available
-            func()
+end
-        end
+
-    end)
+-------------------------------------------------------------
-end
+-- Resource Start and Stop Events
-
+-------------------------------------------------------------
---- Waits until the player is logged in before continuing execution.
+
----
+--- Executes a function when the resource starts.
---- This function blocks execution until `LocalPlayer.state.isLoggedIn` is `true`.
+--- @param func function The function to execute.
----
+--- @param thisScript boolean (optional) If true, only runs when this resource starts (default true).
----@usage
+--- @usage
---- ```lua
+--- ```lua
---- waitForLogin()
+--- onResourceStart(function()
---- ```
+---     print("Script ensured")
-function waitForLogin()
+---     -- Initialization code on resource start.
-    while not LocalPlayer.state.isLoggedIn do
+--- end, true)
-        debugPrint("Waiting")
+--- ```
-        Wait(100)
+function onResourceStart(func, thisScript)
-    end
+    debugPrint("^6Bridge^7: ^2Registering ^3onResourceStart^7()")
+    AddEventHandler('onResourceStart', function(resourceName)
+        if getScript() == resourceName and (thisScript or true) then
+            if waitForSharedLoad() then
+                debugPrint("^6Bridge^7: ^2Shared Load Detected^7.")
+                if isStarted(ESXExport) then Wait(10000) end
+                func()
+            end
+        end
+    end)
+end
+
+--- Executes a function when the resource stops.
+--- @param func function The function to execute.
+--- @param thisScript boolean (optional) If true, only runs when this resource stops (default true).
+--- @usage
+--- ```lua
+--- onResourceStop(function()
+---     -- Cleanup code here.
+--- end, true)
+--- ```
+function onResourceStop(func, thisScript)
+    debugPrint("^6Bridge^7: ^2Registering ^3onResourceStop^7()")
+    AddEventHandler('onResourceStop', function(resourceName)
+        if getScript() == resourceName and (thisScript or true) then
+            func()
+        end
+    end)
+end
+
+-------------------------------------------------------------
+-- Wait for Login
+-------------------------------------------------------------
+
+--- Blocks execution until the player is logged in.
+--- @usage
+--- waitForLogin()
+function waitForLogin()
+    local timeout = 10000  -- 10 seconds in milliseconds
+    local startTime = GetGameTimer()
+    local loggedIn = false
+
+    if isStarted(ESXExport) then
+        while (GetGameTimer() - startTime) < timeout do
+            local playerData = ESX.GetPlayerData()
+            if playerData and playerData.job then
+                loggedIn = true
+                break
+            end
+            Wait(100)
+        end
+    elseif isStarted(OXCoreExport) then
+        if OxPlayer["stateId"] then
+            loggedIn = true
+        end
+        while not OxPlayer["stateId"] do
+            Wait(1000)
+            debugPrint("Waiting for stateId to class as logged in")
+            if OxPlayer.get["stateId"] then
+                loggedIn = true
+                break
+            end
+        end
+    else
+        -- For other frameworks, use LocalPlayer.state.isLoggedIn.
+        while not LocalPlayer.state.isLoggedIn and (GetGameTimer() - startTime) < timeout do
+            Wait(100)
+        end
+        loggedIn = LocalPlayer.state.isLoggedIn
+    end
+
+    if not loggedIn then
+        print("^4Error^7: ^2Timeout reached while waiting for player login^7.")
+        return false
+    else
+        debugPrint("^6Bridge^7: ^2Player Login Detected^7.")
+        return true
+    end
+end
+
+function waitForSharedLoad()
+    local timeout = 100000  -- 10 seconds in milliseconds
+    local startTime = GetGameTimer()
+    local loaded = true
+    while ((not Jobs or not next(Jobs)) and (not Items or not next(Items)) and (not Vehicles or not next(Vehicles))) and (GetGameTimer() - startTime) < timeout do
+        print((GetGameTimer() - startTime) < timeout)
+        Wait(1000)
+        debugPrint("Waiting for Jobs, Items, and Vehicles to be loaded")
+        if Jobs and Items and Vehicles then
+            print("^6Bridge^7: ^2Jobs, Items, and Vehicles Loaded^7.")
+            loaded = true
+            break
+        end
+    end
+    if not loaded then
+        print("^4Error^7: ^2Timeout reached while waiting for shared load^7.")
+        return false
+    else
+        return true
+    end
 end

shared/_scriptversioncheck.lua

@@ -0,0 +1,88 @@
+function parseVersion(version)
+    local parts = {}
+    for num in version:gmatch("%d+") do
+        table.insert(parts, tonumber(num))
+    end
+    return parts
+end
+
+function compareVersions(current, newest)
+    local currentParts = parseVersion(current)
+    local newestParts = parseVersion(newest)
+    for i = 1, math.max(#currentParts, #newestParts) do
+        local c = currentParts[i] or 0
+        local n = newestParts[i] or 0
+        if c < n then return -1
+        elseif c > n then return 1 end
+    end
+    return 0 -- equal
+end
+
+function capitalize(str)
+    return (str:gsub("^%l", string.upper):gsub("%-%l", function(letter) return "-" .. string.upper(letter:sub(2)) end))
+end
+
+local scriptName = ("^2"..capitalize(getScript()):gsub("%-", "^7-^2"):gsub("%_", "^7_^2")) or ""
+local scriptVersion = ("^5"..GetResourceMetadata(getScript(), 'version', nil):gsub("%.", "^7.^5")) or ""
+local scriptDescription = ("^2"..GetResourceMetadata(getScript(), 'description', nil)) or ""
+local scriptAuthor = ("^2by ^4"..GetResourceMetadata(getScript(), 'author', nil):gsub("%and", "^7and^4")) or ""
+
+print(scriptName.." ^7v"..scriptVersion.."^7 - "..scriptDescription.." "..scriptAuthor.."^7")
+
+function CheckVersion()
+    if isServer() and GetResourceMetadata(getScript(), 'author', nil) == "Jimathy" then
+        CreateThread(function()
+            Wait(4000)
+
+            local script = getScript()
+            local currentVersionRaw = GetResourceMetadata(script, 'version')
+
+            PerformHttpRequest('https://raw.githubusercontent.com/jimathy/UpdateVersions/master/'..script..'.txt', function(err, newestVersionRaw, headers)
+                if not newestVersionRaw then
+                    PerformHttpRequest('https://raw.githubusercontent.com/jimathy/'..script..'/master/version.txt', function(err, fallbackVersionRaw, headers)
+                        if not fallbackVersionRaw then
+                            print("^1Currently unable to run a version check for ^7'^3"..script.."^7' (^3"..currentVersionRaw.."^7)")
+                            return
+                        end
+
+                        fallbackVersionRaw = fallbackVersionRaw:match("[^\r\n]+"):gsub("v", "")
+
+                        local compareResult = compareVersions(currentVersionRaw, fallbackVersionRaw)
+                        if compareResult == 0 then
+                            print("^7'^3"..script.."^7' - ^2You are running the latest version^7. (^3"..currentVersionRaw.."^7)")
+                        elseif compareResult < 0 then
+                            print("^1----------------------------------------------------------------------^7")
+                            print("^7'^3"..script.."^7' - ^1You are currently running an outdated version^7! (^3"..currentVersionRaw.."^7 → ^3"..fallbackVersionRaw.."^7)")
+                            print("^1----------------------------------------------------------------------^7")
+                            SetTimeout(1200000, function()
+                                -- Do a naughty repeat message every 20 minutes until the the script is updated
+                                CheckVersion()
+                            end)
+                        else
+							print("^7'^3"..script.."^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..fallbackVersionRaw.."^7)")
+                        end
+                    end)
+                else
+                    newestVersionRaw = newestVersionRaw:match("[^\r\n]+"):gsub("v", "")
+
+					local compareResult = compareVersions(currentVersionRaw, newestVersionRaw)
+					if compareResult == 0 then
+                        print("^7'^3"..script.."^7' - ^2You are running the latest version^7. (^3"..currentVersionRaw.."^7)")
+                    elseif compareResult < 0 then
+                        print("^1----------------------------------------------------------------------^7")
+                        print("^7'^3"..script.."^7' - ^1You are currently running an outdated version^7! (^3"..currentVersionRaw.."^7 → ^3"..newestVersionRaw.."^7)")
+                        print("^1----------------------------------------------------------------------^7")
+                        SetTimeout(1200000, function()
+                            -- Do a naughty repeat message every 20 minutes until the the script is updated
+                            CheckVersion()
+                        end)
+                    else
+                        print("^7'^3"..script.."^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..newestVersionRaw.."^7)")
+                    end
+                end
+            end)
+        end)
+    end
+end
+
+CheckVersion()

shared/callback.lua

@@ -1,68 +1,87 @@
---- Registers a callback function with the appropriate framework.
+--- Registers a callback function with the appropriate framework.
----
+---
---- This function checks which framework is started (e.g., OX, QB, ESX) and registers the callback accordingly.
+--- This function checks which framework is started (e.g., OX, QB, ESX) and registers the callback accordingly.
---- It adapts the callback function to match the expected signature for the framework.
+--- It adapts the callback function to match the expected signature for the framework.
----
+---
----@param callbackName string The name of the callback to register.
+---@param callbackName string The name of the callback to register.
----@param funct function The function to be called when the callback is triggered.
+---@param funct function The function to be called when the callback is triggered.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- createCallback('myCallback', function(source, ...)
+--- local table = { ["info"] = "HI" }
----     -- Your callback code here
+--- createCallback('myCallback', function(source, ...)
---- end)
+---     return table
---- ```
+--- end)
-function createCallback(callbackName, funct)
+---
-    if isStarted(OXLibExport) then
+--- createCallback("callback:checkVehicleOwned", function(source, plate)
-        lib.callback.register(callbackName, funct)
+--- 	local result = isVehicleOwned(plate)
-    else
+--- 	if result then
-        local adaptedFunction = function(source, cb, ...)
+---         return true
-            local result = funct(source, ...)
+---      else
-            cb(result)
+---         return false
-        end
+---     end
-
+--- end)
-        if isStarted(QBExport) then
+--- ```
-            Core = Core or exports[QBExport]:GetCoreObject()
+function createCallback(callbackName, funct)
-            Core.Functions.CreateCallback(callbackName, adaptedFunction)
+    if isServer() then
-        elseif isStarted(ESXExport) then
+        debugPrint("^6Bridge^7: ^3Registering callback^7:", callbackName)
-            ESX.RegisterServerCallback(callbackName, adaptedFunction)
+        if isStarted(OXLibExport) then
-        else
+            lib.callback.register(callbackName, funct)
-            print("^6Bridge^7: ^1ERROR^7: ^3Can't find any script to register callback with", callbackName)
+        else
-        end
+            local adaptedFunction = function(source, cb, ...)
-    end
+                local result = funct(source, ...)
-end
+                cb(result)
-
+            end
---- Triggers a server callback and returns the result.
+
----
+            if isStarted(QBExport) then
---- This function triggers a server callback using the appropriate framework's method and awaits the result.
+                Core = Core or exports[QBExport]:GetCoreObject()
----
+                Core.Functions.CreateCallback(callbackName, adaptedFunction)
----@param callbackName string The name of the callback to trigger.
+            elseif isStarted(ESXExport) then
----@param ... any Additional arguments to pass to the callback.
+                ESX.RegisterServerCallback(callbackName, adaptedFunction)
----
+            else
----@return any any The result returned by the callback function.
+                print("^6Bridge^7: ^1ERROR^7: ^3Can't find any script to register callback with", callbackName)
----
+            end
----@usage
+        end
---- ```lua
+    end
---- local result = triggerCallback('myCallback', arg1, arg2)
+end
---- ```
+
-function triggerCallback(callbackName, ...)
+--- Triggers a server callback and returns the result.
-    local result = nil
+---
-    if isStarted(OXLibExport) then
+--- This function triggers a server callback using the appropriate framework's method and awaits the result.
-        result = lib.callback.await(callbackName, false, ...)
+---
-    elseif isStarted(QBExport) then
+---@param callbackName string The name of the callback to trigger.
-        local p = promise.new()
+---@param ... any Additional arguments to pass to the callback.
-        Core.Functions.TriggerCallback(callbackName, function(cbResult)
+---
-            p:resolve(cbResult)
+---@return any any The result returned by the callback function.
-        end, ...)
+---
-        result = Citizen.Await(p)
+---@usage
-    elseif isStarted(ESXExport) then
+--- ```lua
-        local p = promise.new()
+--- local result = triggerCallback('myCallback')
-        ESX.TriggerServerCallback(callbackName, function(cbResult)
+--- jsonPrint(result)
-            p:resolve(cbResult)
+---
-        end, ...)
+--- local result = triggerCallback("callback:checkVehicleOwned", plate)
-        result = Citizen.Await(p)
+--- print(result)
-    else
+--- ```
-        print("^6Bridge^7: ^1ERROR^7: ^3Can't find any script to trigger callback with", callbackName)
+function triggerCallback(callbackName, ...)
-    end
+    local result = nil
-    return result
+    debugPrint("^6Bridge^7: ^3Triggering callback^7:", callbackName)
+    if isStarted(OXLibExport) then
+        result = lib.callback.await(callbackName, false, ...)
+    elseif isStarted(QBExport) then
+        local p = promise.new()
+        Core.Functions.TriggerCallback(callbackName, function(cbResult)
+            p:resolve(cbResult)
+        end, ...)
+        result = Citizen.Await(p)
+        Wait(10)
+    elseif isStarted(ESXExport) then
+        local p = promise.new()
+        ESX.TriggerServerCallback(callbackName, function(cbResult)
+            p:resolve(cbResult)
+        end, ...)
+        result = Citizen.Await(p)
+    else
+        print("^6Bridge^7: ^1ERROR^7: ^3Can't find any script to trigger callback with", callbackName)
+    end
+    return result
 end

shared/contextmenus.lua

@@ -1,290 +1,315 @@
---- Opens a menu using the configured menu system.
+--[[
----
+    Menu Opening Module
---- This function translates code and creates menus in several different menu scripts, depending on the configured menu system specified in `Config.System.Menu`.
+    ---------------------
----
+    This module provides a unified function to open menus using the configured menu system.
----@param Menu table A table containing the menu options to display.
+    Supported systems include:
---- Each menu item can include:
+      • jim_bridge (built-in nui menu that works on any framework)
---- - **header** (`string`): The text to display for the menu item.
+      • ox (or ox_context)
---- - **txt** (`string`, optional): Additional text or description.
+      • qb (using QBMenuExport)
---- - **icon** (`string`, optional): Icon to display with the menu item.
+      • gta (using WarMenu)
---- - **onSelect** (`function`, optional): Function to execute when the menu item is selected.
+      • esx (using ESX.UI.Menu)
---- - **arrow** (`boolean`, optional): Whether to display an arrow next to the item (for certain menus).
+]]
---- - **params** (`table`, optional): Additional parameters, such as events and arguments.
+
---- - **isMenuHeader** (`boolean`, optional): Marks the item as a header.
+--- Opens a menu using the configured menu system.
---- - **disabled** (`boolean`, optional): Disables the menu item if `true`.
+---
----
+--- This function translates code and creates menus in several different menu scripts, depending on the configured menu system specified in `Config.System.Menu`.
----@param data table A table containing configuration data for the menu.
+---
---- - **header** (`string`): The header/title of the menu.
+---@param Menu table A table containing the menu options to display.
---- - **headertxt** (`string`, optional): Additional header text.
+--- Each menu item can include:
---- - **onBack** (`function`, optional): Function to call when the "Return" option is selected.
+---     - header (`string`): The text to display for the menu item.
---- - **onExit** (`function`, optional): Function to call when the menu is exited.
+---     - txt (`string`, optional): Additional text or description.
---- - **onSelected** (`function`, optional): Function to call when a menu item is selected (for certain menu systems).
+---     - icon (`string`, optional): Icon to display with the menu item.
---- - **canClose** (`boolean`, optional): Whether the menu can be closed by the user.
+---     - onSelect (`function`, optional): Function to execute when the menu item is selected.
----
+---     - arrow (`boolean`, optional): Whether to display an arrow next to the item (for certain menus).
----@usage
+---     - params (`table`, optional): Additional parameters, such as events and arguments.
---- ```lua
+---     - isMenuHeader (`boolean`, optional): Marks the item as a header.
---- openMenu({
+---     - disabled (`boolean`, optional): Disables the menu item if `true`.
----     { header = "Option 1", txt = "Description 1", onSelect = function() print("Option 1 selected") end },
+---
----     { header = "Option 2", txt = "Description 2", onSelect = function() print("Option 2 selected") end },
+---@param data table A table containing configuration data for the menu.
---- }, {
+---     - header (`string`): The header/title of the menu.
----     header = "Main Menu",
+---     - headertxt (`string`, optional): Additional header text.
----     headertxt = "Select an option",
+---     - onBack (`function`, optional): Function to call when the "Return" option is selected.
----     onBack = function() print("Return selected") end,
+---     - onExit (`function`, optional): Function to call when the menu is exited.
----     onExit = function() print("Menu closed") end,
+---     - onSelected (`function`, optional): Function to call when a menu item is selected (for certain menu systems).
----     canClose = true,
+---     - canClose (`boolean`, optional): Whether the menu can be closed by the user.
---- })
+---
---- ```
+---@usage
-function openMenu(Menu, data)
+--- ```lua
-    if Config.System.Menu == "jim" then
+--- openMenu({
-        if data.onBack then
+---     { header = "Option 1", txt = "Description 1", onSelect = function() print("Option 1 selected") end },
-            table.insert(Menu, 1, {
+---     { header = "Option 2", txt = "Description 2", onSelect = function() print("Option 2 selected") end },
-                icon = "fas fa-circle-arrow-left",
+--- }, {
-                title = "Return",
+---     header = "Main Menu",
-                onSelect = data.onBack,
+---     headertxt = "Select an option",
-            })
+---     onBack = function() print("Return selected") end,
-        end
+---     onExit = function() print("Menu closed") end,
-        exports["jim-nui"]:openMenu({
+---     canClose = true,
-            title = data.header..(data.headertxt and " -- "..data.headertxt or ""),
+--- })
-            canClose = data.canClose and data.canClose or nil,
+--- ```
-            onClose = (data.onBack and data.onBack) or (data.onExit and data.onExit) or nil,
+function openMenu(Menu, data)
-            onExit = data.onExit and data.onExit or nil,
+    if Config.System.Menu == "jim" then
-            options = Menu,
+        if data.onBack then
-        })
+            table.insert(Menu, 1, {
-
+                icon = "fas fa-circle-arrow-left",
-    elseif Config.System.Menu == "ox" then
+                header = " ",
-        local index = nil
+                txt = "Return",
-        if data.onBack and not data.onSelected then
+                params = {
-            table.insert(Menu, 1, {
+                    isAction = true,
-                icon = "fas fa-circle-arrow-left",
+                    event = data.onBack,
-                title = "Return",
+                },
-                onSelect = data.onBack,
+            })
-                label = "Return",
+        elseif data.canClose then
-            })
+            table.insert(Menu, 1, {
-        end
+                icon = "fas fa-circle-xmark",
-        for k in pairs(Menu) do
+                header = " ",
-            if data.onSelected and Menu[k].arrow then
+                txt = "Close",
-                Menu[k].icon = "fas fa-angle-right"
+                params = {
-            end
+                    isAction = true,
-            if not Menu[k].title then
+                    event = data.onExit and data.onExit or (function() exports[QBMenuExport]:closeMenu() end),
-                if Menu[k].header ~= nil and Menu[k].header ~= "" then
+                },
-                    Menu[k].title = Menu[k].header
+            })
-                    Menu[k].label = Menu[k].header
+        end
-                    if Menu[k].txt then Menu[k].description = Menu[k].txt else Menu[k].description = "" end
+        if data.header ~= nil then
-                else
+            local tempMenu = {}
-                    Menu[k].title = Menu[k].txt
+            for k, v in pairs(Menu) do tempMenu[k + 1] = v end
-                    Menu[k].label = Menu[k].txt
+            tempMenu[1] = { header = data.header, txt = data.headertxt or "", isMenuHeader = true }
-                end
+            Menu = tempMenu
-            end
+        end
-            if Menu[k].params then
+        for k in pairs(Menu) do
-                Menu[k].event = Menu[k].params.event
+            if not Menu[k].params or not Menu[k].params.event then
-                Menu[k].args = Menu[k].params.args or {}
+                Menu[k].params = {
-            end
+                    isAction = true,
-            if Menu[k].isMenuHeader then
+                    event = Menu[k].onSelect or function() end,
-                Menu[k].disabled = true
+                }
-            end
+            end
-        end
+            if not Menu[k].header then Menu[k].header = " " end
-        local menuID = 'Menu'
+            if Menu[k].arrow then Menu[k].icon = "fas fa-angle-right" end
-        (data.onSelected and lib.registerMenu or lib.registerContext)({
+            Menu[k].isMenuHeader = Menu[k].isMenuHeader or Menu[k].disable
-            id = menuID,
+        end
-            title = data.header..br..br..(data.headertxt and data.headertxt or ""),
+        TriggerEvent("jim_bridge:client:openMenu", Menu)
-            position = 'top-right',
+
-            options = Menu,
+    elseif Config.System.Menu == "ox" then
-            canClose = data.canClose and data.canClose or nil,
+        local index = nil
-            onClose = (data.onBack and data.onBack) or (data.onExit and data.onExit) or nil,
+        if data.onBack and not data.onSelected then
-            onExit = data.onExit and data.onExit or nil,
+            table.insert(Menu, 1, {
-            onSelected = data.onSelected and (function(selected) index = selected end) or nil,
+                icon = "fas fa-circle-arrow-left",
-        }, data.onSelected and (function(x, y, args)
+                title = "Return",
-            if Menu[x].refresh then
+                onSelect = data.onBack,
-                if Menu[x].onSelect then
+                label = "Return",
-                    Menu[x].onSelect()
+            })
-                end
+        end
-                lib.showMenu(menuID, index)
+        for k in pairs(Menu) do
-            else
+            if data.onSelected and Menu[k].arrow then
-                if Menu[x].onSelect then
+                Menu[k].icon = "fas fa-angle-right"
-                    Menu[x].onSelect()
+            end
-                else
+            -- If no title, use header or txt as title/label.
-                    lib.showMenu(menuID, index)
+            if not Menu[k].title then
-                end
+                if Menu[k].header ~= nil and Menu[k].header ~= "" then
-            end
+                    Menu[k].title = Menu[k].header
-        end) or nil)
+                    Menu[k].label = Menu[k].header
-        if data.onSelected then
+                    if Menu[k].txt then Menu[k].description = Menu[k].txt else Menu[k].description = "" end
-            lib.showMenu(menuID, 1)
+                else
-        else
+                    Menu[k].title = Menu[k].txt
-            lib.showContext(menuID)
+                    Menu[k].label = Menu[k].txt
-        end
+                end
-
+            end
-    elseif Config.System.Menu == "qb" then
+            -- Copy parameters from 'params' if available.
-        if data.onBack then
+            if Menu[k].params then
-            table.insert(Menu, 1, {
+                Menu[k].event = Menu[k].params.event
-                icon = "fas fa-circle-arrow-left",
+                Menu[k].args = Menu[k].params.args or {}
-                header = " ",
+            end
-                txt = "Return",
+            if Menu[k].isMenuHeader then
-                params = {
+                Menu[k].readOnly = true
-                    isAction = true,
+            end
-                    event = data.onBack,
+        end
-                },
+        local menuID = 'Menu'
-            })
+        (data.onSelected and lib.registerMenu or lib.registerContext)({
-        elseif data.canClose then
+            id = menuID,
-            table.insert(Menu, 1, {
+            title = data.header..br..br..(data.headertxt and data.headertxt or ""),
-                icon = "fas fa-circle-xmark",
+            position = 'top-right',
-                header = " ",
+            options = Menu,
-                txt = "Close",
+            canClose = data.canClose and data.canClose or nil,
-                params = {
+            onClose = (data.onBack and data.onBack) or (data.onExit and data.onExit) or nil,
-                    isAction = true,
+            onExit = data.onExit and data.onExit or nil,
-                    event = data.onExit and data.onExit or (function() exports[QBMenuExport]:closeMenu() end),
+            onSelected = data.onSelected and (function(selected) index = selected end) or nil,
-                },
+        }, data.onSelected and (function(x, y, args)
-            })
+            if Menu[x].refresh then
-        end
+                if Menu[x].onSelect then
-        if data.header ~= nil then
+                    Menu[x].onSelect()
-            local tempMenu = {}
+                end
-            for k, v in pairs(Menu) do tempMenu[k + 1] = v end
+                lib.showMenu(menuID, index)
-            tempMenu[1] = { header = data.header, txt = data.headertxt or "", isMenuHeader = true }
+            else
-            Menu = tempMenu
+                if Menu[x].onSelect then
-        end
+                    Menu[x].onSelect()
-        for k in pairs(Menu) do
+                else
-            if not Menu[k].params or not Menu[k].params.event then
+                    lib.showMenu(menuID, index)
-                if Menu[k].onSelect then
+                end
-                    Menu[k].params = {
+            end
-                        isAction = true,
+        end) or nil)
-                        event = Menu[k].onSelect,
+        if data.onSelected then
-                    }
+            lib.showMenu(menuID, 1)
-                else
+        else
-                    Menu[k].params = {
+            lib.showContext(menuID)
-                        isAction = true,
+        end
-                        event = function() end,
+
-                    }
+    elseif Config.System.Menu == "qb" then
-                end
+        if data.onBack then
-            end
+            table.insert(Menu, 1, {
-            if not Menu[k].header then Menu[k].header = " " end
+                icon = "fas fa-circle-arrow-left",
-            if Menu[k].arrow then Menu[k].icon = "fas fa-angle-right" end
+                header = " ",
-        end
+                txt = "Return",
-        exports[QBMenuExport]:openMenu(Menu)
+                params = {
-
+                    isAction = true,
-    elseif Config.System.Menu == "gta" then
+                    event = data.onBack,
-        WarMenu.CreateMenu(tostring(Menu),
+                },
-            data.header,
+            })
-            data.headertxt or " ",
+        elseif data.canClose then
-            {
+            table.insert(Menu, 1, {
-                titleColor = { 222, 255, 255 },
+                icon = "fas fa-circle-xmark",
-                maxOptionCountOnScreen = 15,
+                header = " ",
-                width = 0.25,
+                txt = "Close",
-                x = 0.7,
+                params = {
-            })
+                    isAction = true,
-        if WarMenu.IsAnyMenuOpened() then return end
+                    event = data.onExit and data.onExit or (function() exports[QBMenuExport]:closeMenu() end),
-        WarMenu.OpenMenu(tostring(Menu))
+                },
-        CreateThread(function()
+            })
-            local close = true
+        end
-            while true do
+        if data.header ~= nil then
-                if WarMenu.Begin(tostring(Menu)) then
+            local tempMenu = {}
-                    if data.onBack then
+            for k, v in pairs(Menu) do tempMenu[k + 1] = v end
-                        if WarMenu.SpriteButton("Return", 'commonmenu', "arrowleft", 127, 127, 127) then
+            tempMenu[1] = { header = data.header, txt = data.headertxt or "", isMenuHeader = true }
-                            WarMenu.CloseMenu()
+            Menu = tempMenu
-                            Wait(10)
+        end
-                            data.onBack()
+        for k in pairs(Menu) do
-                        end
+            if not Menu[k].params or not Menu[k].params.event then
-                    end
+                Menu[k].params = {
-                    for k in pairs(Menu) do
+                    isAction = true,
-                        local pressed = WarMenu.Button(Menu[k].header)
+                    event = Menu[k].onSelect or function() end,
-                        if not Menu[k].header then
+                }
-                            Menu[k].header = Menu[k].txt
+            end
-                            Menu[k].txt = nil
+            if not Menu[k].header then Menu[k].header = " " end
-                        end
+            if Menu[k].arrow then Menu[k].icon = "fas fa-angle-right" end
-                        if Menu[k].txt and Menu[k].txt ~= "" and WarMenu.IsItemHovered() then
+            Menu[k].isMenuHeader = Menu[k].isMenuHeader or Menu[k].disable
-                            if Menu[k].disabled or Menu[k].isMenuHeader then
+        end
-                                WarMenu.ToolTip("~r~"..Menu[k].txt, 0.18, true)
+        exports[QBMenuExport]:openMenu(Menu)
-                            else
+
-                                WarMenu.ToolTip(
+    elseif Config.System.Menu == "gta" then
-                                    (Menu[k].blip and "~BLIP_".."8".."~ " or "")..
+        WarMenu.CreateMenu(tostring(Menu), data.header, data.headertxt or " ", {
-                                    Menu[k].txt:gsub("%:", ":~g~"):gsub("%\n", "\n~s~"), 0.18,
+            titleColor = { 222, 255, 255 },
-                                    true)
+            maxOptionCountOnScreen = 15,
-                            end
+            width = 0.25,
-                        end
+            x = 0.7,
-                        if pressed and not Menu[k].isMenuHeader then
+        })
-                            WarMenu.CloseMenu()
+        if WarMenu.IsAnyMenuOpened() then return end
-                            close = false
+        WarMenu.OpenMenu(tostring(Menu))
-                            Menu[k].onSelect()
+        CreateThread(function()
-                        end
+            local close = true
-                    end
+            while true do
-                    WarMenu.End()
+                if WarMenu.Begin(tostring(Menu)) then
-                else
+                    if data.onBack then
-                    return
+                        if WarMenu.SpriteButton("Return", 'commonmenu', "arrowleft", 127, 127, 127) then
-                end
+                            WarMenu.CloseMenu()
-                if not WarMenu.IsAnyMenuOpened() and close then
+                            Wait(10)
-                    stopTempCam(cam)
+                            data.onBack()
-                    if data.onExit then data.onExit() end
+                        end
-                end
+                    end
-                Wait(0)
+                    for k in pairs(Menu) do
-            end
+                        local pressed = WarMenu.Button(Menu[k].header)
-        end)
+                        if not Menu[k].header then
-
+                            Menu[k].header = Menu[k].txt
-    elseif Config.System.Menu == "esx" then
+                            Menu[k].txt = nil
-        for k in pairs(Menu) do
+                        end
-            Menu[k].label = Menu[k].header
+                        if Menu[k].txt and Menu[k].txt ~= "" and WarMenu.IsItemHovered() then
-            Menu[k].name = "button"..k
+                            if Menu[k].disabled or Menu[k].isMenuHeader then
-        end
+                                WarMenu.ToolTip("~r~"..Menu[k].txt, 0.18, true)
-        if data.canClose then
+                            else
-            table.insert(Menu, 1, {
+                                WarMenu.ToolTip(
-                icon = "fas fa-circle-xmark",
+                                    (Menu[k].blip and "~BLIP_".."8".."~ " or "")..
-                label = "Close",
+                                    Menu[k].txt:gsub("%:", ":~g~"):gsub("%\n", "\n~s~"), 0.18,
-                name = "close",
+                                    true)
-                onSelect = data.onExit,
+                            end
-            })
+                        end
-        end
+                        if pressed and not Menu[k].isMenuHeader then
-        if data.onBack then
+                            WarMenu.CloseMenu()
-            table.insert(Menu, 1, {
+                            close = false
-                icon = "fas fa-circle-arrow-left",
+                            Menu[k].onSelect()
-                label = "Return",
+                        end
-                name = "return",
+                    end
-                onSelect = data.onBack,
+                    WarMenu.End()
-            })
+                else
-        end
+                    return
-
+                end
-        ESX.UI.Menu.Open("default", getScript(), "Example_Menu", {
+                if not WarMenu.IsAnyMenuOpened() and close then
-            title = data.header,
+                    stopTempCam(cam)
-            align = 'top-right',
+                    if data.onExit then data.onExit() end
-            elements = Menu,
+                end
-        },
+                Wait(0)
-        function(menuData, menu)
+            end
-            for k in pairs(Menu) do
+        end)
-                if menuData.current.name == Menu[k].name then
+
-                    menu.close()
+    elseif Config.System.Menu == "esx" then
-                    Wait(10)
+        for k in pairs(Menu) do
-                    Menu[k].onSelect()
+            Menu[k].label = Menu[k].header
-                end
+            Menu[k].name = "button"..k
-            end
+        end
-        end,
+        if data.canClose then
-        function(data, menu)
+            table.insert(Menu, 1, {
-            menu.close()
+                icon = "fas fa-circle-xmark",
-        end)
+                label = "Close",
-    end
+                name = "close",
-end
+                onSelect = data.onExit,
-
+            })
---- A line break constant used for formatting menu headers.
+        end
-br = (Config.System.Menu == "ox" or Config.System.Menu == "gta") and "\n" or "<br>"
+        if data.onBack then
-
+            table.insert(Menu, 1, {
---- Checks if the menu system is classified as 'ox' or 'gta'.
+                icon = "fas fa-circle-arrow-left",
----
+                label = "Return",
---- This function is used to decide how to make line breaks in menu headers.
+                name = "return",
----
+                onSelect = data.onBack,
---- @return boolean Returns `true` if the menu system is 'ox' or 'gta'; otherwise, `false`.
+            })
----
+        end
---- @usage
+        ESX.UI.Menu.Open("default", getScript(), "Example_Menu", {
---- ```lua
+            title = data.header,
---- if isOx() then
+            align = 'top-right',
----     -- Use specific formatting
+            elements = Menu,
---- end
+        },
---- ```
+        function(menuData, menu)
-function isOx() return (Config.System.Menu == "ox" or Config.System.Menu == "gta") end
+            for k in pairs(Menu) do
-
+                if menuData.current.name == Menu[k].name then
-
+                    menu.close()
---- Checks if any WarMenu menu is currently open.
+                    Wait(10)
----
+                    Menu[k].onSelect()
---- @return boolean Returns `true` if a WarMenu menu is open; otherwise, `false`.
+                end
----
+            end
---- @usage
+        end,
---- ```lua
+        function(data, menu)
---- if isWarMenuOpen() then
+            menu.close()
----     -- Do something
+        end)
---- end
+    end
---- ```
+end
+
+--- A line break constant used for menu header formatting.
+br = (Config.System.Menu == "ox" or Config.System.Menu == "gta") and "\n" or "<br>"
+
+--- Checks if the current menu system is 'ox' or 'gta' for formatting purposes.
+--- @return boolean boolean True if using ox or gta menus, otherwise false.
+--- @usage
+--- ```lua
+--- if isOx() then
+---     -- Use specific formatting
+--- end
+--- ```
+function isOx() return (Config.System.Menu == "ox" or Config.System.Menu == "gta") end
+
+
+--- Checks if any WarMenu menu is currently open.
+---
+--- @return boolean boolean Returns `true` if a WarMenu menu is open; otherwise, `false`.
+---
+--- @usage
+--- ```lua
+--- if isWarMenuOpen() then
+---     -- Do something
+--- end
+--- ```
 function isWarMenuOpen() if Config.System.Menu == "gta" then return WarMenu.IsAnyMenuOpened() else return false end end

shared/coreloader.lua

@@ -1,170 +1,310 @@
--- Create empty Variables --
+--[[
-Items, Vehicles, Jobs, Gangs, Core, ESX = {}, nil, nil, nil, nil, nil
+    Resource Initialization Module
-
+    --------------------------------
--- Correct QB inventory export (if needed) from 'qb-inventory' to 'ps-inventory' or 'lj-inventory' --
+    This module initializes and loads shared data (Items, Vehicles, Jobs, Gangs) from the
-Exports.QBInv = (isStarted("ps-inventory") and "ps-inventory") or (isStarted("lj-inventory") and "lj-inventory") or Exports.QBInv
+    various frameworks/inventory systems (OX, QB, ESX, etc.). It also corrects export names,
-
+    caches framework exports into simple variables, and prints debug information if enabled.
--- Create simple variables based on the corresponding framework exports --
+]]
-OXLibExport, QBXExport, QBExport, ESXExport, OXCoreExport = Exports.OXLibExport or "", Exports.QBXExport or "", Exports.QBExport or "", Exports.ESXExport or "", Exports.OXCoreExport or ""
+
-
+-------------------------------------------------------------
--- Create simple variables based on the corresponding inventory names --
+-- Global Variable Initialization
-OXInv, QBInv, PSInv, QSInv, CoreInv, CodeMInv, OrigenInv = Exports.OXInv or "", Exports.QBInv or "", Exports.PSInv or "", Exports.QSInv or "", Exports.CoreInv or "", Exports.CodeMInv or "", Exports.OrigenInv or ""
+-------------------------------------------------------------
-
+Items, Vehicles, Jobs, Gangs, Core = {}, nil, nil, nil, nil
--- QB-Menu export name grabbed from exports.lua --
+
-QBMenuExport = Exports.QBMenuExport or ""
+-------------------------------------------------------------
-
+-- Correct QB Inventory Export
--- Target exports based on what is loaded --
+-------------------------------------------------------------
-QBTargetExport, OXTargetExport = Exports.QBTargetExport or "", Exports.OXTargetExport or ""
+-- Correct ps-invetory to ls-inventory if somehow you still have that
-
+Exports.PSInv = isStarted("lj-inventory") and "lj-inventory" or Exports.PSInv
--- If Debug mode is on in the loading script, print the list of found exports --
+
--- Some may "lie", 'ox_target' attempts to use 'qb-target' exports and this print will say its loaded (which is technically true) --
+-------------------------------------------------------------
-for _, v in pairs(Exports) do
+-- Framework Exports and Inventory Identifiers
-    if isStarted(v) then debugPrint("^6Bridge^7: '^3"..v.."^7' ^2export found ^7") end
+-------------------------------------------------------------
-end
+OXLibExport, QBXExport, QBExport, ESXExport, OXCoreExport =
-
+    Exports.OXLibExport or "",
-local itemResource, jobResource, vehResource = "", "", ""
+    Exports.QBXExport or "",
-
+    Exports.QBExport or "",
--- Load item lists --
+    Exports.ESXExport or "",
--- Complies the items from ox_inventory, qb-core or esx into 'Items' and loads them in a layout similar to qb-core's Shared items.lua --
+    Exports.OXCoreExport or ""
--- For example this makes it so instead of QBCore.Shared.Items[item], you can load 'Item[item]' in the script --
+
-if isStarted(OXInv) then itemResource = OXInv
+OXInv, QBInv, PSInv, QSInv, CoreInv, CodeMInv, OrigenInv, TgiannInv =
-    Items = exports[OXInv]:Items()
+    Exports.OXInv or "",
-    for k, v in pairs(Items) do
+    Exports.QBInv or "",
-        if v.client and v.client.image then
+    Exports.PSInv or "",
-            Items[k].image = (v.client.image):gsub("nui://"..OXInv.."/web/images/", "")
+    Exports.QSInv or "",
-        else
+    Exports.CoreInv or "",
-            Items[k].image = k..".png"
+    Exports.CodeMInv or "",
-        end
+    Exports.OrigenInv or "",
-        Items[k].hunger = v.client and v.client.hunger or nil
+    Exports.TgiannInv or ""
-        Items[k].thirst = v.client and v.client.thirst or nil
+
-    end
+RSGExport, RSGInv =
-
+    Exports.RSGExport or "",
-elseif isStarted(QBExport) then itemResource = QBExport
+    Exports.RSGInv or ""
-    Core = Core or exports[QBExport]:GetCoreObject()
+
-    Items = Core and Core.Shared.Items or nil
+QBMenuExport = Exports.QBMenuExport or ""
-    if isStarted(QBExport) and not isStarted(QBXExport) then
+QBTargetExport, OXTargetExport = Exports.QBTargetExport or "", Exports.OXTargetExport or ""
-        RegisterNetEvent('QBCore:Client:UpdateObject', function()
+
-            Core = Core or exports[QBExport]:GetCoreObject()
+-------------------------------------------------------------
-            Items = Core and Core.Shared.Items or nil
+-- Debug: Print Found Exports
-        end)
+-------------------------------------------------------------
-    end
+-- Print a list of all exports that are currently started (if debugMode is enabled).
-
+for _, v in pairs(Exports) do
-elseif isStarted(ESXExport) then itemResource = ESXExport
+    if isStarted(v) then
-    ESX = exports[ESXExport]:getSharedObject()
+        debugPrint("^6Bridge^7: '^3"..v.."^7' export found")
-    Items = ESX and ESX.Items or nil
+    end
-end
+end
--- If it fails to load items, then it will print the error below --
+
--- If it loads them and debug is on, print how many items and where from --
+OxPlayer = nil
-if not Items then
+if isStarted(OXCoreExport) then
-    print("^4ERROR^7: ^2No Core Items detected ^7- ^2Check ^3exports^1.^2lua^7")
+    if not isServer() then
-else
+        OxPlayer = Ox.GetPlayer()
-    debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Items).." ^3Items^2 from ^7" .. itemResource)
+    end
-end
+end
-
+
--- Load Vehicles --
+-------------------------------------------------------------
--- Complies the vehicles from the detected frameworks into a table in the style of qb-cores shared vehicles.lua --
+-- Resource Variables for Items, Jobs, and Vehicles
--- For example, instead of using QBCore.Shared.Vehicles[vehicle] you can load 'Vehicles[vehicle]' in the script --
+-------------------------------------------------------------
-if isStarted(QBXExport) or isStarted(QBExport) then
+local itemResource, jobResource, vehResource = "", "", ""
-    Core = Core or exports[QBExport]:GetCoreObject()
+
-    Vehicles = Core and Core.Shared.Vehicles
+-------------------------------------------------------------
-    if isStarted(QBExport) and not isStarted(QBXExport) then
+-- Loading Items
-        RegisterNetEvent('QBCore:Client:UpdateObject', function()
+-------------------------------------------------------------
-            Core = Core or exports[QBExport]:GetCoreObject()
+-- Load and compile shared items from the detected inventory system.
-            Vehicles = Core and Core.Shared.Vehicles
+if isStarted(OXInv) then
-        end)
+    itemResource = OXInv
-    end
+    Items = exports[OXInv]:Items()
-    vehResource = QBExport
+    for k, v in pairs(Items) do
-elseif isStarted(OXCoreExport) then
+        if v.client and v.client.image then
-    Vehicles = {}
+            Items[k].image = (v.client.image):gsub("nui://"..OXInv.."/web/images/", "")
-    for k, v in pairs(Ox.GetVehicleData()) do
+        else
-        Vehicles[k] = { model = k, price = v.price, name = v.name, brand = v.make }
+            Items[k].image = k..".png"
-    end
+        end
-    vehResource = OXCoreExport
+        Items[k].hunger = v.client and v.client.hunger or nil
-elseif isStarted(ESXExport) then
+        Items[k].thirst = v.client and v.client.thirst or nil
-    -- print("^6Bridge^7: ^2Loading ^3Vehicles^2 from ^7"..ESXExport)
+    end
-    -- print("^6Bridge^7: ^2Loading ^6"..countTable(Vehicles).." ^3Vehicles^2 from ^7"..ESXExport)
+
-    CreateThread(function()
+elseif isStarted(QBExport) then
-        if isServer() then
+    itemResource = QBExport
-            createCallback(getScript()..":getVehiclesPrices", function(source)
+    Core = Core or exports[QBExport]:GetCoreObject()
-                Vehicles = MySQL.query.await('SELECT model, price, name FROM vehicles')
+    Items = Core and Core.Shared.Items or nil
-                vehResource = ESXExport
+    CreateThread(function()
-                return Vehicles
+        while not Items or not next(Items) do
-            end)
+            Items = exports[QBExport]:GetCoreObject().Shared.Items
-        end
+            Wait(1000)
-        if not isServer() then
+        end
-            local TempVehicles = triggerCallback(getScript()..":getVehiclesPrices")
+    end)
-            for _, v in pairs(TempVehicles) do
+    if isStarted(QBExport) and not isStarted(QBXExport) then
-                Vehicles = Vehicles or {}
+        RegisterNetEvent('QBCore:Client:UpdateObject', function()
-                Vehicles[v.model] = { model = v.model, price = v.price, name = v.name, brand = GetMakeNameFromVehicleModel(v.model):lower():gsub("^%l", string.upper) }
+            Core = Core or exports[QBExport]:GetCoreObject()
-            end
+            Items = Core and Core.Shared.Items or nil
-        end
+        end)
-    end)
+    end
-end
+
-if vehResource == nil then
+elseif isStarted(ESXExport) then
-    print("^4ERROR^7: ^2No Vehicle info detected ^7- ^2Check ^3exports^1.^2lua^7")
+    itemResource = ESXExport
-else
+    CreateThread(function()
-    debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Vehicles).." ^3Vehicles^2 from ^7"..vehResource)
+        if isServer() then
-end
+            Items = ESX.GetItems()
-
+            while not createCallback do Wait(100) end
--- Load Jobs --
+            createCallback(getScript()..":getItems", function(source)
--- Attempts to load the details of jobs and gangs and compile into tables --
+                return Items
--- For example, instead of using QBCore.Shared.Jobs[job] you can load 'Jobs[job]' in the script --
+            end)
-if isStarted(QBXExport) then jobResource = QBXExport
+        end
-    Core = Core or exports[QBExport]:GetCoreObject()
+        if not isServer() then
-    Jobs, Gangs = exports[QBXExport]:GetJobs(), exports[QBXExport]:GetGangs()
+            Items = triggerCallback(getScript()..":getItems")
-
+            debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Items).." ^3Items^2 from ^7"..itemResource)
-elseif isStarted(OXCoreExport) then  jobResource = OXExport
+        end
-    CreateThread(function()
+    end)
-        if isServer() then
+
-            createCallback(getScript()..":getOxGroups", function(source)
+elseif isStarted(RSGExport) then
-                Jobs = MySQL.query.await('SELECT * FROM `ox_groups`') return Jobs
+    itemResource = RSGExport
-            end)
+    Core = Core or exports[RSGExport]:GetCoreObject()
-        else
+    Items = Core and Core.Shared.Items or nil
-            local TempJobs = triggerCallback(getScript()..":getOxGroups")
+    RegisterNetEvent('RSGCore:Client:UpdateObject', function()
-            Jobs = TempJobs or {}
+        Core = Core or exports[RSGExport]:GetCoreObject()
-            for k, v in pairs(TempJobs) do
+        Items = Core and Core.Shared.Items or nil
-                local grades = {}
+    end)
-                for i = 1, #v.grades do grades[i] = { name = v.grades[i], isboss = (i == #v.grades)} end
+
-                Jobs[v.name] = { label = v.label, grades = grades }
+end
-            end
+
-            Gangs = Jobs
+if itemResource == nil then
-        end
+    print("^4ERROR^7: ^2No Item info detected ^7- ^2Check ^3starter^1.^2lua^7")
-    end)
+else
-
+    while not Items do Wait(100) end
-elseif isStarted(QBExport) then jobResource = QBExport
+    debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Items).." ^3Items^2 from ^7"..itemResource)
-    Core = Core or exports[QBExport]:GetCoreObject()
+end
-    Jobs, Gangs = Core.Shared.Jobs, Core.Shared.Gangs
+
-    if isStarted(QBExport) and not isStarted(QBXExport) then
+
-        RegisterNetEvent('QBCore:Client:UpdateObject', function()
+-------------------------------------------------------------
-            Core = exports[QBExport]:GetCoreObject()
+-- Loading Vehicles
-            Jobs, Gangs = Core.Shared.Jobs, Core.Shared.Gangs
+-------------------------------------------------------------
-        end)
+-- Compile vehicles from the detected frameworks into a unified table.
-    end
+if isStarted(QBXExport) or isStarted(QBExport) then
-
+    vehResource = QBExport
-elseif isStarted(ESXExport) then
+    Core = Core or exports[QBExport]:GetCoreObject()
-    --print("^6Bridge^7: ^2Loading ^3Jobs^7/^3Gangs^2 from ^7"..ESXExport)
+    Vehicles = Core and Core.Shared.Vehicles
-    ESX = exports[ESXExport]:getSharedObject()
+    if isStarted(QBExport) and not isStarted(QBXExport) then
-    if isServer() then
+        RegisterNetEvent('QBCore:Client:UpdateObject', function()
-        Jobs = ESX.GetJobs()
+            Core = Core or exports[QBExport]:GetCoreObject()
-        for k, v in pairs(Jobs) do
+            Vehicles = Core and Core.Shared.Vehicles
-            local count = countTable(Jobs[k].grades)-1
+        end)
-            Jobs[k].grades[tostring(count)].isBoss = true
+    end
-        end
+
-        Gangs = Jobs
+elseif isStarted(OXCoreExport) then
-    end
+    vehResource = OXCoreExport
-    CreateThread(function()
+    Vehicles = {}
-        while not ESX do Wait(0) end
+    for k, v in pairs(Ox.GetVehicleData()) do
-        if isServer() then
+        Vehicles[k] = { model = k, hash = GetHashKey(k), price = v.price, name = v.name, brand = v.make }
-            createCallback(getScript()..":getJobs", function(source)
+    end
-                return Jobs
+
-            end)
+elseif isStarted(ESXExport) then
-        end
+    vehResource = ESXExport
-        if not isServer() then
+    CreateThread(function()
-            Jobs = triggerCallback(getScript()..":getJobs")
+        if isServer() then
-            Gangs = Jobs
+            createCallback(getScript()..":getVehiclesPrices", function(source)
-        end
+                return Vehicles
-    end)
+            end)
-end
+            while not MySQL do Wait(2000) print("^1Waiting for MySQL to exist") end
-if not isStarted(ESXExport) and Jobs then
+            Vehicles = MySQL.query.await('SELECT model, price, name FROM vehicles')
-    debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Jobs).." ^3Jobs^2 from ^7"..jobResource, "^6Bridge^7: ^2Loading ^6"..countTable(Gangs).." ^3Gangs^2 from ^7"..jobResource)
+        end
+        if not isServer() then
+            --while not triggerCallback do print("waiting") Wait(100) end
+            local TempVehicles = triggerCallback(getScript()..":getVehiclesPrices")
+            for _, v in pairs(TempVehicles) do
+                Vehicles = Vehicles or {}
+                Vehicles[v.model] = {
+                    model = v.model,
+                    hash = GetHashKey(v.model),
+                    price = v.price,
+                    name = v.name,
+                    brand = GetMakeNameFromVehicleModel(v.model):lower():gsub("^%l", string.upper)
+                }
+            end
+        end
+    end)
+
+elseif isStarted(RSGExport) then
+    vehResource = RSGExport
+    Core = Core or exports[RSGExport]:GetCoreObject()
+    Vehicles = Core and Core.Shared.Vehicles
+    RegisterNetEvent('RSGCore:Client:UpdateObject', function()
+        Core = Core or exports[RSGExport]:GetCoreObject()
+        Vehicles = Core and Core.Shared.Vehicles
+    end)
+end
+if vehResource == nil then
+    print("^4ERROR^7: ^2No Vehicle info detected ^7- ^2Check ^3starter^1.^2lua^7")
+else
+    while not Vehicles do Wait(1000) end
+    debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Vehicles).." ^3Vehicles^2 from ^7"..vehResource)
+end
+
+-------------------------------------------------------------
+-- Loading Jobs and Gangs
+-------------------------------------------------------------
+-- Compile jobs and gangs from the detected framework.
+if isStarted(QBXExport) then
+    jobResource = QBXExport
+    Core = Core or exports[QBExport]:GetCoreObject()
+    Jobs, Gangs = exports[QBXExport]:GetJobs(), exports[QBXExport]:GetGangs()
+
+elseif isStarted(OXCoreExport) then
+    jobResource = OXExport
+    CreateThread(function()
+        if isServer() then
+            createCallback(getScript()..":getOxGroups", function(source)
+                Jobs = MySQL.query.await('SELECT * FROM `ox_groups`')
+                return Jobs
+            end)
+        else
+            local TempJobs = triggerCallback(getScript()..":getOxGroups")
+            Jobs = {}
+            for k, v in pairs(TempJobs) do
+                local grades = {}
+                --for i = 1, #v.grades do
+                --    grades[i] = { name = v.grades[i], isboss = (i == #v.grades) }
+                --end
+                Jobs[v.name] = { label = v.label, grades = grades }
+            end
+            Gangs = Jobs
+        end
+    end)
+
+elseif isStarted(QBExport) then
+    jobResource = QBExport
+    Core = Core or exports[QBExport]:GetCoreObject()
+    Jobs, Gangs = Core.Shared.Jobs, Core.Shared.Gangs
+    if isStarted(QBExport) and not isStarted(QBXExport) then
+        RegisterNetEvent('QBCore:Client:UpdateObject', function()
+            Core = exports[QBExport]:GetCoreObject()
+            Jobs, Gangs = Core.Shared.Jobs, Core.Shared.Gangs
+        end)
+    end
+
+elseif isStarted(ESXExport) then
+    jobResource = ESXExport
+    if isServer() then
+        -- If server, create callback to get jobs
+        createCallback(getScript()..":getESXJobs", function(source)
+            return Jobs
+        end)
+        -- Populate jobs table with ESX.GetJobs()
+        Jobs = ESX.GetJobs()
+        --jsonPrint(Jobs)
+        --If retreived jobs is empty, wait for ESX to load
+        while countTable(Jobs) == 0 do
+            Jobs = ESX.GetJobs()
+            Wait(100)
+        end
+        -- Organise into a table the script can use
+        for Role, Grades in pairs(Jobs) do
+
+            -- Check for "Boss" in name of grades
+            for grade, info in pairs(Grades.grades) do
+                --print(grade)
+                --jsonPrint(info)
+
+                if info.label then
+                    --print(info)
+                    if info.label:find("boss") or info.label:find("Boss") then
+                        --print("Found Boss label for:", Grades.label)
+                        Jobs[Role].grades[grade].isBoss = true
+                        goto continue
+                    end
+                end
+            end
+
+            -- If no roles with "boss" in the name, revert to max grade
+
+            -- Count grades
+            local count = countTable(Grades.grades)
+            Jobs[Role].grades[tostring(count-1)].isBoss = true
+            --print(Grades.label.." Grade: "..count.." is Boss")
+            ::continue::
+        end
+        -- ESX Default doesn't have gangs, so copy jobs to gangs
+        Gangs = Jobs
+    end
+    -- If client side, trigger callback to get jobs
+    if not isServer() then
+        Jobs = triggerCallback(getScript()..":getESXJobs")
+        Gangs = Jobs
+    end
+
+elseif isStarted(RSGExport) then
+    jobResource = RSGExport
+    Core = Core or exports[RSGExport]:GetCoreObject()
+    Jobs, Gangs = Core.Shared.Jobs, Core.Shared.Gangs
+    RegisterNetEvent('RSGCore:Client:UpdateObject', function()
+        Core = exports[RSGExport]:GetCoreObject()
+        Jobs, Gangs = Core.Shared.Jobs, Core.Shared.Gangs
+    end)
+end
+
+if jobResource == nil then
+    print("^4ERROR^7: ^2No Vehicle info detected ^7- ^2Check ^3starter^1.^2lua^7")
+else
+    while not Jobs do Wait(1000) end
+    debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Jobs).." ^3Jobs^2 from ^7"..jobResource)
+    debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Gangs).." ^3Gangs^2 from ^7"..jobResource)
 end

shared/crafting.lua

@@ -1,481 +1,494 @@
-local CraftLock = false
+--[[
-
+    Crafting, Selling, and Shop Module
---- Opens a crafting menu based on the provided data.
+    -----------------------------------
----
+    This module provides functions for opening crafting menus, handling multi-crafting,
---- This function checks job requirements, prepares the menu options, and opens the crafting menu.
+    performing the crafting process (with animations and progress bars), selling items,
---- It handles item availability, crafting recipes, and displays appropriate icons and labels.
+    and opening shop interfaces. It integrates with various inventory and menu systems,
----
+    and uses server callbacks to check item carry capacity.
----@param data table A table containing crafting menu data.
+]]
---- - **craftable** (`table`): The crafting options and settings.
+
----   - **Header** (`string`): The header/title of the crafting menu.
+-------------------------------------------------------------
----   - **Recipes** (`table`): A list of crafting recipes.
+-- Global Variables
---- - **coords** (`vector3`): The coordinates where the crafting menu is being opened.
+-------------------------------------------------------------
---- - **stashTable** (`string` or `table`, optional): The stash name(s) to check for item availability.
+CraftLock = false
---- - **stashName** (`string` or `table`, optional): Alias for `stashTable`.
+
---- - **job** (`string` or `table`, optional): Job(s) required to access the crafting menu.
+-- helper filter table for crafting menus
---- - **gang** (`string` or `table`, optional): Gang(s) required to access the crafting menu.
+local excludeKeys = {
---- - **onBack** (`function`, optional): Function to call when returning from the menu.
+    amount = true, metadata = true, description = true, info = true,
----
+    job = true, gang = true, oneUse = true, slot = true,
----@usage
+    blueprintRef = true, craftingLevel = true, craftedItems = true,
---- ```lua
+    hasCrafted = true, exp = true, anim = true, time = true,
---- craftingMenu({
+}
----     craftable = {
+
----         Header = "Weapon Crafting",
+-------------------------------------------------------------
----         Recipes = {
+-- Crafting Menu
----             [1] = {
+-------------------------------------------------------------
----                 ["weapon_pistol"] = { ["steel"] = 5, ["plastic"] = 2 },
+
----                 amount = 1,
+--- Opens the crafting menu based on provided data.
----             },
+--- Checks job restrictions, builds the recipe menu, and opens the menu.
----             -- More recipes...
+---
----         },
+--- @param data table Crafting menu configuration containing:
----         Anims = {
+---     - craftable (`table`) Table with Header, Recipes, Anims, and (optionally) craftedItems.
----             animDict = "amb@prop_human_parking_meter@male@idle_a",
+---     - coords (`vector3`) The coordinates where the crafting menu is being opened.
----             anim = "idle_a",
+---     - stashTable|stashName (`string\table`) Name(s) of the stash for checking item availability.
----         },
+---     - job|gang (`string`) Job or gang requirements.
----     },
+---     - onBack (optional): Function to call when returning.
----     coords = vector3(100.0, 200.0, 300.0),
+---
----     stashTable = "crafting_stash",
+--- @usage
----     job = "mechanic", -- Optional
+--- ```lua
----     onBack = function() print("Returning to previous menu") end,
+--- craftingMenu({
---- })
+---      craftable = {
---- ```
+---          Header = "Weapon Crafting",
-function craftingMenu(data)
+---          Recipes = {
-    if CraftLock then return end
+---              [1] = {
-    if (data.job or data.gang) and not jobCheck(data.job or data.gang) then return end
+---                  ["weapon_pistol"] = { ["steel"] = 5, ["plastic"] = 2 },
-    if Config.System.Menu == "jim" then
+---                  amount = 1,
-        triggerNotify(nil, "Thinking", "info")
+---              },
-    else
+---              -- More recipes...
-        openMenu({ { header = "Thinking...", icon = "fas fa-hourglass-end", isMenuHeader = true } }, { header = "Crafting Menu" } )
+---          },
-    end
+---          Anims = {
-    if data.stashTable then data.stashName = data.stashTable end
+---              animDict = "amb@prop_human_parking_meter@male@idle_a",
-    local Menu, hasjob = {}, false
+---              anim = "idle_a",
-    local Recipes = data.craftable.Recipes
+---          },
-    local tempCarryTable = {}
+---      },
-    for i = 1, #Recipes do
+---      coords = vector3(100.0, 200.0, 300.0),
-        for k in pairs(Recipes[i]) do
+---      stashTable = "crafting_stash",
-            if k ~= "amount" and k ~= "metadata" and k ~= "job" and k ~= "gang" then
+---      job = "mechanic",
-                tempCarryTable[k] = Recipes[i].amount or 1
+---      onBack = function() print("Returning to previous menu") end,
-            end
+--- })
-        end
+function craftingMenu(data)
-    end
+    if CraftLock then return end
-
+
-    local canCarryTable = triggerCallback(getScript()..':server:canCarry', tempCarryTable)
+    -- Job or gang check; exit if not authorized.
-    for i = 1, #Recipes do
+    if (data.job or data.gang) and not jobCheck(data.job or data.gang) then return end
-        if not Recipes[i]["amount"] then Recipes[i]["amount"] = 1 end
+
-        for k, v in pairs(Recipes[i]) do
+    -- Display a temporary "thinking" notification.
-            if k ~= "amount" and k ~= "metadata" and k ~= "job" and k ~= "gang" then
+    if Config.System.Menu == "jim" then
-                if Recipes[i].job then
+        triggerNotify(nil, "Thinking", "info")
-                    for l, b in pairs(Recipes[i].job) do
+    else
-                        hasjob = hasJob(l, nil, b)
+        openMenu({ { header = "Thinking...", icon = "fas fa-hourglass-end", isMenuHeader = true } }, { header = "Crafting Menu" } )
-                        if hasjob == true then break end
+    end
-                    end
+
-                else hasjob = true end
+    -- Normalize stash name.
-                local setheader, settext, disable, metadata = "", "", false, (Recipes[i]["metadata"] or nil)
+    data.stashName = data.stashTable or data.stashName
-                if hasjob then
+
-                    local itemTable = {}
+    local Menu = {}
-                    local metaTable = {}
+    local Recipes = data.craftable.Recipes
-                    for l, b in pairs(Recipes[i][tostring(k)]) do
+    local craftedItems = {}
-                        settext = settext..(settext ~= "" and br or "")..(Items[l] and Items[l].label or "error - "..l)..(b > 1 and " x"..b or "")
+    local tempCarryTable = {}
-                        metaTable[Items[l] and Items[l].label or "error - "..l] = b
+
-                        itemTable[l] = b
+    -- Build a table of all required ingredients (default quantity is 1).
-                        Wait(0)
+    for i = 1, #Recipes do
-                    end
+        for k in pairs(Recipes[i]) do
-                    while not canCarryTable do Wait(0) end
+            if k ~= "amount" and k ~= "metadata" and k ~= "job" and k ~= "gang" then
-                    disable = not checkHasItem(data.stashName, itemTable)
+                tempCarryTable[k] = Recipes[i].amount or 1
-                    setheader = ((metadata and metadata.label) or (Items[tostring(k)] and Items[tostring(k)].label) or "error - " .. tostring(k)) .. (Recipes[i]["amount"] > 1 and " x" .. Recipes[i]["amount"] or "")
+            end
-                    if not disable then
+        end
-                        if not canCarryTable[k] then setheader = setheader .. " 📦"
+    end
-                        else setheader = setheader .. " ✔️" end
+
-                    elseif not canCarryTable[k] then setheader = setheader .. " 📦" end
+    -- Check if the player can carry the required items (server callback).
-                    Menu[#Menu + 1] = {
+    local canCarryTable = triggerCallback(getScript()..':server:canCarry', tempCarryTable)
-                        arrow = not disable and canCarryTable[k],
+    -- Process each recipe to create menu entries.
-                        disable = isStarted(QBMenuExport) and disable and not canCarryTable[k],
+    for i = 1, #Recipes do
-                        icon = invImg((metadata and metadata.image) or tostring(k)),
+        if not Recipes[i]["amount"] then Recipes[i]["amount"] = 1 end
-                        image = invImg((metadata and metadata.image) or tostring(k)),
+        for k, _ in pairs(Recipes[i]) do
-                        header = setheader..((disable or not canCarryTable[k]) and " ❌" or ""),
+            if not excludeKeys[k] then
-                        txt = isStarted(QBMenuExport) and settext or nil,
+                local hasjob = true
-                        --metadata = debugMode and Recipes[i]["metadata"] or nil,
+                if Recipes[i].job then
-                        metadata = metaTable,
+                    for l, b in pairs(Recipes[i].job) do
-                        onSelect = ((not disable and canCarryTable[k]) and (function()
+                        hasjob = hasJob(l, nil, b)
-                            local transdata = { item = k, craft = data.craftable.Recipes[i], craftable = data.craftable, coords = data.coords, stashName = data.stashName, onBack = data.onBack, metadata = Recipes[i]["metadata"] }
+                        if hasjob then break end
-                            if Config.Crafting.MultiCraft then multiCraft(transdata) else makeItem(transdata) end
+                    end
-                        end) or nil),
+                end
-                    }
+                if hasjob then
-                end
+                    local setheader, settext, disable, metadata = "", "", false, (Recipes[i]["metadata"] or Recipes[i]["info"] or nil)
-            end
+                    local itemTable = {}
-            Wait(0)
+                    local metaTable = {}
-        end
+                    -- Build ingredient details.
-    end
+                    for l, b in pairs(Recipes[i][tostring(k)]) do
-    openMenu(Menu, { header = data.craftable.Header, onBack = data.onBack or nil, canClose = true, onExit = function() end, })
+                        settext = settext..(settext ~= "" and br or "")..(Items[l] and Items[l].label or "error - "..l)..(b > 1 and " x"..b or "")
-    lookEnt(data.coords)
+                        metaTable[Items[l] and Items[l].label or "error - "..l] = b
-end
+                        itemTable[l] = b
-
+                        --Wait(0)
---- Opens a menu for selecting the quantity to craft.
+                    end
----
+
---- This function presents the player with options to craft multiple quantities of an item, based on `Config.Crafting.MultiCraftAmounts`.
+                    while not canCarryTable do Wait(0) end
----
+                    disable = not checkStashItem(data.stashName, itemTable)
----@param data table A table containing crafting data.
+                    setheader = ((metadata and metadata.label) or (Items[tostring(k)] and Items[tostring(k)].label) or "error - "..tostring(k))
---- - **item** (`string`): The item to craft.
+                               ..(Recipes[i]["amount"] > 1 and " x"..Recipes[i]["amount"] or "")
---- - **craft** (`table`): The crafting recipe for the item.
+
---- - **craftable** (`table`): The crafting options and settings.
+                    local statusEmoji = disable and " ❌" or not canCarryTable[k] and " 📦" or " ✔️"
---- - **coords** (`vector3`): The coordinates where the crafting is taking place.
+                    local isNew = (Recipes[i]["hasCrafted"] ~= nil and craftedItems[k] == nil) and "✨ " or ""
---- - **stashName** (`string` or `table`, optional): The stash name(s) to check for item availability.
+                    setheader = isNew .. setheader .. statusEmoji
---- - **onBack** (`function`, optional): Function to call when returning from the menu.
+
---- - **metadata** (`table`, optional): Metadata for the crafted item.
+                    Menu[#Menu + 1] = {
----
+                        arrow = not disable and canCarryTable[k],
----@usage
+                        isMenuHeader = disable or not canCarryTable[k],
---- ```lua
+                        icon = invImg((metadata and metadata.image) or tostring(k)),
---- multiCraft({
+                        image = invImg((metadata and metadata.image) or tostring(k)),
----     item = "weapon_pistol",
+                        header = setheader,
----     craft = { ["weapon_pistol"] = { ["steel"] = 5, ["plastic"] = 2 }, amount = 1 },
+                        txt = (isStarted(QBMenuExport) or disable) and settext or nil,
----     craftable = craftingOptions,
+                        metadata = metaTable,
----     coords = vector3(100.0, 200.0, 300.0),
+                        onSelect = (not disable and canCarryTable[k]) and function()
----     stashName = "crafting_stash",
+                            local transdata = {
----     onBack = function() craftingMenu(data) end,
+                                item = k,
----     metadata = { label = "Custom Pistol", image = "custom_pistol.png" },
+                                craft = data.craftable.Recipes[i],
---- })
+                                craftable = data.craftable,
---- ```
+                                coords = data.coords,
-function multiCraft(data)
+                                stashName = data.stashName,
-    local Menu = {}
+                                onBack = data.onBack,
-    local success = Config.Crafting.MultiCraftAmounts
+                                metadata = metadata,
-    local metadata = data.metadata or nil
+                            }
-    Menu[#Menu+1] = {
+                            if Config.Crafting.MultiCraft then
-        isMenuHeader = true,
+                                multiCraft(transdata)
-        icon = invImg(metadata and metadata.image or data.item),
+                            else
-        header = metadata and metadata.label or Items[data.item].label,
+                                makeItem(transdata)
-    }
+                            end
-    for k in pairsByKeys(success) do
+                        end or nil,
-        local settext = ""
+                    }
-        local itemTable = {}
+                end
-        for l, b in pairs(data.craft[data.item]) do
+            end
-            itemTable[l] = (b * k)
+            --Wait(0)
-            settext = settext..(settext ~= "" and br or "")..Items[l].label..(b*k > 1 and "- x"..b*k or "")
+        end
-            Wait(0)
+    end
-        end
+
-        local disable, stashname = checkHasItem(data.stashName, itemTable)
+    openMenu(Menu, {
-        Menu[#Menu + 1] = {
+        header = data.craftable.Header,
-            isMenuHeader = not disable,
+        headertxt = data.craftable.Headertxt,
-            arrow = disable,
+        onBack = data.onBack or nil,
-            header = "Craft - x"..k * data.craft.amount,
+        canClose = true,
-            txt = settext,
+        onExit = data.onExit or (function() end),
-            onSelect = function ()
+    })
-                makeItem({item = data.item, craft = data.craft, craftable = data.craftable, amount = k, coords = data.coords, stashName = stashname, stashTable = data.stashName, onBack = data.onBack, metadata = data.metadata })
+    lookEnt(data.coords)
-            end,
+end
-        }
+
-    end
+-------------------------------------------------------------
-    openMenu(Menu, { header = data.craftable.Header, onBack = function() craftingMenu(data) end, })
+-- Multi-Craft Menu
-end
+-------------------------------------------------------------
-
+
---- Initiates the crafting process for a specified item.
+--- Opens a menu for selecting the quantity to craft.
----
+---
---- This function handles the crafting animation, progress bar, item removal, and item creation.
+--- Presents the player with multiple crafting quantities based on Config.Crafting.MultiCraftAmounts.
----
+---
----@param data table A table containing crafting data.
+--- @param data table Crafting configuration containing:
---- - **item** (`string`): The item to craft.
+---     - item `string`) The item to craft.
---- - **craft** (`table`): The crafting recipe for the item.
+---     - craft (`table`) The crafting recipe.
---- - **craftable** (`table`): The crafting options and settings.
+---     - craftable (`table`)  Crafting options.
---- - **amount** (`number`, optional): The quantity to craft. Default is `1`.
+---     - coords (`vector3`) where crafting occurs.
---- - **coords** (`vector3`): The coordinates where the crafting is taking place.
+---     - stashName (`string`) The stash name(s) for item availability.
---- - **stashName** (`string` or `table`, optional): The stash name(s) to remove items from.
+---     - onBack (`function`) Callback when returning.
---- - **stashTable** (`string` or `table`, optional): Alias for `stashName`.
+---     - metadata (`table`) (optional): Metadata for the crafted item.
---- - **onBack** (`function`, optional): Function to call when returning from the menu.
+---
---- - **metadata** (`table`, optional): Metadata for the crafted item.
+--- @usage
----
+--- ```lua
----@usage
+--- multiCraft({
---- ```lua
+---     item = "weapon_pistol",
---- makeItem({
+---     craft = { ["weapon_pistol"] = { ["steel"] = 5, ["plastic"] = 2 }, amount = 1 },
----     item = "weapon_pistol",
+---     craftable = craftingOptions,
----     craft = { ["weapon_pistol"] = { ["steel"] = 5, ["plastic"] = 2 }, amount = 1 },
+---     coords = vector3(100,200,300),
----     craftable = craftingOptions,
+---     stashName = "crafting_stash",
----     amount = 2,
+---     onBack = function() craftingMenu(data) end,
----     coords = vector3(100.0, 200.0, 300.0),
+---     metadata = { label = "Custom Pistol", image = "custom_pistol.png" },
----     stashName = "crafting_stash",
+--- })
----     onBack = function() craftingMenu(data) end,
+--- ```
----     metadata = { label = "Custom Pistol", image = "custom_pistol.png" },
+function multiCraft(data)
---- })
+    local max = 0
---- ```
+    local stashName = nil
-function makeItem(data)
+    local maxCreation = 100
-    if CraftLock then return end
+
-    CraftLock = true
+    -- Generate item table to check against stash or inventory
-    if data.stashTable then data.stashName = data.stashTable end
+    -- takes into account the ingredients needed for multiple items
-    local bartime = data.craftable.progressBar and data.craftable.progressBar.time or 5000
+    local multiItemTable = {}
-    local bartext = (data.craftable.progressBar and data.craftable.progressBar.label) or (Loc[Config.Lan].progressbar and Loc[Config.Lan].progressbar["progress_make"]) or "Making a"
+
-    local animDict = data.craftable.Anims and data.craftable.Anims.animDict or "amb@prop_human_parking_meter@male@idle_a"
+    for i = 1, maxCreation do
-    local anim = data.craftable.Anims and data.craftable.Anims.anim or "idle_a"
+        multiItemTable[i] = {}
-    local amount = data.amount and (data.amount ~= 1) and data.amount or 1
+        for l, b in pairs(data.craft[data.item]) do
-    local metadata = data.metadata or nil
+            multiItemTable[i][l] = (b * i)
-    local prop = data.craftable.Anims and data.craftable.Anims.prop or nil
+        end
-
+    end
-    local crafted, crafting = true, true
+
-    local cam = createTempCam(PlayerPedId(), data.coords)
+    for i = 1, maxCreation do
-    startTempCam(cam)
+        -- if its received a stash name, check if the items are in the stash
-
+        if data.stashName then
-    for i = 1, amount do
+            local hasItems, stashname = checkStashItem(data.stashName, multiItemTable[i])
-        for k, v in pairs(data.craft) do
+            if hasItems == true then
-            if k ~= "amount" and k ~= "metadata" and k ~= "job" and k ~= "gang" then
+                max += 1
-                if type(v) == "table" then
+                stashName = stashname
-                    for l, b in pairs(v) do
+            else
-                        if crafting and progressBar({
+                break
-                            label = "Using "..b.." "..Items[l].label,
+            end
-                            time = 1000,
+        else
-                            cancel = true,
+            -- if not check the players inventory for the items
-                            dict = 'pickup_object',
+            local has, _ = hasItem(multiItemTable[i], nil, nil)
-                            anim = "putdown_low",
+            if has then
-                            flag = 48,
+                max += 1
-                            icon = l,
+            else
-                        }) then
+                break
-                            TriggerEvent((isStarted(QBInv) and QBInvNew and "qb-" or "").."inventory:client:ItemBox", Items[l], "use", b) -- Show item box for each item
+            end
-                        else
+        end
-                            crafted, crafting = false, false
+    end
-                            break
+
-                        end
+    local carryMax = triggerCallback(getScript()..":server:getMaxCarryCraft", {
-                        Wait(200)
+        item = data.item,
-                    end
+        max = max
-                    if crafted then
+    })
-                        local craftProp = nil
+
-                        if prop then
+    local dialog = createInput(data.craftable.Header..(Config.System.Menu == "qb" and ": "..br.."How many to craft? "..br.."Max: "..carryMax or ""), {
-                            local model, pos, rot, bone = prop.model, prop.pos, prop.rot, prop.bone
+        ((Config.System.Menu == "ox") and {
-                            craftProp = makeProp({ prop = model, coords = vec4(0, 0, 0, 0), true, true })
+            type = "slider",
-                            AttachEntityToEntity(craftProp, PlayerPedId(), GetPedBoneIndex(PlayerPedId(), bone), pos.x, pos.y, pos.z, rot.x, rot.y, rot.z, true, true, false, true, 1, true)
+            label = "How many to craft? "..br.."Max: "..carryMax,
-                        end
+            required = true,
-                        if crafting and progressBar({
+            default = 1,
-                            label = bartext..((metadata and metadata.label) or Items[data.item].label),
+            min = 1,
-                            time = bartime,
+            max = carryMax
-                            cancel = true,
+        }) or nil,
-                            dict = animDict,
+        ((Config.System.Menu == "qb") and {
-                            anim = anim,
+            type = "number",
-                            flag = 49,
+            name = "amount",
-                            icon = data.item,
+            isRequired = true,
-                        }) then
+            default = 1,
-                            TriggerServerEvent(getScript()..":Crafting:GetItem", data.item, data.craft, data.stashName, metadata)
+        }) or nil,
-                        else
+    })
-                            crafting = false
+
-                            break
+    if dialog then
-                        end
+        if Config.System.Menu == "ox" then
-                        if craftProp then destroyProp(craftProp) end
+
-                    end
+        end
-                end
+        if Config.System.Menu == "qb" then
-            end
+            dialog["amount"] = tonumber(dialog["amount"])
-        end
+            if dialog["amount"] > carryMax or dialog["amount"] < 1 or dialog["amount"] == nil or dialog["amount"] == "" then
-        Wait(500)
+                triggerNotify(nil, "Invalid Amount", "error")
-    end
+                craftingMenu(data)
-    stopTempCam()
+                return
-    CraftLock = false
+            end
-    lockInv(false)
+        end
-    craftingMenu(data)
+
-    ClearPedTasks(PlayerPedId())
+        makeItem({
-end
+            item = data.item,
-
+            craft = data.craft,
---- Server event handler for giving the crafted item to the player.
+            craftable = data.craftable,
----
+            amount = dialog["amount"] or dialog[1],
---- This event is triggered when the crafting process is completed successfully.
+            coords = data.coords,
----
+            stashName = stashName or nil,
---- @param ItemMake string The item being crafted.
+            onBack = data.onBack,
---- @param craftable table The crafting recipe and details.
+            metadata = data.metadata,
---- @param stashName string|table The stash name(s) to remove items from.
+        })
---- @param metadata table (optional) Metadata for the crafted item.
+    end
-RegisterNetEvent(getScript()..":Crafting:GetItem", function(ItemMake, craftable, stashName, metadata)
+end
-    local src, amount, stashItems = source, craftable and craftable.amount or 1, nil
+
-    if stashName then
+-------------------------------------------------------------
-        local itemRemove = {}
+-- Crafting Process
-        if type(stashName) == "table" then
+-------------------------------------------------------------
-            for _, name in pairs(stashName) do
+
-                stashItems = getStash(name)
+--- Initiates the crafting process for a specified item.
-                for k, v in pairs(craftable[ItemMake] or {}) do
+---
-                    for _, b in pairs(stashItems or {}) do
+--- Plays crafting animations, shows progress bars, removes ingredients, and triggers item creation.
-                        if k == b.name then itemRemove[k] = v end
+---
-                    end
+--- @param data table Crafting configuration containing:
-                end
+---     - item `string`) The item to craft.
-            end
+---     - craft (`table`) The crafting recipe.
-        else
+---     - craftable (`table`)  Crafting options.
-            stashItems = getStash(stashName)
+---     - amount (`number`) (optional): Quantity to craft (default 1).
-            for k, v in pairs(craftable[ItemMake] or {}) do
+---     - coords (`vector3`) where crafting occurs.
-                for _, b in pairs(stashItems or {}) do
+---     - stashName (`string`) The stash name(s) for item availability.
-                    if k == b.name then itemRemove[k] = v end
+---     - onBack (`function`) Callback when returning.
-                end
+---     - metadata (`table`) (optional): Metadata for the crafted item.
-            end
+---
-        end
+--- @usage
-        stashRemoveItem(stashItems, stashName, itemRemove)
+--- ```lua
-    else
+--- makeItem({
-        if craftable then
+---     item = "weapon_pistol",
-            for k, v in pairs(craftable[ItemMake] or {}) do
+---     craft = { ["weapon_pistol"] = { ["steel"] = 5, ["plastic"] = 2 }, amount = 1 },
-                TriggerEvent(getScript()..":server:toggleItem", false, tostring(k), v, src)
+---     craftable = craftingOptions,
-            end
+---     amount = 2,
-        end
+---     coords = vector3(100,200,300),
-    end
+---     stashName = "crafting_stash",
-    TriggerEvent(getScript()..":server:toggleItem", true, ItemMake, amount, src, metadata)
+---     onBack = function() craftingMenu(data) end,
-    --if isStarted("core_skills") then exports["core_skills"]:AddExperience(src, 2) end
+---     metadata = { label = "Custom Pistol", image = "custom_pistol.png" },
-end)
+--- })
-
+--- ```
---- Opens a selling menu based on the provided data.
+function makeItem(data)
----
+    if CraftLock then return end
---- This function checks available items to sell, prepares the menu options, and opens the selling menu.
+    CraftLock = true
----
+    data.stashName = data.stashTable or data.stashName
----@param data table A table containing selling menu data.
+
---- - **sellTable** (`table`): The selling options and settings.
+    local bartime = (data.craftable.progressBar and data.craftable.progressBar.time) or 5000
----   - **Items** (`table`): A list of items that can be sold with their prices.
+    local bartext = (data.craftable.progressBar and data.craftable.progressBar.label)
----   - **Header** (`string`, optional): The header/title of the selling menu.
+                    or (Loc[Config.Lan].progressbar and Loc[Config.Lan].progressbar["progress_make"])
---- - **ped** (`number`, optional): The ped entity involved in the selling interaction.
+                    or "Making "
---- - **onBack** (`function`, optional): Function to call when returning from the menu.
+    local animDict = (data.craftable.Anims and data.craftable.Anims.animDict) or "amb@prop_human_parking_meter@male@idle_a"
----
+    local anim = (data.craftable.Anims and data.craftable.Anims.anim) or "idle_a"
----@usage
+    local craftAmount = (data.amount and data.amount ~= 1) and data.amount or 1
---- ```lua
+    local metadata = data.metadata or nil
---- sellMenu({
+    local prop = data.craftable.Anims and data.craftable.Anims.prop or nil
----     sellTable = {
+    local canReturn = true
----         Header = "Sell Items",
+
----         Items = {
+    local crafted, crafting = true, true
----             ["gold_ring"] = 100,
+    local cam = createTempCam(PlayerPedId(), data.coords)
----             ["diamond"] = 500,
+    startTempCam(cam)
----         },
+    for i = 1, craftAmount do
----     },
+        for k, v in pairs(data.craft) do
----     ped = pedEntity,
+            if not excludeKeys[k] then
----     onBack = function() print("Returning to previous menu") end,
+                if type(v) == "table" then
---- })
+                    for l, b in pairs(v) do
---- ```
+                        if isInventoryOpen() then
-function sellMenu(data)
+                            print("^1Error^7: ^2Inventory is open, you tried to break things")
-    local origData = data
+                            crafted, crafting = false, false
-    local Menu = {}
+                            return
-    if data.sellTable.Items then
+                        end
-        local itemList = {}
+                        if crafting and progressBar({
-        for k, v in pairs(data.sellTable.Items) do itemList[k] = 1 end
+                            label = "Using "..b.." "..Items[l].label,
-        local _, hasTable = hasItem(itemList)
+                            time = 1000,
-        for k, v in pairsByKeys(data.sellTable.Items) do
+                            cancel = true,
-            Menu[#Menu +1] = {
+                            dict = 'pickup_object',
-                isMenuHeader = not hasTable[k].hasItem,
+                            anim = "putdown_low",
-                icon = invImg(k),
+                            flag = 49,
-                header = Items[k].label.. (hasTable[k].hasItem and "💰 (x"..hasTable[k].count..")" or ""),
+                            icon = l,
-                txt = Loc[Config.Lan].info["sell_all"]..v.." "..Loc[Config.Lan].info["sell_each"],
+                        }) then
-                onSelect = function()
+                            TriggerEvent((isStarted(QBInv) and QBInvNew and "qb-" or "")..'inventory:client:ItemBox', Items[l], "use", b)
-                    sellAnim({ item = k, price = v, ped = data.ped, onBack = function() sellMenu(data) end })
+                        else
-                end,
+                            crafted, crafting = false, false
-            }
+                            break
-        end
+                        end
-    else
+                        Wait(200)
-        for k, v in pairsByKeys(data.sellTable) do
+                    end
-            if type(v) == "table" then
+                    if isInventoryOpen() then
-                Menu[#Menu +1] = {
+                        --print("^1Error^7: ^2Inventory is open, you tried to break things")
-                    arrow = true,
+                        crafted, crafting, CraftLock = false, false, false
-                    header = k,
+                        return
-                    txt = "Amount of items: "..countTable(v.Items),
+                    end
-                    onSelect = function()
+                    if crafted then
-                        v.onBack = function() sellMenu(origData) end
+                        local craftProp = nil
-                        v.sellTable = data.sellTable[k]
+                        if prop then
-                        sellMenu(v)
+                            craftProp = makeProp({ prop = prop.model, coords = vec4(0, 0, 0, 0), true, true })
-                    end,
+                            AttachEntityToEntity(craftProp, PlayerPedId(), GetPedBoneIndex(PlayerPedId(), prop.bone), prop.pos.x, prop.pos.y, prop.pos.z, prop.rot.x, prop.rot.y, prop.rot.z, true, true, false, true, 1, true)
-                }
+                        end
-            end
+                        if data.sound then
-        end
+                            local s = data.sound
-    end
+                            PlaySoundFromEntity(s.soundId, s.audioName, PlayerPedId(), s.audioRef, true, 0)
-    openMenu(Menu, { header = data.sellTable.Header or "Amount of items: "..countTable(data.sellTable.Items), headertxt = data.sellTable.Header and "Amount of items: "..countTable(data.sellTable.Items) or "", canClose = true, onBack = data.onBack })
+                        end
-end
+                        if isInventoryOpen() then
-
+                            --print("^1Error^7: ^2Inventory is open, you tried to break things")
---- Handles the selling animation and item transaction.
+                            crafted, crafting = false, false
----
+                            crafted, crafting, CraftLock = false, false, false
---- This function plays the selling animation, removes the item from the player's inventory, and gives the player money.
+                            return
----
+                        end
----@param data table A table containing selling data.
+                        if crafting and progressBar({
---- - **item** (`string`): The item to sell.
+                            label = bartext..((metadata and metadata.label) or Items[data.item].label),
---- - **price** (`number`): The price per item.
+                            time = bartime,
---- - **ped** (`number`, optional): The ped entity involved in the selling interaction.
+                            cancel = true,
---- - **onBack** (`function`, optional): Function to call when returning from the menu.
+                            dict = animDict,
----
+                            anim = anim,
----@usage
+                            flag = 49,
---- ```lua
+                            icon = data.item,
---- sellAnim({
+                            request = true,
----     item = "gold_ring",
+                        }) then
----     price = 100,
+                            TriggerServerEvent(getScript()..":Crafting:GetItem", data.item, data.craft, data.stashName, metadata, currentToken)
----     ped = pedEntity,
+                            currentToken = nil -- clear client cached token
----     onBack = function() sellMenu(data) end,
+                            CreateThread(function()
---- })
+                                if data.craft["hasCrafted"] ~= nil then
---- ```
+                                    debugPrint("hasCrafted Found, marking '"..data.item.."' as crafted for player")
-function sellAnim(data)
+                                    data.craftable.craftedItems[data.item] = true
-    if not hasItem(data.item, 1) then
+                                    triggerCallback(getScript()..":server:SetMetadata", "craftedItems", data.craftable.craftedItems)
-        triggerNotify(nil, Loc[Config.Lan].error["dont_have"].." "..Items[data.item].label, "error")
+                                end
-        return
+                                Wait(100)
-    end
+                                if data.craft["exp"] ~= nil then
-    for k, v in pairs(GetGamePool('CObject')) do
+                                    craftingLevel += data.craft["exp"].give
-        for _, model in pairs({`p_cs_clipboard`}) do
+                                    jsonPrint(data.craft["exp"])
-            if GetEntityModel(v) == model then
+                                    debugPrint("exp found, giving exp for '"..data.item.."'")
-                if IsEntityAttachedToEntity(data.ped, v) then
+                                    triggerCallback(getScript()..":server:SetMetadata", "craftingLevel", craftingLevel)
-                    DeleteObject(v) DetachEntity(v, 0, 0) SetEntityAsMissionEntity(v, true, true)
+                                end
-                    Wait(100) DeleteEntity(v)
+                            end)
-                end
+                            if data.craftable.Recipes[1].oneUse == true then
-            end
+                                removeItem("craftrecipe", 1, nil, data.craftable.Recipes[1].slot)
-        end
+                                local breakId = GetSoundId()
-    end
+                                PlaySoundFromEntity(breakId, "Drill_Pin_Break", PlayerPedId(), "DLC_HEIST_FLEECA_SOUNDSET", 1, 0)
-    TriggerServerEvent(getScript().."Sellitems", data)
+                                canReturn = false
-    lookEnt(data.ped)
+                            end
-    local dict = "mp_common"
+                            if data.sound then
-    playAnim(dict, "givetake2_a", 0.3, 2)
+                                StopSound(data.sound.soundId)
-    playAnim(dict, "givetake2_b", 0.3, 2, data.ped)
+                            end
-    Wait(2000)
+                            if data.requiredItemfunc then
-    StopAnimTask(PlayerPedId(), dict, "givetake2_a", 0.5)
+                                data.requiredItemfunc()
-    StopAnimTask(data.ped, dict, "givetake2_b", 0.5)
+                            end
-    if data.onBack then data.onBack() end
+                        else
-end
+                            crafting = false
-
+                            break
---- Server event handler for processing the item sale.
+                        end
----
+                        if craftProp then destroyProp(craftProp) end
---- This event removes the sold item from the player's inventory and adds money to their account.
+                    end
----
+                end
----@param data table The data containing item and price information.
+            end
-RegisterNetEvent(getScript().."Sellitems", function(data)
+        end
-    local src = source
+        Wait(500)
-    local hasItems, hasTable = hasItem(data.item, 1, src)
+    end
-    if hasItems then
+    stopTempCam()
-        TriggerEvent(getScript()..":server:toggleItem", false, data.item, hasTable[data.item].count, src)
+    CraftLock = false
-        TriggerEvent(getScript()..":server:FundPlayer", (hasTable[data.item].count * data.price), "cash", src)
+    if canReturn then craftingMenu(data) end
-    else
+    ClearPedTasks(PlayerPedId())
-        triggerNotify(nil, Loc[Config.Lan].error["dont_have"].." "..Items[data.item].label, "error", src)
+end
-    end
+
-end)
+-------------------------------------------------------------
-
+-- Server Event Handler: Crafted Item
---- Opens a shop interface for the player.
+-------------------------------------------------------------
----
+
---- This function checks job requirements and opens the shop using the appropriate inventory system.
+--- Server event handler for giving the crafted item to the player.
----
+---
----@param data table A table containing shop data.
+--- Removes required ingredients from the player's inventory or stash,
---- - **shop** (`string`): The shop identifier.
+--- then adds the crafted item to their inventory.
---- - **items** (`table`): The items available in the shop.
+---
---- - **coords** (`vector3`): The coordinates where the shop interaction is happening.
+--- @param ItemMake string The item being crafted.
---- - **job** (`string` or `table`, optional): Job(s) required to access the shop.
+--- @param craftable table The crafting recipe and details.
---- - **gang** (`string` or `table`, optional): Gang(s) required to access the shop.
+--- @param stashName string|table The stash name(s) to remove ingredients from.
----
+--- @param metadata table (optional) Metadata for the crafted item.
----@usage
+--- @usage
---- ```lua
+RegisterNetEvent(getScript()..":Crafting:GetItem", function(ItemMake, craftable, stashName, metadata, token)
---- openShop({
+    local src = source
----     shop = "weapon_shop",
+    debugPrint(GetInvokingResource())
----     items = weaponShopItems,
+	if GetInvokingResource() and GetInvokingResource() ~= getScript() and GetInvokingResource() ~= "qb-core" then
----     coords = vector3(100.0, 200.0, 300.0),
+        debugPrint("^1Error^7: ^1Possible exploit^7, ^1vital function was called from an external resource^7")
----     job = "police",
+        return
---- })
+    end
---- ```
+
-function openShop(data)
+    if not checkToken(src, token, "item", ItemMake) then
-    if (data.job or data.gang) and not jobCheck(data.job or data.gang) then return end
+        return
-    if isStarted(OXInv) then
+    end
-        exports[OXInv]:openInventory('shop', { type = data.shop })
+
-    elseif isStarted(QBInv) then
+
-        if QBInvNew then
+    local hasItems, hasTable = hasItem(ItemMake, 1, src)
-            TriggerServerEvent(getScript()..':server:OpenShopNewQB', data.shop) -- i hate qb-inv
+    if stashName then
-        else
+        local itemRemove = {}
-            TriggerServerEvent(Config.General.JimShops and "jim-shops:ShopOpen" or "inventory:server:OpenInventory", "shop", data.items.label, data.items)
+        if type(stashName) == "table" then
-        end
+            for _, name in pairs(stashName) do
-    else
+                stashItems = getStash(name)
-        TriggerServerEvent(Config.General.JimShops and "jim-shops:ShopOpen" or "inventory:server:OpenInventory", "shop", data.items.label, data.items)
+                for k, v in pairs(craftable[ItemMake] or {}) do
-    end
+                    for _, b in pairs(stashItems or {}) do
-    lookEnt(data.coords)
+                        if k == b.name then
-end
+                            itemRemove[k] = v
-
+                        end
---- Server event handler for opening a new QB inventory shop.
+                    end
----
+                end
---- This event is triggered when using the new QB inventory system.
+            end
----
+        else
----@param data table The shop data to open.
+            stashItems = getStash(stashName)
-RegisterNetEvent(getScript()..':server:OpenShopNewQB', function(data)
+            for k, v in pairs(craftable[ItemMake] or {}) do
-    exports[QBInv]:OpenShop(source, data)
+                for _, b in pairs(stashItems or {}) do
-end)
+                    if k == b.name then
-
+                        itemRemove[k] = v
---- Server-side callback registration for checking if the player can carry items.
+                    end
-if isServer() then
+                end
-    createCallback(getScript()..':server:canCarry', function(source, itemTable) local result = canCarry(itemTable, source) return result end)
+            end
-end
+        end
+        stashRemoveItem(stashItems, stashName, itemRemove)
+    else
+        if craftable then
+            for k, v in pairs(craftable[ItemMake] or {}) do
+                removeItem(tostring(k), v, src)
+            end
+        end
+    end
+    addItem(ItemMake, craftable.amount or 1, metadata, src)
+    -- Optionally, add experience here:
+    -- for example:
+    -- if isStarted("core_skills") then exports["core_skills"]:AddExperience(src, 2) end
+end)

shared/drawText.lua

@@ -1,61 +1,98 @@
-local radarTable = {}
+--[[
-
+    Text Drawing Module
---- Displays text on the screen using the configured draw text system.
+    ---------------------
----
+    This module provides functions to display and hide text on screen using
---- This function handles displaying text with optional images or icons using different frameworks like 'qb', 'ox', 'gta', and 'esx'.
+    various frameworks: QB, OX, GTA, and ESX.
----
+]]
----@param image string|nil An optional image or icon to display with the text. Can be a URL, path, or a reference to an icon.
+
----@param input table A table of strings, each representing a line of text to display.
+--- Displays text on the screen using the configured draw text system.
----@param style string|nil An optional style code for default GTA popups (e.g., '~g~' for green text).
+---
----@param oxStyleTable table|nil An optional table specifying style parameters for the 'ox' draw text system.
+--- Depending on Config.System.drawText, this function will use different methods to
----
+--- display text along with optional images/icons.
----@usage
+---
---- ```lua
+--- @param image string|nil Optional image/icon identifier to display with the text.
---- drawText("img_link", { "Test line 1", "Test Line 2" }, "~g~")
+--- @param input table An array of strings; each string is a line of text to display.
---- ```
+--- @param style string|nil Optional style code for default GTA popups (e.g., "~g~" for green).
-function drawText(image, input, style, oxStyleTable) local text = ""
+--- @param oxStyleTable table|nil Optional table specifying style parameters for the OX text UI.
-	if Config.System.drawText == "qb" then
+---
-		for i = 1, #input do
+---@usage
-			text = text..input[i].."</span>"..(input[i+1] ~= nil and "<br>" or "") end
+--- ```lua
-		local text = text:gsub("%:", ":<span style='color:yellow'>")
+--- drawText("img_link", { "Test line 1", "Test Line 2" }, "~g~")
-		if image then
+--- ```
-			text = '<img src="'..(radarTable[image] or nil)..'" style="width:12px;height:12px">'..text
+function drawText(image, input, style, oxStyleTable)
-		end
+    local text = ""
-		exports[QBExport]:DrawText(text, 'left')
+    if not radarTable then radarTable = {} end
-
+    if Config.System.drawText == "qb" then
-	elseif Config.System.drawText == "ox" then
+        -- Concatenate lines for QB system with HTML line breaks.
-		for k, v in pairs(input) do
+        for i = 1, #input do
-			input[k] = v.."   \n"
+            text = text..input[i].."</span>"..(input[i + 1] and "<br>" or "")
-		end
+        end
-		lib.showTextUI(table.concat(input), { icon = (image and radarTable[image] or image) or nil, position = 'left-center', style = oxStyleTable})
+        text = text:gsub("%:", ":<span style='color:yellow'>")
-
+        if image then
-	elseif Config.System.drawText == "gta" then
+            text = '<img src="'..(radarTable[image] or "")..'" style="width:12px;height:12px">'..text
-		for i = 1, #input do if input[i] ~= "" then text = text..input[i].."\n~s~" end end
+        end
-		if image then text = "~BLIP_"..image.."~ "..text end
+        exports[QBExport]:DrawText(text, 'left')
-
+
-		DisplayHelpMsg(text:gsub("%:", ":~"..(style or "g").."~"))
+    elseif Config.System.drawText == "ox" then
-    elseif Config.System.drawText == "esx" then
+        -- Append newline spacing to each input line.
-        for i = 1, #input do
+        for k, v in pairs(input) do
-			text = text..input[i].."</span>"..(input[i+1] ~= nil and "<br>" or "") end
+            input[k] = v.."   \n"
-		local text = text:gsub("%:", ":<span style='color:yellow'>")
+        end
-		if image then
+        lib.showTextUI(table.concat(input), { icon = (image and radarTable[image] or image) or nil, position = 'left-center', style = oxStyleTable })
-			text = '<img src="'..radarTable[image]..'" style="width:12px;height:12px">'..text
+
-		end
+    elseif Config.System.drawText == "gta" then
-		ESX.TextUI(text, nil)
+        -- Concatenate input lines and apply GTA style formatting.
-	end
+        for i = 1, #input do
-end
+            if input[i] ~= "" then
-
+                text = text..input[i].."\n~s~"
---- Hides any text currently being displayed on the screen.
+            end
----
+        end
---- This function clears the text displayed by the `drawText` function, using the appropriate method based on the configured draw text system.
+        if image then
-function hideText()
+            text = "~BLIP_"..image.."~ "..text
-    if Config.System.drawText == "qb" then
+        end
-        exports[QBExport]:HideText()
+        DisplayHelpMsg(text:gsub("%:", ":~"..(style or "g").."~"))
-    elseif Config.System.drawText == "ox" then
+
-        lib.hideTextUI()
+    elseif Config.System.drawText == "esx" then
-    elseif Config.System.drawText == "gta" then
+        -- ESX-based text UI uses similar HTML formatting as QB.
-        ClearAllHelpMessages()
+        for i = 1, #input do
-    elseif Config.System.drawText == "esx" then
+            text = text..input[i].."</span>"..(input[i + 1] and "<br>" or "")
-        ESX.HideUI()
+        end
-    end
+        text = text:gsub("%:", ":<span style='color:yellow'>")
+        if image then
+            text = '<img src="'..(radarTable[image] or "")..'" style="width:12px;height:12px">'..text
+        end
+        ESX.TextUI(text, nil)
+
+    elseif Config.System.drawText == "red" then
+        -- Concatenate input lines and apply GTA style formatting.
+        for i = 1, #input do
+            if input[i] ~= "" then
+                text = text..input[i].."\n~q~"
+            end
+        end
+        TriggerEvent("jim-redui:DrawText", text)
+
+    end
+end
+
+--- Hides any text currently displayed on the screen.
+---
+--- Clears the text using the appropriate method for the configured draw text system.
+---
+---	@usage
+--- ```lua
+--- hideText()
+--- ```
+function hideText()
+    if Config.System.drawText == "qb" then
+        exports[QBExport]:HideText()
+    elseif Config.System.drawText == "ox" then
+        lib.hideTextUI()
+    elseif Config.System.drawText == "gta" then
+        ClearAllHelpMessages()
+    elseif Config.System.drawText == "esx" then
+        ESX.HideUI()
+    elseif Config.System.drawText == "red" then
+        TriggerEvent("jim-redui:HideText")
+    end
 end

shared/duifunctions.lua

@@ -1,122 +1,161 @@
--- DUI STUFF -- * Experimental * --
+if gameName ~= "rdr3" then
-
+    --[[
-scriptTxd = not isServer() and CreateRuntimeTxd(getScript()..'scriptTxd') or nil
+            DUI Module (Experimental)
-customDUIList = {}
+            --------------------------
-
+            This module handles the creation, modification, and removal of custom DUI (Display UI)
--- DUI CLIENT
+            elements using runtime textures. It supports both client and server functionality to update DUI
-function createDui(name, http, size, txd)
+            images dynamically.
-	--print(name, http, size, txd)
+        ]]
-	if not customDUIList[name] then
+
-		local newTxt = CreateDui(http, math.floor(size.x), math.floor(size.y))
+        -- Create a runtime texture dictionary on the client if not running on the server.
-		while not GetDuiHandle(newTxt) do Wait(0) end
+        scriptTxd = not isServer() and CreateRuntimeTxd(getScript()..'scriptTxd') or nil
-		CreateRuntimeTextureFromDuiHandle(txd, name, GetDuiHandle(newTxt))
+        customDUIList = {}
-		customDUIList[name] = newTxt
+
-		SetDuiUrl(customDUIList[name], http)
+        -------------------------------------------------------------
-	else
+        -- DUI Client Functions
-		SetDuiUrl(customDUIList[name], http)
+        -------------------------------------------------------------
-	end
+
-end
+        --- Creates or updates a DUI element.
-
+        ---
-function DuiSelect(data)
+        --- @param name string The unique name for the DUI element.
-    local image = ""
+        --- @param http string The URL to load into the DUI.
-	for k, v in pairs(duiList[data.name]) do
+        --- @param size table A table with .x and .y fields specifying the DUI dimensions.
-		if v.tex.texn == data.texn then
+        --- @param txd table The runtime texture dictionary where the DUI texture will be created.
-			if duiList[data.name][k] then
+        --- @usage
-				image = "<center>- Current Image -<br>"..
+        --- ```lua
-						"<img src="..duiList[data.name][k].url.." width=150px><br>"..
+        --- createDui("logo", "https://example.com/logo.png", { x = 512, y = 256 }, scriptTxd)
-						"Size: ["..math.floor(data.size.x)..", "..math.floor(data.size.y).."]<br><br>"
+        --- ```
-			end
+        function createDui(name, http, size, txd)
-		end
+            if not customDUIList[name] then
-	end
+                local newDui = CreateDui(http, math.floor(size.x), math.floor(size.y))
-    local dialog = exports['qb-input']:ShowInput({
+                while not GetDuiHandle(newDui) do Wait(0) end
-        header = image..Loc[Config.Lan].menu["dui_new"],
+                CreateRuntimeTextureFromDuiHandle(txd, name, GetDuiHandle(newDui))
-        submitText = Loc[Config.Lan].menu["dui_change"],
+                customDUIList[name] = newDui
-        inputs = { { type = 'text', isRequired = true, name = 'url', text = Loc[Config.Lan].menu["dui_url"] } } })
+                SetDuiUrl(customDUIList[name], http)
-    if dialog then
+            else
-        if not dialog.url then return end
+                SetDuiUrl(customDUIList[name], http)
-        data.url = dialog.url
+            end
-        --Scan the link to see if it has an image extention otherwise, stop here.
+        end
-        local searchList = { "png", "jpg", "jpeg", "gif", "webp", "bmp" }
+
-        --Scan the link for certain terms that will flag it and refuse to show it
+        --- Opens a DUI selection input allowing the user to change the DUI image URL.
-        local banList = { "porn" } -- I dunno, let me know what links people manage to find
+        ---
-        local searchFound = false
+        --- @param data table A table containing DUI data:
-        for k, v in pairs(searchList) do
+        ---   - name: The key name in the DUI list.
-			if string.find(tostring(data.url), tostring(v))then
+        ---   - texn: The texture name.
-				searchFound = true
+        ---   - texd: The texture dictionary.
-			end
+        ---   - size: A table with .x and .y dimensions.
-		end
+        ---
-        for k, v in pairs(banList) do
+        --- @usage
-			if string.find(tostring(data.url), tostring(v)) then
+        --- ```lua
-				searchFound = false print("BANNED WORD: "..v)
+        --- DuiSelect({ name = "logo", texn = "logoTex", texd = "someTxd", size = { x = 512, y = 256 } })
-			end
+        --- ```
-		end
+        function DuiSelect(data)
-        if searchFound then
+            local imagePreview = "![test]("..data.url..")"
-			TriggerServerEvent(getScript()..":Server:ChangeDUI", data)
+            --local imagePreview = "<center>- Current Image -<br>" ..
-		end
+            --                "<img src="..data.url.." width=150px><br>" ..
-    end
+            --                "Size: ["..math.floor(data.size.x)..", "..math.floor(data.size.y).."]<br><br>"
-end
+
-
+            local dialog = createInput(imagePreview, {
-RegisterNetEvent(getScript()..":Client:ChangeDUI", function(data)
+                { type = "text", text = "dui_url", name = "url", isRequired = true },
-    debugPrint("^6Bridge^7: ^2Recieving new DUI ^7- ^6"..data.url.."^7")
+            })
-    if tostring(data.url) ~= "-" then
+
-		createDui(data.texn, tostring(data.url), data.size, scriptTxd)
+            if dialog then
-        AddReplaceTexture(tostring(data.texd), tostring(data.texn), getScript()..'scriptTxd', tostring(data.texn))
+                data.url = dialog.url or dialog[1]
-    end
+                -- Scan URL for valid image extension and banned words.
-end)
+                local searchList = { "png", "jpg", "jpeg", "gif", "webp", "bmp" }
-
+                local banList = { "porn" }
-RegisterNetEvent(getScript()..":Client:ClearDUI", function(data)
+                local searchFound = false
-    if customDUIList[tostring(data.texn)] then
+                for _, ext in pairs(searchList) do
-        RemoveReplaceTexture(tostring(data.texd), tostring(data.texn))
+                    if string.find(tostring(data.url), ext) then
-        if IsDuiAvailable(customDUIList[tostring(data.texn)]) then
+                        searchFound = true
-			SetDuiUrl(customDUIList[data.name], nil)
+                        break
-		end
+                    end
-    end
+                end
-end)
+                for _, banned in pairs(banList) do
-
+                    if string.find(tostring(data.url), banned) then
--- DUI SERVER
+                        searchFound = false
-RegisterNetEvent(getScript()..":Server:ChangeDUI", function(data)
+                        print("BANNED WORD: "..banned)
-    -- if no url given, "reset" it back to preset
+                        break
-    if not data.url then
+                    end
-		for k, v in pairs(duiList[data.name]) do
+                end
-			if v.tex.texn == data.texn then
+                if searchFound then
-				debugPrint("^6Bridge^7: ^2Preset^7: ^6"..tostring(duiList[data.name][k].preset).."^7")
+                    TriggerServerEvent(getScript()..":Server:ChangeDUI", data)
-				data.url = duiList[data.name][k].preset
+                end
-			end
+            end
-		end
+        end
-    end
+
-    -- if it has a url, update server DUI list and send to players
+        --- Client event handler to update DUI elements.
-	for k, v in pairs(duiList[data.name]) do
+        RegisterNetEvent(getScript()..":Client:ChangeDUI", function(data)
-		if v.tex.texn == data.texn then
+            debugPrint("^6Bridge^7: ^2Receiving new DUI ^7- ^6"..data.url.."^7")
-			duiList[data.name][k].url = data.url
+            if tostring(data.url) ~= "-" then
-		end
+                createDui(data.texn, tostring(data.url), data.size, scriptTxd)
-	end
+                AddReplaceTexture(tostring(data.texd), tostring(data.texn), getScript().."scriptTxd", tostring(data.texn))
-	debugPrint("^6Bridge^7: ^3DUI^2 Sending new DUI to all players^7 - ^6"..data.url.."^7")
+            end
-	TriggerClientEvent(getScript()..":Client:ChangeDUI", -1, data)
+        end)
-end)
+
-
+        --- Client event handler to clear DUI elements.
-RegisterNetEvent(getScript()..":Server:ClearDUI", function(data)
+        RegisterNetEvent(getScript()..":Client:ClearDUI", function(data)
-    if data.url == "-" then
+            if customDUIList[tostring(data.texn)] then
-		for k, v in pairs(duiList[data.name]) do
+                RemoveReplaceTexture(tostring(data.texd), tostring(data.texn))
-			if v.tex.texn == data.texn then
+                if IsDuiAvailable(customDUIList[tostring(data.texn)]) then
-				duiList[data.name][k].url = "-"
+                    SetDuiUrl(customDUIList[data.name], nil)
-			end
+                end
-		end
+            end
-	end
+        end)
-    -- Clear the DUI from loading
+
-    TriggerClientEvent(getScript()..":Client:ClearDUI", -1, data)
+        -------------------------------------------------------------
-    --duiList[tostring(data.tex)].url = ""
+        -- DUI Server Functions
-end)
+        -------------------------------------------------------------
-
+
-AddEventHandler('onResourceStop', function(r) if r ~= getScript() then return end
+        --- Server event handler to change DUI settings.
-    for k, v in pairs(duiList or {}) do
+        --- If no URL is provided, resets to the preset value.
-		for i = 1, #v do
+        RegisterNetEvent(getScript()..":Server:ChangeDUI", function(data)
-			RemoveReplaceTexture(tostring(v[i].tex.texd), tostring(v[i].tex.texn))
+            if not data.url then
-		end
+                debugPrint("^6Bridge^7: ^2Preset: ^6"..tostring(data.preset).."^7")
-    end
+                data.url = data.preset
-end)
+            else
-
+                for k, v in pairs(Locations[data.name].duiList) do
-if isServer() then
+                    if v.tex.texn == data.texn then
-    createCallback(getScript()..":Server:duiList", function(source)
+                        Locations[data.name].duiList[k].url = data.url
-            return duiList
+                    end
-    end)
+                end
-end
+            end
+            debugPrint("^6Bridge^7: ^3DUI^2 Sending new DUI to all players^7 - ^6"..data.url.."^7")
+            TriggerClientEvent(getScript()..":Client:ChangeDUI", -1, data)
+        end)
+
+        --- Server event handler to clear DUI settings.
+        RegisterNetEvent(getScript()..":Server:ClearDUI", function(data)
+            if data.url == "-" then
+                for k, v in pairs(Locations[data.name].duiList) do
+                    if v.tex.texn == data.texn then
+                        Locations[data.name].duiList[k].url = "-"
+                    end
+                end
+            end
+            TriggerClientEvent(getScript()..":Client:ClearDUI", -1, data)
+        end)
+
+        -------------------------------------------------------------
+        -- Resource Cleanup
+        -------------------------------------------------------------
+
+        onResourceStop(function()
+            for k, v in pairs(duiList or {}) do
+                for i = 1, #v do
+                    RemoveReplaceTexture(tostring(v[i].tex.texd), tostring(v[i].tex.texn))
+                end
+            end
+        end, true)
+
+        -------------------------------------------------------------
+        -- DUI List Callback (Server)
+        -------------------------------------------------------------
+
+        if isServer() then
+            createCallback(getScript()..":Server:duiList", function(source)
+                return duiList
+            end)
+        end
+
+    end

shared/effects.lua

@@ -1,190 +1,190 @@
---Screen Effects
+--Screen Effects
-local alienEffect = false
+local alienEffect = false
-function AlienEffect()
+function AlienEffect()
-    if alienEffect then return else alienEffect = true end
+    if alienEffect then return else alienEffect = true end
-    debugPrint("^5Debug^7: ^3AlienEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3AlienEffect^7() ^2activated")
-    AnimpostfxPlay("DrugsMichaelAliensFightIn", 3.0, 0)
+    AnimpostfxPlay("DrugsMichaelAliensFightIn", 3.0, 0)
-    Wait(math.random(5000, 8000))
+    Wait(math.random(5000, 8000))
-    local Ped = PlayerPedId()
+    local Ped = PlayerPedId()
-    local animDict = "MOVE_M@DRUNK@VERYDRUNK"
+    local animDict = "MOVE_M@DRUNK@VERYDRUNK"
-    loadAnimDict(animDict)
+    loadAnimDict(animDict)
-    SetPedCanRagdoll(Ped, true)
+    SetPedCanRagdoll(Ped, true)
-    ShakeGameplayCam('DRUNK_SHAKE', 2.80)
+    ShakeGameplayCam('DRUNK_SHAKE', 2.80)
-    SetTimecycleModifier("Drunk")
+    SetTimecycleModifier("Drunk")
-    SetPedMovementClipset(Ped, animDict, 1)
+    SetPedMovementClipset(Ped, animDict, 1)
-    SetPedMotionBlur(Ped, true)
+    SetPedMotionBlur(Ped, true)
-    SetPedIsDrunk(Ped, true)
+    SetPedIsDrunk(Ped, true)
-    Wait(1500)
+    Wait(1500)
-    SetPedToRagdoll(Ped, 5000, 1000, 1, 0, 0, 0)
+    SetPedToRagdoll(Ped, 5000, 1000, 1, 0, 0, 0)
-    Wait(13500)
+    Wait(13500)
-    SetPedToRagdoll(Ped, 5000, 1000, 1, 0, 0, 0)
+    SetPedToRagdoll(Ped, 5000, 1000, 1, 0, 0, 0)
-    Wait(120500)
+    Wait(120500)
-    ClearTimecycleModifier()
+    ClearTimecycleModifier()
-    ResetScenarioTypesEnabled()
+    ResetScenarioTypesEnabled()
-    ResetPedMovementClipset(Ped, 0)
+    ResetPedMovementClipset(Ped, 0)
-    SetPedIsDrunk(Ped, false)
+    SetPedIsDrunk(Ped, false)
-    SetPedMotionBlur(Ped, false)
+    SetPedMotionBlur(Ped, false)
-    AnimpostfxStopAll()
+    AnimpostfxStopAll()
-    ShakeGameplayCam('DRUNK_SHAKE', 0.0)
+    ShakeGameplayCam('DRUNK_SHAKE', 0.0)
-    AnimpostfxPlay("DrugsMichaelAliensFight", 3.0, 0)
+    AnimpostfxPlay("DrugsMichaelAliensFight", 3.0, 0)
-    Wait(math.random(45000, 60000))
+    Wait(math.random(45000, 60000))
-    AnimpostfxPlay("DrugsMichaelAliensFightOut", 3.0, 0)
+    AnimpostfxPlay("DrugsMichaelAliensFightOut", 3.0, 0)
-    AnimpostfxStop("DrugsMichaelAliensFightIn")
+    AnimpostfxStop("DrugsMichaelAliensFightIn")
-    AnimpostfxStop("DrugsMichaelAliensFight")
+    AnimpostfxStop("DrugsMichaelAliensFight")
-    AnimpostfxStop("DrugsMichaelAliensFightOut")
+    AnimpostfxStop("DrugsMichaelAliensFightOut")
-    alienEffect = false
+    alienEffect = false
-    debugPrint("^5Debug^7: ^3AlienEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3AlienEffect^7() ^2stopped")
-end
+end
-local weedEffect = false
+local weedEffect = false
-function WeedEffect()
+function WeedEffect()
-    if weedEffect then return else weedEffect = true end
+    if weedEffect then return else weedEffect = true end
-    debugPrint("^5Debug^7: ^3WeedEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3WeedEffect^7() ^2activated")
-    AnimpostfxPlay("DrugsMichaelAliensFightIn", 3.0, 0)
+    AnimpostfxPlay("DrugsMichaelAliensFightIn", 3.0, 0)
-    Wait(math.random(3000, 20000))
+    Wait(math.random(3000, 20000))
-    AnimpostfxPlay("DrugsMichaelAliensFight", 3.0, 0)
+    AnimpostfxPlay("DrugsMichaelAliensFight", 3.0, 0)
-    Wait(math.random(15000, 20000))
+    Wait(math.random(15000, 20000))
-    AnimpostfxPlay("DrugsMichaelAliensFightOut", 3.0, 0)
+    AnimpostfxPlay("DrugsMichaelAliensFightOut", 3.0, 0)
-    AnimpostfxStop("DrugsMichaelAliensFightIn")
+    AnimpostfxStop("DrugsMichaelAliensFightIn")
-    AnimpostfxStop("DrugsMichaelAliensFight")
+    AnimpostfxStop("DrugsMichaelAliensFight")
-    AnimpostfxStop("DrugsMichaelAliensFightOut")
+    AnimpostfxStop("DrugsMichaelAliensFightOut")
-    weedEffect = false
+    weedEffect = false
-    debugPrint("^5Debug^7: ^3WeedEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3WeedEffect^7() ^2stopped")
-end
+end
-local trevorEffect = false
+local trevorEffect = false
-function TrevorEffect()
+function TrevorEffect()
-    if trevorEffect then return else trevorEffect = true end
+    if trevorEffect then return else trevorEffect = true end
-    debugPrint("^5Debug^7: ^3TrevorEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3TrevorEffect^7() ^2activated")
-    AnimpostfxPlay("DrugsTrevorClownsFightIn", 3.0, 0)
+    AnimpostfxPlay("DrugsTrevorClownsFightIn", 3.0, 0)
-    Wait(3000)
+    Wait(3000)
-    AnimpostfxPlay("DrugsTrevorClownsFight", 3.0, 0)
+    AnimpostfxPlay("DrugsTrevorClownsFight", 3.0, 0)
-    Wait(30000)
+    Wait(30000)
-	AnimpostfxPlay("DrugsTrevorClownsFightOut", 3.0, 0)
+	AnimpostfxPlay("DrugsTrevorClownsFightOut", 3.0, 0)
-	AnimpostfxStop("DrugsTrevorClownsFight")
+	AnimpostfxStop("DrugsTrevorClownsFight")
-	AnimpostfxStop("DrugsTrevorClownsFightIn")
+	AnimpostfxStop("DrugsTrevorClownsFightIn")
-	AnimpostfxStop("DrugsTrevorClownsFightOut")
+	AnimpostfxStop("DrugsTrevorClownsFightOut")
-    trevorEffect = false
+    trevorEffect = false
-    debugPrint("^5Debug^7: ^3TrevorEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3TrevorEffect^7() ^2stopped")
-end
+end
-local turboEffect = false
+local turboEffect = false
-function TurboEffect()
+function TurboEffect()
-    if turboEffect then return else turboEffect = true end
+    if turboEffect then return else turboEffect = true end
-    debugPrint("^5Debug^7: ^3TurboEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3TurboEffect^7() ^2activated")
-    AnimpostfxPlay('RaceTurbo', 0, true)
+    AnimpostfxPlay('RaceTurbo', 0, true)
-    SetTimecycleModifier('rply_motionblur')
+    SetTimecycleModifier('rply_motionblur')
-    ShakeGameplayCam('SKY_DIVING_SHAKE', 0.25)
+    ShakeGameplayCam('SKY_DIVING_SHAKE', 0.25)
-    Wait(30000)
+    Wait(30000)
-    StopGameplayCamShaking(true)
+    StopGameplayCamShaking(true)
-    SetTransitionTimecycleModifier('default', 0.35)
+    SetTransitionTimecycleModifier('default', 0.35)
-    Wait(1000)
+    Wait(1000)
-    ClearTimecycleModifier()
+    ClearTimecycleModifier()
-    AnimpostfxStop('RaceTurbo')
+    AnimpostfxStop('RaceTurbo')
-    turboEffect = false
+    turboEffect = false
-    debugPrint("^5Debug^7: ^3TurboEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3TurboEffect^7() ^2stopped")
-end
+end
-local rampageEffect = false
+local rampageEffect = false
-function RampageEffect()
+function RampageEffect()
-    if rampageEffect then return else rampageEffect = true end
+    if rampageEffect then return else rampageEffect = true end
-    debugPrint("^5Debug^7: ^3RampageEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3RampageEffect^7() ^2activated")
-    AnimpostfxPlay('Rampage', 0, true)
+    AnimpostfxPlay('Rampage', 0, true)
-    SetTimecycleModifier('rply_motionblur')
+    SetTimecycleModifier('rply_motionblur')
-    ShakeGameplayCam('SKY_DIVING_SHAKE', 0.25)
+    ShakeGameplayCam('SKY_DIVING_SHAKE', 0.25)
-    Wait(30000)
+    Wait(30000)
-    StopGameplayCamShaking(true)
+    StopGameplayCamShaking(true)
-    SetTransitionTimecycleModifier('default', 0.35)
+    SetTransitionTimecycleModifier('default', 0.35)
-    Wait(1000)
+    Wait(1000)
-    ClearTimecycleModifier()
+    ClearTimecycleModifier()
-    AnimpostfxStop('Rampage')
+    AnimpostfxStop('Rampage')
-    rampageEffect = false
+    rampageEffect = false
-    debugPrint("^5Debug^7: ^3RampageEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3RampageEffect^7() ^2stopped")
-end
+end
-local focusEffect = false
+local focusEffect = false
-function FocusEffect()
+function FocusEffect()
-    if focusEffect then return else focusEffect = true end
+    if focusEffect then return else focusEffect = true end
-    debugPrint("^5Debug^7: ^3FocusEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3FocusEffect^7() ^2activated")
-    Wait(1000)
+    Wait(1000)
-    AnimpostfxPlay('FocusIn', 0, true)
+    AnimpostfxPlay('FocusIn', 0, true)
-    Wait(30000)
+    Wait(30000)
-    AnimpostfxStop('FocusIn')
+    AnimpostfxStop('FocusIn')
-    focusEffect = false
+    focusEffect = false
-    debugPrint("^5Debug^7: ^3FocusEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3FocusEffect^7() ^2stopped")
-end
+end
-local nightVisionEffect = false
+local nightVisionEffect = false
-function NightVisionEffect()
+function NightVisionEffect()
-    if nightVisionEffect then return else nightVisionEffect = true end
+    if nightVisionEffect then return else nightVisionEffect = true end
-    debugPrint("^5Debug^7: ^3NightVisionEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3NightVisionEffect^7() ^2activated")
-    SetNightvision(true)
+    SetNightvision(true)
-    Wait(math.random(3000, 4000))  -- FEEL FREE TO CHANGE THIS
+    Wait(math.random(3000, 4000))  -- FEEL FREE TO CHANGE THIS
-    SetNightvision(false)
+    SetNightvision(false)
-    SetSeethrough(false)
+    SetSeethrough(false)
-    nightVisionEffect = false
+    nightVisionEffect = false
-    debugPrint("^5Debug^7: ^3NightVisionEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3NightVisionEffect^7() ^2stopped")
-end
+end
-local thermalEffect = false
+local thermalEffect = false
-function ThermalEffect()
+function ThermalEffect()
-    if thermalEffect then return else thermalEffect = true end
+    if thermalEffect then return else thermalEffect = true end
-    debugPrint("^5Debug^7: ^3ThermalEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3ThermalEffect^7() ^2activated")
-    SetNightvision(true)
+    SetNightvision(true)
-    SetSeethrough(true)
+    SetSeethrough(true)
-    Wait(math.random(2000, 3000))  -- FEEL FREE TO CHANGE THIS
+    Wait(math.random(2000, 3000))  -- FEEL FREE TO CHANGE THIS
-    SetNightvision(false)
+    SetNightvision(false)
-    SetSeethrough(false)
+    SetSeethrough(false)
-    thermalEffect = false
+    thermalEffect = false
-    debugPrint("^5Debug^7: ^3ThermalEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3ThermalEffect^7() ^2stopped")
-end
+end
-
+
---Built-in Buff effects
+--Built-in Buff effects
-local healEffect = false
+local healEffect = false
-function HealEffect(data)
+function HealEffect(data)
-    if healEffect then return end
+    if healEffect then return end
-    debugPrint("^5Debug^7: ^3HealEffect^7() ^2activated")
+    debugPrint("^5Debug^7: ^3HealEffect^7() ^2activated")
-    healEffect = true
+    healEffect = true
-    local count = (data[1] / 1000)
+    local count = (data[1] / 1000)
-    while count > 0 do
+    while count > 0 do
-        Wait(1000)
+        Wait(1000)
-        count -= 1
+        count -= 1
-        SetEntityHealth(PlayerPedId(), GetEntityHealth(PlayerPedId()) + data[2])
+        SetEntityHealth(PlayerPedId(), GetEntityHealth(PlayerPedId()) + data[2])
-    end
+    end
-    healEffect = false
+    healEffect = false
-    debugPrint("^5Debug^7: ^3HealEffect^7() ^2stopped")
+    debugPrint("^5Debug^7: ^3HealEffect^7() ^2stopped")
-end
+end
-
+
-local staminaEffect = false
+local staminaEffect = false
-function StaminaEffect(data)
+function StaminaEffect(data)
-    if staminaEffect then return end
+    if staminaEffect then return end
-    debugPrint("^5Bridge^7: ^3StaminaEffect^7() ^2activated")
+    debugPrint("^5Bridge^7: ^3StaminaEffect^7() ^2activated")
-    staminaEffect = true
+    staminaEffect = true
-    local startStamina = (data[1] / 1000)
+    local startStamina = (data[1] / 1000)
-    SetRunSprintMultiplierForPlayer(PlayerId(), 1.49)
+    SetRunSprintMultiplierForPlayer(PlayerId(), 1.49)
-    while startStamina > 0 do
+    while startStamina > 0 do
-        Wait(1000)
+        Wait(1000)
-        if math.random(5, 100) < 10 then RestorePlayerStamina(PlayerId(), data[2]) end
+        if math.random(5, 100) < 10 then RestorePlayerStamina(PlayerId(), data[2]) end
-        startStamina -= 1
+        startStamina -= 1
-        if math.random(5, 100) < 51 then end
+        if math.random(5, 100) < 51 then end
-    end
+    end
-    startStamina = 0
+    startStamina = 0
-    SetRunSprintMultiplierForPlayer(PlayerId(), 1.0)
+    SetRunSprintMultiplierForPlayer(PlayerId(), 1.0)
-    staminaEffect = false
+    staminaEffect = false
-    debugPrint("^5Bridge^7: ^3StaminaEffect^7() ^2stopped")
+    debugPrint("^5Bridge^7: ^3StaminaEffect^7() ^2stopped")
-end
+end
-
+
-function StopEffects() -- Used to clear up any effects stuck on screen
+function StopEffects() -- Used to clear up any effects stuck on screen
-    debugPrint("^5Bridge^7: ^2All screen effects stopped")
+    debugPrint("^5Bridge^7: ^2All screen effects stopped")
-    ShakeGameplayCam('DRUNK_SHAKE', 0.0)
+    ShakeGameplayCam('DRUNK_SHAKE', 0.0)
-    SetPedToRagdoll(PlayerPedId(), 5000, 1000, 1, 0, 0, 0)
+    SetPedToRagdoll(PlayerPedId(), 5000, 1000, 1, 0, 0, 0)
-    ClearTimecycleModifier()
+    ClearTimecycleModifier()
-    ResetScenarioTypesEnabled()
+    ResetScenarioTypesEnabled()
-    ResetPedMovementClipset(PlayerPedId(), 0)
+    ResetPedMovementClipset(PlayerPedId(), 0)
-    SetPedIsDrunk(PlayerPedId(), false)
+    SetPedIsDrunk(PlayerPedId(), false)
-    SetPedMotionBlur(PlayerPedId(), false)
+    SetPedMotionBlur(PlayerPedId(), false)
-    SetNightvision(false)
+    SetNightvision(false)
-    SetSeethrough(false)
+    SetSeethrough(false)
-    AnimpostfxStop("DrugsMichaelAliensFightIn")
+    AnimpostfxStop("DrugsMichaelAliensFightIn")
-    AnimpostfxStop("DrugsMichaelAliensFight")
+    AnimpostfxStop("DrugsMichaelAliensFight")
-    AnimpostfxStop("DrugsMichaelAliensFightOut")
+    AnimpostfxStop("DrugsMichaelAliensFightOut")
-	AnimpostfxStop("DrugsTrevorClownsFight")
+	AnimpostfxStop("DrugsTrevorClownsFight")
-	AnimpostfxStop("DrugsTrevorClownsFightIn")
+	AnimpostfxStop("DrugsTrevorClownsFightIn")
-	AnimpostfxStop("DrugsTrevorClownsFightOut")
+	AnimpostfxStop("DrugsTrevorClownsFightOut")
-    AnimpostfxStop('RaceTurbo')
+    AnimpostfxStop('RaceTurbo')
-    AnimpostfxStop('FocusIn')
+    AnimpostfxStop('FocusIn')
-    AnimpostfxStop('Rampage')
+    AnimpostfxStop('Rampage')
 end

shared/input.lua

@@ -1,156 +1,241 @@
--- INPUT --
+--[[
--- Multiscript input script function to create simple input text boxes --
+    Input Dialog Module
-
+    ---------------------
---- Creates a simple input dialog compatible with multiple menu systems.
+    This module provides a function to create a simple input dialog compatible with
----
+    multiple menu systems (OX, QB, GTA/WarMenu, and ESX). It supports various input
---- This function generates input dialogs for different frameworks (OX, QB, GTA) based on the configuration.
+    types such as radio buttons, numbers, text, and select dropdowns.
---- It supports various input types such as radio buttons, numbers, text, and select dropdowns.
+
----
+]]
----@param title string The title/header of the input dialog.
+
----@param opts table A table containing input options. Each option should have a `type` and other relevant fields based on the type.
+--- Creates a simple input dialog using the configured menu system.
----   - **type** (`string`): The type of input. Supported types: "radio", "number", "text", "select".
+---
----   - **label** (`string`, optional): The label for the input (used for "radio" and "select" types in OX).
+--- @param title string The title or header of the input dialog.
----   - **text** (`string`, optional): The text prompt for the input.
+--- @param opts table A table of input option definitions. Each option should include:
----   - **name** (`string`): The identifier name for the input.
+---     - type (string): The input type ("radio", "number", "text", "select").
----   - **isRequired** (`boolean`, optional): Whether the input is required.
+---     - label (string, optional): A label for the input (used in radio/select for OX).
----   - **default** (`any`, optional): The default value for the input.
+---     - text (string, optional): The text prompt for the input.
----   - **options** (`table`, optional): A table of options for "radio" and "select" types.
+---     - name (string): The identifier for the input.
----   - **min** (`number`, optional): The minimum value (used for "select" type).
+---     - isRequired (boolean, optional): Whether input is mandatory.
----   - **max** (`number`, optional): The maximum value (used for "number" and "select" types).
+---     - default (any, optional): The default value.
----   - **txt** (`string`, optional): Additional text or description for the input.
+---     - options (table, optional): A table of choices for "radio" and "select" types.
----
+---     - min (number, optional): Minimum value (for "number" and "select").
----@return table|nil table Returns the user's input as a table if the dialog is submitted, otherwise returns `nil`.
+---     - max (number, optional): Maximum value.
----
+---     - txt (string, optional): Additional description.
----@usage
+---
---- ```lua
+--- @return table|nil table Returns the user's input as a table if submitted, otherwise nil.
---- local userInput = createInput("Enter Details", {
+---
----     { type = "text", text = "Name", name = "playerName", isRequired = true },
+---@usage
----     { type = "number", text = "Age", name = "playerAge", min = 18, max = 99 },
+--- ```lua
----     { type = "radio", label = "Gender", name = "playerGender", options = {
+--- local userInput = createInput("Enter Details", {
----         { text = "Male", value = "male" },
+---     { type = "text", text = "Name", name = "playerName", isRequired = true },
----         { text = "Female", value = "female" },
+---     { type = "number", text = "Age", name = "playerAge", min = 18, max = 99 },
----         { text = "Other", value = "other" },
+---     { type = "radio", label = "Gender", name = "playerGender", options = {
----     }},
+---         { text = "Male", value = "male" },
---- })
+---         { text = "Female", value = "female" },
---- ```
+---         { text = "Other", value = "other" },
-function createInput(title, opts)
+---     }},
-    local dialog = nil
+--- })
-    local options = {}
+--- ```
-
+function createInput(title, opts)
-    if Config.System.Menu == "ox" then
+    local dialog = nil
-        for i = 1, #opts do
+    local options = {}
-            if opts[i].type == "radio" then
+    local currentNum = 0
-                -- Convert radio options to select type for OX
+    if Config.System.Menu == "ox" then
-                for k in pairs(opts[i].options) do
+        for i = 1, #opts do
-                    opts[i].options[k].label = opts[i].options[k].text
+            currentNum += 1
-                end
+            if opts[i] == nil then currentNum -= 1 goto skip end
-                options[i] = {
+            if opts[i].type == "radio" then
-                    type = "select",
+                -- Convert radio options to select type for OX
-                    isRequired = opts[i].isRequired,
+                for k in pairs(opts[i].options) do
-                    label = opts[i].label or opts[i].text,
+                    opts[i].options[k].label = opts[i].options[k].text
-                    name = opts[i].name,
+                end
-                    default = opts[i].default or opts[i].options[1].value,
+                options[currentNum] = {
-                    options = opts[i].options,
+                    type = "select",
-                }
+                    isRequired = opts[i].isRequired,
-            end
+                    label = opts[i].label or opts[i].text,
-            if opts[i].type == "number" then
+                    name = opts[i].name,
-                options[i] = {
+                    default = opts[i].default or opts[i].options[1].value,
-                    type = "number",
+                    options = opts[i].options,
-                    label = opts[i].text..(opts[i].txt and " - "..opts[i].txt or ""),
+                }
-                    isRequired = opts[i].isRequired,
+            end
-                    name = opts[i].name,
+            if opts[i].type == "number" then
-                    options = opts[i].options,
+                options[currentNum] = {
-                }
+                    type = opts[i].type,
-            end
+                    label = (opts[i].label or opts[i].text)..(opts[i].txt and " - "..opts[i].txt or ""),
-            if opts[i].type == "text" then
+                    isRequired = opts[i].isRequired,
-                options[i] = {
+                    name = opts[i].name,
-                    type = "input",
+                    options = opts[i].options,
-                    label = opts[i].text..(opts[i].txt and " - "..opts[i].txt or ""),
+                }
-                    default = opts[i].default,
+            end
-                    isRequired = opts[i].isRequired,
+            if opts[i].type == "text" then
-                }
+                options[currentNum] = {
-            end
+                    type = "input",
-            if opts[i].type == "select" then
+                    label = opts[i].text..(opts[i].txt and " - "..opts[i].txt or ""),
-                options[i] = {
+                    default = opts[i].default,
-                    type = "select",
+                    isRequired = opts[i].isRequired,
-                    label = opts[i].text..(opts[i].txt and " - "..opts[i].txt or ""),
+                }
-                    isRequired = opts[i].isRequired,
+            end
-                    name = opts[i].name,
+            if opts[i].type == "select" then
-                    options = opts[i].options,
+                options[currentNum] = {
-                    min = opts[i].min,
+                    type = opts[i].type,
-                    max = opts[i].max,
+                    label = opts[i].text..(opts[i].txt and " - "..opts[i].txt or ""),
-                    default = opts[i].default,
+                    isRequired = opts[i].isRequired,
-                }
+                    name = opts[i].name,
-            end
+                    options = opts[i].options,
-        end
+                    min = opts[i].min,
-        dialog = exports[OXLibExport]:inputDialog(title, options)
+                    max = opts[i].max,
-        return dialog
+                    default = opts[i].default,
-    end
+                }
-
+            end
-    if Config.System.Menu == "qb" then
+
-        dialog = exports['qb-input']:ShowInput({ header = title, submitText = "Accept", inputs = opts })
+            if opts[i].type == "checkbox" then
-        return dialog
+                jsonPrint(opts[i])
-    end
+                for k in pairs(opts[i].options) do
-
+                    if options[currentNum] then currentNum += 1 end
-    if Config.System.Menu == "gta" then
+                    options[currentNum] = {
-        WarMenu.CreateMenu(tostring(opts),
+                        type = opts[i].type,
-            title,
+                        label = opts[i].options[k].text..(opts[i].txt and " - "..opts[i].txt or ""),
-            " ",
+                        name = opts[i].options[k].value,
-            {
+                    }
-                titleColor = { 222, 255, 255 },
+
-                maxOptionCountOnScreen = 15,
+                end
-                width = 0.25,
+            end
-                x = 0.7,
+
-            })
+            if opts[i].type == "color" then
-        if WarMenu.IsAnyMenuOpened() then return end
+                options[currentNum] = {
-        WarMenu.OpenMenu(tostring(opts))
+                    type = opts[i].type,
-
+                    label = opts[i].label,
-        local close = true
+                    isRequired = opts[i].isRequired,
-        local _comboBoxItems = {}
+                    format = opts[i].format,
-        local _comboBoxIndex = { 1, 1 }
+                    default = opts[i].default,
-
+                }
-        while true do
+            end
-            if WarMenu.Begin(tostring(opts)) then
+            if opts[i].type == "slider" then
-                for i = 1, #opts do
+                options[currentNum] = {
-                    if opts[i].type == "radio" then
+                    type = opts[i].type,
-                        for k in pairs(opts[i].options) do
+                    label = opts[i].label,
-                            if not _comboBoxItems[i] then _comboBoxItems[i] = {} end
+                    isRequired = opts[i].required,
-                            _comboBoxItems[i][k] = opts[i].options[k].text
+                    min = opts[i].min,
-                        end
+                    max = opts[i].max,
-                        local _, comboBoxIndex = WarMenu.ComboBox(opts[i].label, _comboBoxItems[i], _comboBoxIndex[i])
+                    default = opts[i].default,
-                        if _comboBoxIndex[i] ~= comboBoxIndex then
+                }
-                            _comboBoxIndex[i] = comboBoxIndex
+            end
-                        end
+            ::skip::
-                    end
+        end
-                    if opts[i].type == "number" then
+        dialog = exports[OXLibExport]:inputDialog(title, options)
-                        for b = 1, opts[i].max do
+        return dialog
-                            if not _comboBoxItems[i] then _comboBoxItems[i] = {} end
+    elseif Config.System.Menu == "qb" then
-                            _comboBoxItems[i][b] = b
+        for k, v in pairs(opts) do
-                        end
+            currentNum += 1
-                        local _, comboBoxIndex = WarMenu.ComboBox(opts[i].text, _comboBoxItems[i], _comboBoxIndex[i])
+            if opts[k] == nil then
-                        if _comboBoxIndex[i] ~= comboBoxIndex then
+                currentNum -= 1
-                            _comboBoxIndex[i] = comboBoxIndex
+            else
-                        end
+                options[currentNum] = opts[k]
-                    end
+            end
-                end
+        end
-                local pressed = WarMenu.Button("Pay")
+        dialog = exports['qb-input']:ShowInput(
-                if pressed then
+            { header = title, submitText = "Accept", inputs = options }
-                    WarMenu.CloseMenu()
+        )
-                    close = false
+        return dialog
-                    local result = {}
+
-                    for i = 1, #_comboBoxIndex do
+    elseif Config.System.Menu == "gta" then
-                        result[i] = _comboBoxItems[i][_comboBoxIndex[i]]
+        WarMenu.CreateMenu(tostring(opts),
-                    end
+            title,
-                    return result
+            " ",
-                end
+            {
-                WarMenu.End()
+                titleColor = { 222, 255, 255 },
-            else
+                maxOptionCountOnScreen = 15,
-                return
+                width = 0.25,
-            end
+                x = 0.7,
-            if not WarMenu.IsAnyMenuOpened() and close then
+            })
-                if data.onExit then data.onExit() end
+        if WarMenu.IsAnyMenuOpened() then return end
-            end
+        WarMenu.OpenMenu(tostring(opts))
-            Wait(0)
+
-        end
+        local close = true
-    end
+        local _comboBoxItems = {}
+        local _comboBoxIndex = { 1, 1 }
+
+        while true do
+            if WarMenu.Begin(tostring(opts)) then
+                for i = 1, #opts do
+                    if opts[i].type == "radio" then
+                        for k in pairs(opts[i].options) do
+                            if not _comboBoxItems[i] then _comboBoxItems[i] = {} end
+                            _comboBoxItems[i][k] = opts[i].options[k].text
+                        end
+                        local _, comboBoxIndex = WarMenu.ComboBox(opts[i].label, _comboBoxItems[i], _comboBoxIndex[i])
+                        if _comboBoxIndex[i] ~= comboBoxIndex then
+                            _comboBoxIndex[i] = comboBoxIndex
+                        end
+                    end
+                    if opts[i].type == "number" then
+                        for b = 1, opts[i].max do
+                            if not _comboBoxItems[i] then _comboBoxItems[i] = {} end
+                            _comboBoxItems[i][b] = b
+                        end
+                        local _, comboBoxIndex = WarMenu.ComboBox(opts[i].text, _comboBoxItems[i], _comboBoxIndex[i])
+                        if _comboBoxIndex[i] ~= comboBoxIndex then
+                            _comboBoxIndex[i] = comboBoxIndex
+                        end
+                    end
+                end
+                local pressed = WarMenu.Button("Pay")
+                if pressed then
+                    WarMenu.CloseMenu()
+                    close = false
+                    local result = {}
+                    for i = 1, #_comboBoxIndex do
+                        result[i] = _comboBoxItems[i][_comboBoxIndex[i]]
+                    end
+                    return result
+                end
+                WarMenu.End()
+            else
+                return
+            end
+            if not WarMenu.IsAnyMenuOpened() and close then
+                if data.onExit then data.onExit() end
+            end
+            Wait(0)
+        end
+    elseif Config.System.Menu == "esx" then -- horrible input dialog, not even worth using, get OX
+
+        local results = {}
+        for i, opt in ipairs(opts) do
+            local prompt = opt.text or opt.label or "Enter value"
+            -- For radio/select types, append available options in the prompt.
+            if (opt.type == "radio" or opt.type == "select") and opt.options then
+                local choices = ""
+                for j, choice in ipairs(opt.options) do
+                    choices = choices .. choice.text .. " (" .. tostring(choice.value) .. ")"
+                    if j < #opt.options then choices = choices .. ", " end
+                end
+                prompt = prompt .. " [" .. choices .. "]"
+            elseif opt.type == "number" then
+                prompt = prompt .. " (number between " .. (opt.min or 0) .. " and " .. (opt.max or 100) .. ")"
+            end
+
+            local value = nil
+            ESX.UI.Menu.Open('dialog', getScript(), 'input_' .. i, {
+                title = prompt
+            }, function(data, menu)
+                value = data.value
+                menu.close()
+            end, function(data, menu)
+                menu.close()
+            end)
+
+            -- Wait until the player submits a value.
+            while value == nil do
+                Wait(0)
+            end
+
+            -- Convert to a number if needed.
+            if opt.type == "number" then
+                value = tonumber(value)
+            end
+            results[opt.name or i] = value
+        end
+        return results
+    end
 end

shared/inventories.lua

@@ -0,0 +1,263 @@
+-------------------------------------------------------------
+-- Item Availability & Inventory Retrieval
+-------------------------------------------------------------
+---
+--- Locks or unlocks the player's inventory.
+--- Freezes/unfreezes the player's position, sets inventory busy state, and toggles hotbar usage.
+---
+--- @param toggle boolean True to lock inventory; false to unlock.
+---
+--- @usage
+--- ```lua
+--- lockInv(true)  -- Lock inventory.
+--- lockInv(false) -- Unlock inventory.
+--- ```
+function lockInv(toggle)
+    FreezeEntityPosition(PlayerPedId(), toggle)
+    LocalPlayer.state:set("inv_busy", toggle, true)
+    LocalPlayer.state:set("invBusy", toggle, true)
+    TriggerEvent('inventory:client:busy:status', toggle)
+    TriggerEvent('canUseInventoryAndHotbar:toggle', not toggle)
+end
+--- Checks if a player has the specified items in their inventory.
+---
+--- Verifies whether the required quantities are present. Returns a boolean and a table of details.
+---
+--- @param items string|table A single item name or table with required amounts.
+--- @param amount number The required quantity (default 1).
+--- @param src number|nil Player source ID (defaults to caller).
+--- @return boolean boolean True if all items are available; otherwise, false.
+--- @return table|nil table Table detailing counts for each item.
+---
+---@usage
+--- ```lua
+--- local hasAll, details = hasItem({"health_potion", "mana_potion"}, 2, playerId)
+--- if hasAll then
+---     -- Proceed with action
+--- else
+---     -- Inform the player about missing items
+--- end
+--- ```
+function hasItem(items, amount, src)
+    local amount = amount and amount or 1
+    local grabInv, foundInv = getPlayerInv(src)
+    if type(items) ~= "table" then items = { [items] = amount and amount or 1, } end
+
+    if grabInv then
+        local hasTable = {}
+        for item, amt in pairs(items) do
+            if not Items[item] then print("^4ERROR^7: ^2Script can't find ingredient item in Shared Items - ^1"..item.."^7") end
+
+            local count = 0
+            for _, itemData in pairs(grabInv) do
+                jsonPrint(itemData)
+                if itemData and itemData.name == item then
+                    count += (itemData.amount or itemData.count or 1)
+                end
+            end
+            foundInv = foundInv:gsub("%-", "^7-^6"):gsub("%_", "^7_^6")
+            local foundMessage = "^6Bridge^7: ^3hasItem^7[^6"..foundInv.."^7]: "..tostring(item).." ^3"..count.."^7/^3"..amt
+            if count >= amt then foundMessage = foundMessage.." ^5FOUND^7" else foundMessage = foundMessage .." ^1NOT FOUND^7" end
+            debugPrint(foundMessage)
+            hasTable[item] = { hasItem = count >= amt, count = count }
+        end
+        for k, v in pairs(hasTable) do
+            if not v.hasItem then
+                return false, hasTable
+            end
+        end
+        return true, hasTable
+    end
+    -- if can't find inventory, return false
+    print("^1Error^7: ^1Can't find players inventory for some reason")
+    return false, {}
+end
+
+--- Retrieves a player's inventory based on the active inventory system.
+---
+--- @param src number|nil The player source ID (if nil, retrieves current player's inventory).
+--- @return table|nil table The inventory items.
+--- @return string|nil string The name of the inventory system.
+---
+---@usage
+--- ```lua
+--- local inventory, system = getPlayerInv(playerId)
+--- if inventory then
+---     -- Process inventory
+--- end
+--- ```
+function getPlayerInv(src)
+    local grabInv = nil
+    local foundInv = ""
+
+    if isStarted(OXInv) then
+        foundInv = OXInv
+        if src then
+            grabInv = exports[OXInv]:GetInventoryItems(src)
+        else
+            grabInv = exports[OXInv]:GetPlayerItems()
+        end
+
+    elseif isStarted(QSInv) then
+        foundInv = QSInv
+        if src then
+            grabInv = exports[QSInv]:GetInventory(src)
+        else
+            grabInv = exports[QSInv]:getUserInventory()
+        end
+
+    elseif isStarted(OrigenInv) then
+        foundInv = OrigenInv
+        if src then
+            grabInv = exports[OrigenInv]:getInventory(src)
+        else
+            grabInv = exports[OrigenInv]:getInventory()
+        end
+
+    elseif isStarted(CoreInv) then
+        foundInv = CoreInv
+        if src then
+            grabInv = exports[CoreInv]:getInventory(src)
+        else
+            grabInv = exports[CoreInv]:getInventory()
+        end
+
+    elseif isStarted(CodeMInv) then
+        foundInv = CodeMInv
+        if src then
+            grabInv = exports[CodeMInv]:GetInventory(getPlayer(src).citizenId, src)
+        else
+            grabInv = exports[CodeMInv]:getUserInventory()
+        end
+
+    elseif isStarted(TgiannInv) then
+        foundInv = TgiannInv
+        if src then
+            grabInv = exports[TgiannInv]:GetPlayerItems(src)
+        else
+            grabInv = exports[TgiannInv]:GetPlayerItems()
+        end
+
+    elseif isStarted(QBInv) then
+        foundInv = QBInv
+        if src then
+            grabInv = Core.Functions.GetPlayer(src).PlayerData.items
+        else
+            grabInv = Core.Functions.GetPlayerData().items
+        end
+
+    elseif isStarted(PSInv) then
+        foundInv = PSInv
+        if src then grabInv = Core.Functions.GetPlayer(src).PlayerData.items
+        else grabInv = Core.Functions.GetPlayerData().items end
+
+    elseif ESX and isStarted(ESXExport) then
+        foundInv = ESX
+        if src then
+            local xPlayer = ESX.GetPlayerFromId(src)
+            grabInv = xPlayer.inventory
+        else
+            local xPlayer = ESX.GetPlayerData()  -- Client side, if available
+            grabInv = xPlayer.inventory
+        end
+
+    elseif isStarted(RSGInv) then
+        foundInv = RSGInv
+        if src then
+            grabInv = Core.Functions.GetPlayer(src).PlayerData.items
+        else
+            grabInv = Core.Functions.GetPlayerData().items
+        end
+
+    else
+        print("^4ERROR^7: ^2No Inventory detected ^7- ^2Check ^3starter^1.^2lua^7")
+    end
+    return grabInv, foundInv
+end
+
+function isInventoryOpen()
+    if isStarted(OXInv) then
+        return LocalPlayer.state.invBusy
+
+    elseif isStarted(QSInv) then
+        return exports[QSInv]:inInventory()
+
+    elseif isStarted(OrigenInv) then
+        return exports[OrigenInv]:IsInventoryOpen()
+
+    elseif isStarted(CoreInv) then
+        return exports[CoreInv]:isInventoryOpen()
+
+    elseif isStarted(CodeMInv) then
+        return false
+        -- CodeM doesn't have a function to check if the inventory is open
+        -- No idea what it uses, so it just skips the check
+
+    elseif isStarted(TgiannInv) then
+        return exports[TgiannInv]:IsInventoryActive()
+
+    elseif isStarted(QBInv) then
+        return LocalPlayer.state.inv_busy
+
+    elseif isStarted(PSInv) then
+        return LocalPlayer.state.inv_busy
+
+    elseif ESX and isStarted(ESXExport) then
+        return false
+
+    elseif isStarted(RSGInv) then
+        return LocalPlayer.state.inv_busy
+
+    end
+end
+
+-------------------------------------------------------------
+-- Item Image Retrieval
+-------------------------------------------------------------
+
+--- Retrieves the NUI link for an item's image from the active inventory system.
+---
+--- @param item string The item name.
+--- @return string string A `nui://` link to the item's image, or an empty string if not found.
+---
+--- @usage
+--- ```lua
+--- local imageLink = invImg("health_potion")
+--- if imageLink ~= "" then print(imageLink) end
+--- ```
+function invImg(item)
+    local imgLink = ""
+    if item ~= "" and Items[item] then
+        if isStarted(OXInv) then
+            imgLink = "nui://"..OXInv.."/web/images/"..(Items[item].image or "")
+
+        elseif isStarted(QSInv) then
+            imgLink = "nui://"..QSInv.."/html/images/"..(Items[item].image or "")
+
+        elseif isStarted(CoreInv) then
+            imgLink = "nui://"..CoreInv.."/html/img/"..(Items[item].image or "")
+
+        elseif isStarted(CodeMInv) then
+            imgLink = "nui://"..CodeMInv.."/html/itemimages/"..(Items[item].image or "")
+
+        elseif isStarted(OrigenInv) then
+            imgLink = "nui://"..OrigenInv.."/html/img/"..(Items[item].image or "")
+
+        elseif isStarted(QBInv) then
+            imgLink = "nui://"..QBInv.."/html/images/"..(Items[item].image or "")
+
+        elseif isStarted(PSInv) then
+            imgLink = "nui://"..PSInv.."/html/images/"..(Items[item].image or "")
+
+        elseif isStarted(TgiannInv) then
+            imgLink = "nui://inventory_images/images/"..(Items[item].image or "")
+
+        elseif isStarted(RSGInv) then
+            imgLink = "nui://"..RSGInv.."/html/images/"..(Items[item].image or "")
+
+        else
+            print("^4ERROR^7: ^2No Inventory detected for invImg - Check starter.lua")
+        end
+    end
+    return imgLink
+end

shared/isAnimal.lua

@@ -1,442 +1,284 @@
-isCat, isDog, isBigDog, isSmallDog, isCoyote, isAnimal = false, false, false, false, false, false
+--[[
-
+    Animal Detection Module
-if not isServer() then
+    -------------------------
-    onPlayerLoaded(function()
+    This module determines whether a Ped is an animal and categorizes it as a cat, dog,
-        Wait(2000)
+    or other type (e.g., coyote). It uses predefined model hashes stored in the AnimalPeds table.
-        isCat, isDog, isBigDog, isSmallDog, isCoyote = false, false, false, false, false
+
-        isPedAnimal()
+    Global Flags:
-        if isAnimal then
+      - isCat, isDog, isBigDog, isSmallDog, isCoyote, isAnimal: Booleans to track the player's
-            local ped = PlayerPedId()
+        current animal classification.
-            local pedModel = GetEntityModel(ped)
+
-
+    When running client-side (not on the server), the module checks the player's Ped after they load.
-            isCat = (isCat(ped) or pedModel == `ft-raccoon`) and (pedModel ~= `ft-sphynx`)
+
-
+    Usage Examples:
-            isDog, isBigDog = isDog(ped)
+      -- Check if the player's Ped is an animal:
-            isSmallDog = not isBigDog
+      local animalStatus = isPedAnimal()
-            if isDog and pedModel == `a_c_coyote` then isDog = false end
+
-
+      -- Check if a given Ped is a cat:
-            isCoyote = (pedModel == `ft-sphynx` or pedModel == `a_c_coyote`)
+      if isCat(somePed) then print("This is a cat!") end
-
+
-            if pedModel == `ft-capmonkey2` then isDog = true end
+      -- Determine if a Ped is a dog and whether it's big or small:
-        end
+      local isDogFlag, isBig = isDog(somePed)
-    end, true)
+
-
+      -- Retrieve a flat list of all animal model hashes:
-
+      local allAnimalModels = getAnimalModels()
-    --- Determines if a given Ped is classified as an animal.
+
-    ---
+]]
-    --- This function checks whether the specified Ped (or the player's Ped if none is provided)
+
-    --- is listed within the predefined `AnimalPeds` tables. It iterates through all animal types
+-- Global animal classification flags.
-    --- to verify if the Ped's model hash matches any known animal models.
+isCat, isDog, isBigDog, isSmallDog, isCoyote, isAnimal = false, false, false, false, false, false
-    ---
+
-    ---@param ped number|nil Optional. The Ped entity to check. Defaults to the player's Ped (`PlayerPedId()`).
+if not isServer() then
-    ---
+    onPlayerLoaded(function()
-    ---@return boolean `true` if the Ped is an animal, otherwise `false`.
+        Wait(2000)
-    ---
+        -- Reset classification flags
-    --- @usage
+        isCat, isDog, isBigDog, isSmallDog, isCoyote = false, false, false, false, false
-    --- ```lua
+        -- Check if the player's Ped is an animal.
-    --- local isPlayerAnimal = isAnimal()
+        isPedAnimal()
-    --- local isSpecificPedAnimal = isAnimal(somePedEntity)
+        if isAnimal then
-    --- ```
+            local ped = PlayerPedId()
-    function isPedAnimal(ped)
+            local pedModel = GetEntityModel(ped)
-        local PedModel = GetEntityModel(ped or PlayerPedId())
+
-
+            -- Determine if the Ped is a cat:
-        for _, animalTypeTable in pairs(AnimalPeds) do
+            -- Also treat 'ft-raccoon' as a cat unless it is 'ft-sphynx'
-            for animalModelHash, _ in pairs(animalTypeTable) do
+            isCat = (isCat(ped) or pedModel == `ft-raccoon`) and (pedModel ~= `ft-sphynx`)
-                if PedModel == animalModelHash then
+
-                    isAnimal = true
+            -- Determine if the Ped is a dog and whether it's big:
-                    break
+            isDog, isBigDog = isDog(ped)
-                end
+            isSmallDog = not isBigDog
-            end
+            if isDog and pedModel == `a_c_coyote` then isDog = false end
-            if isAnimal then
+
-                debugPrint("^6Debug^7: ^2Ped is Animal^1")
+            -- Determine if the Ped is a coyote (special case):
-                break
+            isCoyote = (pedModel == `ft-sphynx` or pedModel == `a_c_coyote`)
-            end
+
-        end
+            -- Special override: if model is 'ft-capmonkey2', treat as a dog.
-
+            if pedModel == `ft-capmonkey2` then isDog = true end
-        return isAnimal
+        end
-    end
+    end, true)
-
+
-    --- Checks if a given Ped is classified specifically as a cat.
+
-    ---
+    -------------------------------------------------------------
-    --- This function verifies whether the specified Ped (or the player's Ped if none is provided)
+    -- Animal Classification Functions
-    --- matches any of the model hashes listed under `AnimalPeds.CatPeds`. It returns `true` if a match is found.
+    -------------------------------------------------------------
-    ---
+
-    ---@param ped number|nil Optional. The Ped entity to check. Defaults to the player's Ped (`PlayerPedId()`).
+    --- Determines whether a given Ped is classified as an animal.
-    ---
+    ---
-    ---@return boolean `true` if the Ped is a cat, otherwise `false`.
+    --- Checks if the Ped's model hash appears in any of the animal categories defined in AnimalPeds.
-    ---
+    ---
-    ---@usage
+    --- @param ped number|nil Optional. The Ped entity to check. Defaults to the player's Ped.
-    --- ```lua
+    --- @return boolean boolean True if the Ped is an animal, otherwise false.
-    --- if isCat() then
+    ---
-    ---     print("Player is a cat!")
+    --- @usage
-    --- end
+    --- ```lua
-    ---
+    --- local isPlayerAnimal = isAnimal()
-    --- local anotherPed = GetPedInVehicleSeat(vehicle, -1)
+    --- local isSpecificPedAnimal = isAnimal(somePedEntity)
-    --- if isCat(anotherPed) then
+    --- ```
-    ---     print("Driver is a cat!")
+    function isPedAnimal(ped)
-    --- end
+        local PedModel = GetEntityModel(ped or PlayerPedId())
-    --- ```
+        for _, animalCategory in pairs(AnimalPeds) do
-    function isCat(ped)
+            for animalModelHash, _ in pairs(animalCategory) do
-        local PedModel = GetEntityModel(ped or PlayerPedId())
+                if PedModel == animalModelHash then
-        for k, v in pairs(AnimalPeds.CatPeds) do
+                    isAnimal = true
-            if PedModel == k then
+                    debugPrint("^6Bridge^7: ^2Ped is Animal")
-                return true
+                    return true
-            end
+                end
-        end
+            end
-        return false
+        end
-    end
+        return false
-
+    end
-    --- Determines if a given Ped is classified as a dog and identifies its size category.
+
-    ---
+    --- Checks if a given Ped is classified as a cat.
-    --- This function checks whether the specified Ped (or the player's Ped if none is provided)
+    ---
-    --- matches any model hashes listed under `AnimalPeds.BigDogs` or `AnimalPeds.SmallDogs`. It returns
+    --- Iterates through the CatPeds table and returns true if the Ped's model matches.
-    --- two values: the first indicates if the Ped is a dog, and the second specifies whether it's a
+    ---
-    --- large dog (`true`) or a small dog (`false`). If the Ped is not a dog, the second return value is `nil`.
+    --- @param ped number|nil Optional. The Ped entity to check. Defaults to the player's Ped.
-    ---
+    --- @return boolean True if the Ped is a cat, otherwise false.
-    ---@param ped number|nil Optional. The Ped entity to check. Defaults to the player's Ped (`PlayerPedId()`).
+    ---
-    ---
+    ---@usage
-    ---@return boolean, boolean|nil Returns `true` and `true` if the Ped is a big dog,
+    --- ```lua
-    ---                            `true` and `false` if it's a small dog,
+    --- if isCat() then
-    ---                            or `false` and `nil` if it's not a dog.
+    ---     print("Player is a cat!")
-    ---
+    --- end
-    ---@usage
+    ---
-    --- ```lua
+    --- local anotherPed = GetPedInVehicleSeat(vehicle, -1)
-    --- local isDog, isBigDog = isDog()
+    --- if isCat(anotherPed) then
-    --- if isDog then
+    ---     print("Driver is a cat!")
-    ---     if isBigDog then
+    --- end
-    ---         print("Player is a big dog!")
+    --- ```
-    ---     else
+    function isCat(ped)
-    ---         print("Player is a small dog!")
+        local PedModel = GetEntityModel(ped or PlayerPedId())
-    ---     end
+        for modelHash, _ in pairs(AnimalPeds.CatPeds) do
-    --- else
+            if PedModel == modelHash then
-    ---     print("Player is not a dog.")
+                return true
-    --- end
+            end
-    ---
+        end
-    --- local somePed = GetPedInVehicleSeat(vehicle, 0)
+        return false
-    --- local isPetDog, isLargeDog = isDog(somePed)
+    end
-    --- if isPetDog then
+
-    ---     if isLargeDog then
+    --- Determines if a given Ped is a dog and identifies its size category.
-    ---         print("Passenger is a big dog!")
+    ---
-    ---     else
+    --- Checks the BigDogs and SmallDogs tables to see if the Ped's model matches any dog model.
-    ---         print("Passenger is a small dog!")
+    ---
-    ---     end
+    --- @param ped number|nil Optional. The Ped entity to check. Defaults to the player's Ped.
-    --- end
+    ---@return boolean, boolean|nil boolean Returns `true` and `true` if the Ped is a big dog,
-    --- ```
+    ---                            `true` and `false` if it's a small dog,
-    function isDog(ped)
+    ---                            or `false` and `nil` if it's not a dog.
-        local PedModel = GetEntityModel(ped or PlayerPedId())
+    ---
-        for k, v in pairs(AnimalPeds.BigDogs) do
+    ---@usage
-            if PedModel == k then
+    --- ```lua
-                return true, true
+    --- local isDog, isBigDog = isDog()
-            end
+    --- if isDog then
-        end
+    ---     if isBigDog then
-
+    ---         print("Player is a big dog!")
-        for k, v in pairs(AnimalPeds.SmallDogs) do
+    ---     else
-            if PedModel == k then
+    ---         print("Player is a small dog!")
-                return true, false
+    ---     end
-            end
+    --- else
-        end
+    ---     print("Player is not a dog.")
-        return false, nil
+    --- end
-    end
+    ---
-
+    --- local somePed = GetPedInVehicleSeat(vehicle, 0)
-    --- Retrieves a list of all animal model hashes.
+    --- local isPetDog, isLargeDog = isDog(somePed)
-    ---
+    --- if isPetDog then
-    --- This function compiles and returns a flat table containing all model hashes
+    ---     if isLargeDog then
-    --- from the various animal categories defined within the `AnimalPeds` table.
+    ---         print("Passenger is a big dog!")
-    --- It's useful for iterating over or performing bulk operations on all animal models.
+    ---     else
-    ---
+    ---         print("Passenger is a small dog!")
-    ---@return table table A table containing all animal model hashes.
+    ---     end
-    ---
+    --- end
-    ---@usage
+    --- ```
-    --- ```lua
+    function isDog(ped)
-    --- local allAnimalModels = getAnimalModels()
+        local PedModel = GetEntityModel(ped or PlayerPedId())
-    --- for _, modelHash in ipairs(allAnimalModels) do
+        for modelHash, _ in pairs(AnimalPeds.BigDogs) do
-    ---     print("Animal Model Hash:", modelHash)
+            if PedModel == modelHash then
-    --- end
+                return true, true
-    --- ```
+            end
-    function getAnimalModels()
+        end
-        local animalTable = {}
+        for modelHash, _ in pairs(AnimalPeds.SmallDogs) do
-        for k in pairs(AnimalPeds) do
+            if PedModel == modelHash then
-            for v in pairs(AnimalPeds[k]) do
+                return true, false
-                animalTable[#animalTable+1] = v
+            end
-            end
+        end
-        end
+        return false, nil
-        return animalTable
+    end
-    end
+
-end
+    --- Compiles and returns a flat table of all animal model hashes.
-
+    ---
-AnimalPeds = {
+    --- Iterates through every category in AnimalPeds and collects all model hashes.
-    BigDogs = {
+    ---
-    -- Big Dogs
+    --- @return table table A table containing all animal model hashes.
-        [`a_c_chop`] = {
+    ---
-            deathAnim = "dead_right", deathDict = "creatures@chop@move",
+    ---@usage
-            exitAnim = "getup_r", exitDict = "creatures@chop@getup",
+    --- ```lua
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+    --- local allAnimalModels = getAnimalModels()
-        },
+    --- for _, modelHash in ipairs(allAnimalModels) do
-        [`a_c_k9`] = {
+    ---     print("Animal Model Hash:", modelHash)
-            deathAnim = "dead_right", deathDict = "creatures@chop@move",
+    --- end
-            exitAnim = "getup_r", exitDict = "creatures@chop@getup",
+    --- ```
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+    function getAnimalModels()
-        },
+        local animalModels = {}
-        [`a_c_husky`] = {
+        for _, animalCategory in pairs(AnimalPeds) do
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+            for modelHash, _ in pairs(animalCategory) do
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+                table.insert(animalModels, modelHash)
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+            end
-        },
+        end
-        [`a_c_retriever`] = {
+        return animalModels
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+    end
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+    --- Compiles and returns a table of animal animations for the ped model.
-        },
+    ---
-        [`a_c_shepherd`] = {
+    --- Iterates through every category in AnimalPeds and collects all anims.
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+    ---
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+    --- @return table table A table containing all current model anims.
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+    ---
-        },
+    ---@usage
-        [`a_c_rottweiler`] = {
+    --- ```lua
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+    --- local getAnim = getAnimalAnims(ped)
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+    --- playAnim(getAnim.sitDict, getAnim.sitAnim, -1, 1)
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+    --- ```
-        },
+    function getAnimalAnims(ped)
-        [`ft-aushep`] = {
+        local model = GetEntityModel(ped)
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        local animalTable = {}
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        for _, animalCategory in pairs(AnimalPeds) do
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+            for k, v in pairs(animalCategory) do
-        },
+                if k == model then
-        [`golden_r`] = {
+                    animalTable = v
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+                    break
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+                end
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+            end
-        },
+        end
-        [`ft-dobermanv2`] = {
+        return animalTable
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+    end
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+end
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+
-        },
+-------------------------------------------------------------
-        [`doberman`] = {
+-- Animal Models Data
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+-------------------------------------------------------------
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+-- Define the animal models and their associated animations.
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+AnimalPeds = {
-        },
+    BigDogs = {
-        [`ft-gs`] = {
+        [`a_c_chop`] = { deathAnim = "dead_right", deathDict = "creatures@chop@move", exitAnim = "getup_r", exitDict = "creatures@chop@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`a_c_k9`] = { deathAnim = "dead_right", deathDict = "creatures@chop@move", exitAnim = "getup_r", exitDict = "creatures@chop@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`a_c_husky`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`a_c_retriever`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        },
+        [`a_c_shepherd`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        [`k9_husky`] = {
+        [`a_c_rottweiler`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`ft-aushep`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`golden_r`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`ft-dobermanv2`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        },
+        [`doberman`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        [`ft-bloodhound`] = {
+        [`ft-gs`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`k9_husky`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`ft-bloodhound`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`bernard`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        },
+        [`ft-pterrier`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        [`bernard`] = {
+        [`ft-labrador`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`dane`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`ft_malinois`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`abdog`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        },
+        [`dalmatian`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        [`ft-pterrier`] = {
+        [`a_c_dalmatian`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`ft-boxer`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`ft-bs`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`chowchow`] = { deathAnim = "dead_right", deathDict = "creatures@rottweiler@move", exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup", sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car" },
-        },
+        [`a_c_coyote`] = { deathAnim = "dead_right", deathDict = "creatures@coyote@move", exitAnim = "getup_r", exitDict = "creatures@coyote@getup", sitAnim = "base", sitDict = "creatures@coyote@amb@world_coyote_howl@base" },
-        [`ft-labrador`] = {
+        [`a_c_coyote_02`] = { deathAnim = "dead_right", deathDict = "creatures@coyote@move", exitAnim = "getup_r", exitDict = "creatures@coyote@getup", sitAnim = "base", sitDict = "creatures@coyote@amb@world_coyote_howl@base" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+    },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+    SmallDogs = {
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`a_c_poodle`] = { deathAnim = "dead_right", deathDict = "creatures@pug@move", exitAnim = "getup_r", exitDict = "creatures@pug@getup", sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base" },
-        },
+        [`ft-chihuahua`] = { deathAnim = "dead_right", deathDict = "creatures@pug@move", exitAnim = "getup_r", exitDict = "creatures@pug@getup", sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base" },
-        [`dane`] = {
+        [`a_c_pug`] = { deathAnim = "dead_right", deathDict = "creatures@pug@move", exitAnim = "getup_r", exitDict = "creatures@pug@getup", sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`a_c_pug_02`] = { deathAnim = "dead_right", deathDict = "creatures@pug@move", exitAnim = "getup_r", exitDict = "creatures@pug@getup", sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`a_c_westy`] = { deathAnim = "dead_right", deathDict = "creatures@pug@move", exitAnim = "getup_r", exitDict = "creatures@pug@getup", sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`ft-pretriever`] = { deathAnim = "dead_right", deathDict = "creatures@pug@move", exitAnim = "getup_r", exitDict = "creatures@pug@getup", sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base" },
-        },
+        [`ft-shepk9`] = { deathAnim = "dead_right", deathDict = "creatures@pug@move", exitAnim = "getup_r", exitDict = "creatures@pug@getup", sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base" },
-        [`ft_malinois`] = {
+    },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+    CatPeds = {
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`bshorthair`] = { deathAnim = "dead_right", deathDict = "creatures@cat@move", exitAnim = "getup_r", exitDict = "creatures@cat@getup", sitAnim = "base", sitDict = "creatures@cat@amb@world_cat_sleeping_ledge@base" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`a_c_cat_01`] = { deathAnim = "dead_right", deathDict = "creatures@cat@move", exitAnim = "getup_r", exitDict = "creatures@cat@getup", sitAnim = "base", sitDict = "creatures@cat@amb@world_cat_sleeping_ledge@base" },
-        },
+        [`ft-sphynx`] = { deathAnim = "dead_right", deathDict = "creatures@coyote@move", exitAnim = "getup_r", exitDict = "creatures@coyote@getup", sitAnim = "base", sitDict = "creatures@coyote@amb@world_coyote_howl@base" },
-        [`abdog`] = {
+    },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+    OtherPeds = {
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`ft-raccoon`] = { deathAnim = "dead_right", deathDict = "creatures@cat@move", exitAnim = "getup_r", exitDict = "creatures@cat@getup", sitAnim = "base", sitDict = "creatures@cat@amb@world_cat_sleeping_ledge@base" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`a_c_hen`] = { deathAnim = "dead_right", deathDict = "creatures@hen@move", exitAnim = "getup_r", exitDict = "creatures@hen@getup" },
-        },
+        [`a_c_rabbit_01`] = { deathAnim = "dead_right", deathDict = "creatures@rabbit@move", exitAnim = "getup_r", exitDict = "creatures@rabbit@getup", sitAnim = "idle_c", sitDict = "creatures@coyote@amb@world_coyote_howl@base" },
-        [`dalmatian`] = {
+        [`a_c_rabbit_02`] = { deathAnim = "dead_right", deathDict = "creatures@rabbit@move", exitAnim = "getup_r", exitDict = "creatures@rabbit@getup", sitAnim = "idle_c", sitDict = "creatures@coyote@amb@world_coyote_howl@base" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`a_c_rat`] = { deathAnim = "dead_right", deathDict = "creatures@rat@move", exitAnim = "getup_r", exitDict = "creatures@rat@getup" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`a_c_deer`] = { deathAnim = "dead_right", deathDict = "creatures@deer@move", exitAnim = "getup_r", exitDict = "creatures@deer@getup" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`a_c_boar`] = { deathAnim = "dead_right", deathDict = "creatures@boar@move", exitAnim = "getup_r", exitDict = "creatures@boar@getup" },
-        },
+        [`a_c_boar_02`] = { deathAnim = "dead_right", deathDict = "creatures@boar@move", exitAnim = "getup_r", exitDict = "creatures@boar@getup" },
-        [`a_c_dalmatian`] = {
+        [`a_c_chicken`] = { deathAnim = "dead_right", deathDict = "creatures@chicken@move", exitAnim = "getup_r", exitDict = "creatures@chicken@getup" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`a_c_pig`] = { deathAnim = "dead_right", deathDict = "creatures@pig@move", exitAnim = "getup_r", exitDict = "creatures@pig@getup" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`a_c_sharkhammer`] = { deathAnim = "dead_right", deathDict = "creatures@sharkhammer@move", exitAnim = "getup_r", exitDict = "creatures@sharkhammer@getup" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`a_c_sharktiger`] = { deathAnim = "dead_right", deathDict = "creatures@sharktiger@move", exitAnim = "getup_r", exitDict = "creatures@sharktiger@getup" },
-        },
+        [`a_c_crow`] = { deathAnim = "dead_down", deathDict = "creatures@crow@move", exitAnim = "nill", exitDict = "creatures@pug@move" },
-        [`ft-boxer`] = {
+        [`a_c_pigeon`] = { deathAnim = "dead_down", deathDict = "creatures@pigeon@move", exitAnim = "nill", exitDict = "creatures@pug@move" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+    },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+    Monekys = {
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+        [`ft-chimpanzee`] = { deathAnim = "dead", deathDict = "dead_a", exitAnim = "get_up@sat_on_floor@to_stand", exitDict = "getup_0" },
-        },
+        [`a_c_chimp`] = { deathAnim = "dead", deathDict = "dead_a", exitAnim = "get_up@sat_on_floor@to_stand", exitDict = "getup_0" },
-        [`ft-bs`] = {
+        [`a_c_chimp_02`] = { deathAnim = "dead", deathDict = "dead_a", exitAnim = "get_up@sat_on_floor@to_stand", exitDict = "getup_0" },
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
+        [`a_c_rhesus`] = { deathAnim = "dead", deathDict = "dead_a", exitAnim = "get_up@sat_on_floor@to_stand", exitDict = "getup_0" },
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
+        [`ft-capmonkey2`] = { deathAnim = "dead_right", deathDict = "creatures@pug@move", exitAnim = "getup_r", exitDict = "creatures@pug@getup", sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base" },
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
+    }
-        },
-        [`chowchow`] = {
-            deathAnim = "dead_right", deathDict = "creatures@rottweiler@move",
-            exitAnim = "getup_r", exitDict = "creatures@rottweiler@getup",
-            sitAnim = "sit", sitDict = "creatures@rottweiler@in_vehicle@std_car"
-        },
-        [`a_c_coyote`] = {
-            deathAnim = "dead_right", deathDict = "creatures@coyote@move",
-            exitAnim = "getup_r", exitDict = "creatures@coyote@getup",
-            sitAnim = "base", sitDict = "creatures@coyote@amb@world_coyote_howl@base"
-        },
-        [`a_c_coyote_02`] = {
-            deathAnim = "dead_right", deathDict = "creatures@coyote@move",
-            exitAnim = "getup_r", exitDict = "creatures@coyote@getup",
-            sitAnim = "base", sitDict = "creatures@coyote@amb@world_coyote_howl@base"
-        },
-    },
-    SmallDogs = {
-    --   Small Dogs
-        [`a_c_poodle`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pug@move",
-            exitAnim = "getup_r", exitDict = "creatures@pug@getup",
-            sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base"
-        },
-        [`ft-chihuahua`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pug@move",
-            exitAnim = "getup_r", exitDict = "creatures@pug@getup",
-            sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base"
-        },
-        [`a_c_pug`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pug@move",
-            exitAnim = "getup_r", exitDict = "creatures@pug@getup",
-            sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base"
-        },
-        [`a_c_pug_02`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pug@move",
-            exitAnim = "getup_r", exitDict = "creatures@pug@getup",
-            sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base"
-        },
-        [`a_c_westy`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pug@move",
-            exitAnim = "getup_r", exitDict = "creatures@pug@getup",
-            sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base"
-        },
-        [`ft-pretriever`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pug@move",
-            exitAnim = "getup_r", exitDict = "creatures@pug@getup",
-            sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base"
-        },
-        [`ft-shepk9`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pug@move",
-            exitAnim = "getup_r", exitDict = "creatures@pug@getup",
-            sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base"
-        },
-    },
-    CatPeds = {
-        --   Cat
-        [`bshorthair`] = {
-            deathAnim = "dead_right", deathDict = "creatures@cat@move",
-            exitAnim = "getup_r", exitDict = "creatures@cat@getup",
-            sitAnim = "base", sitDict = "creatures@cat@amb@world_cat_sleeping_ledge@base"
-        },
-        [`a_c_cat_01`] = {
-            deathAnim = "dead_right", deathDict = "creatures@cat@move",
-            exitAnim = "getup_r", exitDict = "creatures@cat@getup",
-            sitAnim = "base", sitDict = "creatures@cat@amb@world_cat_sleeping_ledge@base"
-        },
-        [`ft-sphynx`] = {
-            deathAnim = "dead_right", deathDict = "creatures@coyote@move",
-            exitAnim = "getup_r", exitDict = "creatures@coyote@getup",
-            sitAnim = "base", sitDict = "creatures@coyote@amb@world_coyote_howl@base"
-        },
-    },
-    OtherPeds = {
-        --   Other Animals
-        [`ft-raccoon`] = {
-            deathAnim = "dead_right", deathDict = "creatures@cat@move",
-            exitAnim = "getup_r", exitDict = "creatures@cat@getup",
-            sitAnim = "base", sitDict = "creatures@cat@amb@world_cat_sleeping_ledge@base"
-        },
-        [`a_c_hen`] = {
-            deathAnim = "dead_right", deathDict = "creatures@hen@move",
-            exitAnim = "getup_r", exitDict = "creatures@hen@getup"
-        },
-        [`a_c_rabbit_01`] = {
-            deathAnim = "dead_right", deathDict = "creatures@rabbit@move",
-            exitAnim = "getup_r", exitDict = "creatures@rabbit@getup",
-            sitAnim = "idle_c", sitDict = "creatures@coyote@amb@world_coyote_howl@base"
-        },
-        [`a_c_rabbit_02`] = {
-            deathAnim = "dead_right", deathDict = "creatures@rabbit@move",
-            exitAnim = "getup_r", exitDict = "creatures@rabbit@getup",
-            sitAnim = "idle_c", sitDict = "creatures@coyote@amb@world_coyote_howl@base"
-        },
-        [`a_c_rat`] = {
-            deathAnim = "dead_right", deathDict = "creatures@rat@move",
-            exitAnim = "getup_r", exitDict = "creatures@rat@getup"
-        },
-        [`a_c_deer`] = {
-            deathAnim = "dead_right", deathDict = "creatures@deer@move",
-            exitAnim = "getup_r", exitDict = "creatures@deer@getup"
-        },
-        [`a_c_boar`] = {
-            deathAnim = "dead_right", deathDict = "creatures@boar@move",
-            exitAnim = "getup_r", exitDict = "creatures@boar@getup"
-        },
-        [`a_c_boar_02`] = {
-            deathAnim = "dead_right", deathDict = "creatures@boar@move",
-            exitAnim = "getup_r", exitDict = "creatures@boar@getup"
-        },
-        [`a_c_chicken`] = {
-            deathAnim = "dead_right", deathDict = "creatures@chicken@move",
-            exitAnim = "getup_r", exitDict = "creatures@chicken@getup"
-        },
-        [`a_c_pig`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pig@move",
-            exitAnim = "getup_r", exitDict = "creatures@pig@getup"
-        },
-        [`a_c_sharkhammer`] = {
-            deathAnim = "dead_right", deathDict = "creatures@sharkhammer@move",
-            exitAnim = "getup_r", exitDict = "creatures@sharkhammer@getup"
-        },
-        [`a_c_sharktiger`] = {
-            deathAnim = "dead_right", deathDict = "creatures@sharktiger@move",
-            exitAnim = "getup_r", exitDict = "creatures@sharktiger@getup"
-        },
-        [`a_c_crow`] = {
-            deathAnim = "dead_down", deathDict = "creatures@crow@move",
-            exitAnim = "nill", exitDict = "creatures@pug@move", -- no get up anim
-        },
-        [`a_c_pigeon`] = {
-            deathAnim = "dead_down", deathDict = "creatures@pigeon@move",
-            exitAnim = "nill", exitDict = "creatures@pug@move", -- no get up anim
-        },
-    },
-    Monekys = {
-        [`ft-chimpanzee`] = {
-            deathAnim = "dead", deathDict = "dead_a",
-            exitAnim = "get_up@sat_on_floor@to_stand", exitDict = "getup_0"
-        },
-        [`a_c_chimp`] = {
-            deathAnim = "dead", deathDict = "dead_a",
-            exitAnim = "get_up@sat_on_floor@to_stand", exitDict = "getup_0"
-        },
-        [`a_c_chimp_02`] = {
-            deathAnim = "dead", deathDict = "dead_a",
-            exitAnim = "get_up@sat_on_floor@to_stand", exitDict = "getup_0"
-        },
-        [`a_c_rhesus`] = {
-            deathAnim = "dead", deathDict = "dead_a",
-            exitAnim = "get_up@sat_on_floor@to_stand", exitDict = "getup_0"
-        },
-        [`ft-capmonkey2`] = {
-            deathAnim = "dead_right", deathDict = "creatures@pug@move",
-            exitAnim = "getup_r", exitDict = "creatures@pug@getup",
-            sitAnim = "base", sitDict = "creatures@pug@amb@world_dog_sitting@base"
-        },
-    }
 }

shared/jobfunctions.lua

@@ -1,196 +1,233 @@
--- Global variable to track duty status
+--[[
-onDuty = false
+    Duty & Interaction Utilities Module
-
+    --------------------------------------
---- Scans the 'Jobs' and 'Gangs' tables to identify roles classified as Bosses.
+    This module provides functions related to:
----
+      • Determining boss roles from Jobs and Gangs tables.
---- This function iterates through the specified role's grades within the `Jobs` or `Gangs` tables.
+      • Checking a player's job and duty status.
---- It identifies which grades are marked as bosses (`isboss`) or have bank authorization (`bankAuth`).
+      • Toggling duty state.
---- The function returns a table where each role maps to the lowest grade number that qualifies as a boss.
+      • Simulating player interactions such as hand washing, using toilets/urinals,
----
+        and teleporting via doors.
----@param role string The name of the job or gang role to check for boss grades.
+]]
----
+
----@return table table A table containing roles mapped to their respective boss grade numbers.
+-------------------------------------------------------------
----
+-- Global Duty Status
----@usage
+-------------------------------------------------------------
---- ```lua
+-- This attempts to sync up with the players framework onDuty variable
---- local bosses = makeBossRoles("police")
+-- This stops the script getting confused when one is false and one is true
---- if bosses["police"] then
+onDuty = false
----     print("Police role has a boss grade.")
+
---- end
+if not isServer() then
---- ```
+    onPlayerLoaded(function()
-function makeBossRoles(role)
+        onDuty = getPlayer().onDuty
-    local boss = {}
+    end, true)
-    local data = (Jobs and Jobs[role]) or (Gangs and Gangs[role])
+end
-    if data then
+
-        for grade, info in pairs(data.grades) do
+-------------------------------------------------------------
-            if info.isboss or info.bankAuth then
+-- Boss Role Detection
-                boss[role] = boss[role] and math.min(boss[role], tonumber(grade)) or tonumber(grade)
+-------------------------------------------------------------
-            end
+
-        end
+--- Scans the 'Jobs' and 'Gangs' tables to identify roles classified as bosses.
-    end
+---
-    return boss
+--- Iterates through the specified role's grades in the Jobs or Gangs table and returns
-end
+--- a table mapping the role to the lowest grade number that qualifies as a boss (isboss or bankAuth).
-
+---
---- Checks if the player has a specific job and is on duty.
+--- @param role string The job or gang role to check.
----
+--- @return table table A table with the role mapped to its boss grade number.
---- This function verifies whether the player possesses the specified job and, if applicable,
+---
---- whether they are currently on duty. It provides a notification if the player fails these checks.
+--- @usage
----
+--- ```lua
----@param job string The name of the job or gang to check.
+--- local bosses = makeBossRoles("police")
----
+--- if bosses["police"] then
----@return boolean Returns `true` if the player has the job (and is on duty if required), otherwise `false`.
+---     print("Police role has a boss grade.")
----
+--- end
----@usage
+--- ```
---- ```lua
+function makeBossRoles(role)
---- if jobCheck("mechanic") then
+    local boss = {}
----     -- Allow access to mechanic-related features
+    local data = (Jobs and Jobs[role]) or (Gangs and Gangs[role])
---- else
+    if data then
----     -- Deny access or notify the player
+        for grade, info in pairs(data.grades) do
---- end
+            if info.isboss or info.bankAuth or info.isBoss then
---- ```
+                boss[role] = boss[role] and math.min(boss[role], tonumber(grade)) or tonumber(grade)
-function jobCheck(job)
+            end
-    canDo = true
+        end
-    if Jobs[job] then
+    end
-        if not hasJob(job) or not onDuty then
+    return boss
-            triggerNotify(nil, Loc[Config.Lan].error["not_clockedin"])
+end
-            canDo = false
+
-        end
+-------------------------------------------------------------
-    end
+-- Job & Duty Checks
-    if Gangs[job] then
+-------------------------------------------------------------
-        if not hasJob(job) then
+
-            canDo = false
+--- Checks if the player has a specific job (or gang) and is on duty.
-        end
+---
-    end
+--- Verifies whether the player possesses the specified role. If the role is defined in the Jobs table,
-    return canDo
+--- it also checks that the player is clocked in (onDuty). If the check fails, a notification is sent.
-end
+---
-
+--- @param job string The job or gang to check.
---- Toggles the player's duty status.
+--- @return boolean Returns true if the player meets the criteria; false otherwise.
----
+---
---- This function switches the player's duty state between on-duty and off-duty.
+--- @usage
---- It integrates with QBcore's duty system if available; otherwise, it manually toggles the `onDuty` variable
+--- ```lua
---- and sends a notification to the player about their new duty status.
+--- if jobCheck("mechanic") then
----
+---     -- Allow mechanic features.
----@usage
+--- else
---- ```lua
+---     -- Deny access.
---- toggleDuty()
+--- end
---- -- Player will receive a notification indicating their new duty status
+--- ```
---- ```
+function jobCheck(job)
-function toggleDuty()
+    local canDo = true
-    if isStarted(QBExport) or isStarted(QBXExport) then
+    if Jobs[job] then
-        TriggerServerEvent("QBCore:ToggleDuty")
+        if not hasJob(job) or not getPlayer().onDuty then
-    else
+            triggerNotify(nil, Loc[Config.Lan].error["not_clockedin"])
-        onDuty = not onDuty
+            canDo = false
-        if onDuty then
+        end
-            triggerNotify(nil, "Now on duty", "success")
+    end
-        else
+    if Gangs[job] then
-            triggerNotify(nil, "Now off duty", "success")
+        if not hasJob(job) then
-        end
+            canDo = false
-    end
+        end
-end
+    end
-
+    return canDo
---- Initiates the hand-washing action for the player.
+end
----
+
---- This function triggers an animation and a progress bar to simulate the player washing their hands.
+--- Toggles the player's duty status.
---- Upon completion, it sends a success notification. If the action is canceled, it notifies the player of the cancellation.
+---
----
+--- Switches the player's duty state between on-duty and off-duty. If using QBcore,
----@param data table A table containing the coordinates where the hand-washing action takes place.
+--- it triggers the appropriate server event. Otherwise, it manually toggles the onDuty variable and notifies the player.
---- - **coords** (`vector3`): The position where the hand-washing animation and camera are focused.
+---
----
+--- @usage
----@return void
+--- ```lua
----
+--- toggleDuty()  -- Player receives a notification of their new duty status.
----@usage
+--- ```
---- ```lua
+function toggleDuty()
---- washHands({ coords = vector3(200.0, 300.0, 40.0) })
+    if isStarted(QBExport) or isStarted(QBXExport) then
---- -- Player will perform the hand-washing animation at the specified location
+        TriggerServerEvent("QBCore:ToggleDuty")
---- ```
+        Wait(100)
-function washHands(data) local ped = PlayerPedId()
+        onDuty = getPlayer().onDuty
-    lookEnt(data.coords)
+    elseif isStarted(RSGExport) then
-    local cam = createTempCam(ped, data.coords)
+        TriggerServerEvent("RSGCore:ToggleDuty")
-    if progressBar({
+        Wait(100)
-        label = Loc[Config.Lan].progressbar["progress_washing"],
+        onDuty = getPlayer().onDuty
-        time = 5000,
+    else
-        cancel = true,
+        if onDuty then
-        dict = "mp_arresting",
+            triggerNotify(nil, "Now on duty", "success")
-        anim = "a_uncuff",
+        else
-        flag = 32,
+            triggerNotify(nil, "Now off duty", "success")
-        icon = "fas fa-hand-holding-droplet",
+        end
-        cam = cam
+    end
-    }) then
+end
-        triggerNotify(nil, Loc[Config.Lan].success["washed_hands"], "success")
+
-    else
+-- Framework specific functions to keep duty status synced
-        triggerNotify(nil, Loc[Config.Lan].error["cancel"], 'error')
+RegisterNetEvent("QBCore:Client:OnJobUpdate", function(JobInfo) onDuty = JobInfo.onduty end)
-    end
+RegisterNetEvent("QBCore:Client:SetDuty", function(duty) onDuty = duty end)
-    ClearPedTasks(ped)
+
-end
+RegisterNetEvent("qbx_core:client:onJobUpdate", function(JobInfo) onDuty = JobInfo.onduty end)
-
+
---- Handles the player's interaction with a toilet or urinal.
+RegisterNetEvent("RSGCore:Client:OnJobUpdate", function(JobInfo) onDuty = JobInfo.onduty end)
----
+RegisterNetEvent("RSGCore:Client:SetDuty", function(duty) onDuty = duty end)
---- This function manages the animations and progress bars associated with using a toilet or urinal.
+
---- Depending on whether the interaction is with a urinal (`data.urinal`), it plays the appropriate animation
+-------------------------------------------------------------
---- and triggers server events upon successful completion. If the action is canceled, it notifies the player.
+-- Interaction Functions
----
+-------------------------------------------------------------
----@param data table A table containing data about the toilet interaction.
+
---- - **urinal** (`boolean`): Indicates whether the interaction is with a urinal (`true`) or a toilet (`false`).
+--- Initiates the hand-washing action for the player.
---- - **sitcoords** (`vector4`): The coordinates and heading for the seating animation when using a toilet.
+---
----
+--- Triggers an animation and a progress bar to simulate hand washing at the specified coordinates.
----@usage
+--- On success, it notifies the player; if cancelled, it sends an error notification.
---- ```lua
+---
---- useToilet({ urinal = true })
+--- @param data table A table containing:
---- -- Player uses a urinal with corresponding animations and notifications
+---     - coords (vector3): The location where the hand-washing action occurs.
----
+---
---- useToilet({ urinal = false, sitcoords = vector4(215.76, -810.12, 29.73, 90.0) })
+--- @usage
---- -- Player sits down to use a toilet with corresponding animations and notifications
+--- ```lua
---- ```
+--- washHands({ coords = vector3(200.0, 300.0, 40.0) })
-function useToilet(data)
+--- ```
-    if data.urinal then
+function washHands(data)
-        if progressBar({
+    local ped = PlayerPedId()
-            label = "Using Urinal",
+    lookEnt(data.coords)
-            time = 5000,
+    local cam = createTempCam(ped, data.coords)
-            cancel = true,
+    if progressBar({
-            dict = "misscarsteal2peeing",
+        label = Loc[Config.Lan].progressbar["progress_washing"],
-            anim = "peeing_loop",
+        time = 5000,
-            flag = 32
+        cancel = true,
-        }) then
+        dict = "mp_arresting",
-            TriggerServerEvent(getScript().."server:Urinal")
+        anim = "a_uncuff",
-        else
+        flag = 32,
-            lockInv(false)
+        icon = "fas fa-hand-holding-droplet",
-            triggerNotify(nil, Loc[Config.Lan].error["cancelled"], 'error')
+        cam = cam
-        end
+    }) then
-    else
+        triggerNotify(nil, Loc[Config.Lan].success["washed_hands"], "success")
-        TaskStartScenarioAtPosition(PlayerPedId(), "PROP_HUMAN_SEAT_CHAIR_MP_PLAYER", data.sitcoords.x, data.sitcoords.y, data.sitcoords.z, data.sitcoords[4], 0, 1, true)
+    else
-        if progressBar({
+        triggerNotify(nil, Loc[Config.Lan].error["cancel"], "error")
-            label = "Using Toilet",
+    end
-            time = 10000,
+    ClearPedTasks(ped)
-            cancel = true
+end
-        }) then
+
-            TriggerServerEvent(getScript().."server:Urinal")
+--- Handles the player's interaction with a toilet or urinal.
-            ClearPedTasks(PlayerPedId())
+---
-        else
+--- Manages animations and progress bars for using a urinal or a toilet. If the action is successful,
-            lockInv(false)
+--- it triggers the appropriate server event (urinal usage) or notifies the player if cancelled.
-            triggerNotify(nil, Loc[Config.Lan].error["cancelled"], 'error')
+---
-        end
+--- @param data table A table containing:
-    end
+---     - urinal (boolean): `true if using a urinal; false for a toilet.`
-end
+---     - sitcoords (vector4): `Coordinates and heading for seating when using a toilet.`
-
+---
---- Teleports the player to specified coordinates with a fade effect.
+--- @usage
----
+--- ```lua
---- This function fades the screen out, moves the player to the target coordinates (`data.telecoords`),
+--- useToilet({ urinal = true })
---- sets the player's heading, and then fades the screen back in. It's commonly used for door interactions
+--- -- Player uses a urinal with corresponding animations and notifications
---- or teleportation points within the game.
+---
----
+--- useToilet({ urinal = false, sitcoords = vector4(215.76, -810.12, 29.73, 90.0) })
----@param data table A table containing teleportation data.
+--- -- Player sits down to use a toilet with corresponding animations and notifications
---- - **telecoords** (`vector4`): The target coordinates and heading for the teleportation.
+--- ```
----
+function useToilet(data)
----@usage
+    if data.urinal then
---- ```lua
+        if progressBar({
---- useDoor({ telecoords = vector4(215.76, -810.12, 29.73, 90.0) })
+            label = "Using Urinal",
---- -- Player is teleported to the specified coordinates with a fade effect
+            time = 5000,
---- ```
+            cancel = true,
-function useDoor(data)
+            dict = "misscarsteal2peeing",
-    DoScreenFadeOut(500)
+            anim = "peeing_loop",
-    while not IsScreenFadedOut() do Wait(10) end
+            flag = 32
-    SetEntityCoords(PlayerPedId(), data.telecoords.xyz, 0, 0, 0, false)
+        }) then
-    SetEntityHeading(PlayerPedId(), data.telecoords.w)
+            TriggerServerEvent(getScript().."server:Urinal")
-    DoScreenFadeIn(1000)
+        else
-    Wait(100)
+            lockInv(false)
-end
+            triggerNotify(nil, Loc[Config.Lan].error["cancelled"], "error")
+        end
+    else
+        TaskStartScenarioAtPosition(PlayerPedId(), "PROP_HUMAN_SEAT_CHAIR_MP_PLAYER", data.sitcoords.x, data.sitcoords.y, data.sitcoords.z, data.sitcoords[4], 0, 1, true)
+        if progressBar({
+            label = "Using Toilet",
+            time = 10000,
+            cancel = true
+        }) then
+            TriggerServerEvent(getScript().."server:Urinal")
+            ClearPedTasks(PlayerPedId())
+        else
+            lockInv(false)
+            triggerNotify(nil, Loc[Config.Lan].error["cancelled"], "error")
+        end
+    end
+end
+
+--- Teleports the player to specified coordinates with a fade effect.
+---
+--- Fades the screen out, moves the player to the target coordinates, sets the player's heading,
+--- then fades the screen back in. Commonly used for door interactions or teleportation points.
+---
+--- @param data table A table containing:
+---   - telecoords (vector4): The target coordinates and heading.
+---
+--- @usage
+--- ```lua
+--- useDoor({ telecoords = vector4(215.76, -810.12, 29.73, 90.0) })
+--- ```
+function useDoor(data)
+    DoScreenFadeOut(500)
+    while not IsScreenFadedOut() do Wait(10) end
+    SetEntityCoords(PlayerPedId(), data.telecoords.xyz, 0, 0, 0, false)
+    SetEntityHeading(PlayerPedId(), data.telecoords.w)
+    DoScreenFadeIn(1000)
+    Wait(100)
+end

shared/make/cameras.lua

@@ -1,75 +1,81 @@
---- Creates a temporary camera at a specified position, pointing towards given coordinates.
+--- Creates a temporary camera at a specified position, pointing towards given coordinates.
---
+--
--- This function creates a camera at a position relative to an entity or at a specified position and orients it to look at the target coordinates.
+-- This function creates a camera at a position relative to an entity or at a specified position and orients it to look at the target coordinates.
--- The camera is only created if `Config.Crafting.craftCam` is enabled in the configuration.
+-- The camera is only created if `Config.Crafting.craftCam` is enabled in the configuration.
---
+--
----@param ent entityId|coords The base position for the camera. Can be an entity handle or a `vector3` position.
+---@param ent entityId|coords The base position for the camera. Can be an entity handle or a `vector3` position.
--- If `ent` is an entity, the camera position is calculated as an offset from the entity's position using `GetOffsetFromEntityInWorldCoords`.
+-- If `ent` is an entity, the camera position is calculated as an offset from the entity's position using `GetOffsetFromEntityInWorldCoords`.
--- If `ent` is a `vector3`, it is used directly as the camera's position.
+-- If `ent` is a `vector3`, it is used directly as the camera's position.
---
+--
----@param coords vector3 The target `vector3` coordinates that the camera will point at.
+---@param coords vector3 The target `vector3` coordinates that the camera will point at.
---
+--
----@return cam camID The handle of the created camera, or `nil` if the camera was not created (e.g., if `Config.Crafting.craftCam` is `false`).
+---@return cam camID The handle of the created camera, or `nil` if the camera was not created (e.g., if `Config.Crafting.craftCam` is `false`).
---
+--
----@usage
+---@usage
--- ```lua
+-- ```lua
--- local cam = createTempCam(entity, targetCoords)
+-- local cam = createTempCam(entity, targetCoords)
--- ```
+-- ```
-function createTempCam(ent, coords)
+function createTempCam(ent, coords)
-	local cam = nil
+	local cam = nil
-	if Config.Crafting.craftCam then
+	if Config.Crafting.craftCam then
-		if debugMode then
+		if debugMode then
-			triggerNotify(nil, "ModCam Created", "success")
+			triggerNotify(nil, "ModCam Created", "success")
-		end
+		end
-		local camCoords = nil
+		local camCoords = nil
-		if type(ent) ~= "vector3" then
+		local pointCoords = nil
-			camCoords = GetOffsetFromEntityInWorldCoords(ent, 1.0, -0.3, 0.8)
+		if type(ent) ~= "vector3" then
-		else
+			camCoords = GetOffsetFromEntityInWorldCoords(ent, 1.0, -0.3, 0.8)
-			camCoords = ent
+		else
-		end
+			camCoords = ent
-		-- Create the camera with specified parameters
+		end
-		cam = CreateCamWithParams("DEFAULT_SCRIPTED_CAMERA", camCoords.x, camCoords.y, camCoords.z + 0.5, 1.0, 0.0, 0.0, 60.00, false, 0)
+
-		-- Point the camera at the target coordinates
+		cam = CreateCamWithParams("DEFAULT_SCRIPTED_CAMERA", camCoords.x, camCoords.y, camCoords.z + 0.5, 1.0, 0.0, 0.0, 60.00, false, 0)
-		PointCamAtCoord(cam, coords)
+
-	end
+		if type(coords) == "number" then
-	return cam
+			SetCamCoord(cam, GetCamCoord(cam) + vec3(0, 0, 1.0))
-end
+			PointCamAtEntity(cam, coords)
-
+		else
---- Activates and starts rendering the temporary camera.
+			PointCamAtCoord(cam, coords)
---
+		end
--- This function sets the specified camera as active and begins rendering it with a smooth transition.
+	end
--- The camera is only activated if `Config.Crafting.craftCam` is enabled in the configuration.
+	return cam
---
+end
----@param cam camID The handle of the camera to activate and render.
+
---
+--- Activates and starts rendering the temporary camera.
----@usage
+--
--- ```lua
+-- This function sets the specified camera as active and begins rendering it with a smooth transition.
--- startTempCam(cam)
+-- The camera is only activated if `Config.Crafting.craftCam` is enabled in the configuration.
--- ```
+--
-function startTempCam(cam)
+---@param cam camID The handle of the camera to activate and render.
-	if Config.Crafting.craftCam then
+--
-		SetCamActive(cam, true)
+---@usage
-		RenderScriptCams(true, true, 1000, true, true)
+-- ```lua
-	end
+-- startTempCam(cam)
-end
+-- ```
-
+function startTempCam(cam)
---- Deactivates the temporary camera and stops rendering.
+	if Config.Crafting.craftCam then
---
+		SetCamActive(cam, true)
--- This function waits for one second, then stops rendering script cameras and destroys all cameras.
+		RenderScriptCams(true, true, 1000, true, true)
--- The delay allows for any transitions or animations to complete.
+	end
---
+end
--- The camera is only deactivated if `Config.Crafting.craftCam` is enabled in the configuration.
+
---
+--- Deactivates the temporary camera and stops rendering.
----@usage
+--
--- ```lua
+-- This function waits for one second, then stops rendering script cameras and destroys all cameras.
--- stopTempCam()
+-- The delay allows for any transitions or animations to complete.
--- ```
+--
-function stopTempCam()
+-- The camera is only deactivated if `Config.Crafting.craftCam` is enabled in the configuration.
-	if Config.Crafting.craftCam then
+--
-		CreateThread(function()
+---@usage
-			Wait(1000)
+-- ```lua
-			RenderScriptCams(false, true, 500, true, true)
+-- stopTempCam()
-			DestroyAllCams()
+-- ```
-		end)
+function stopTempCam()
-	end
+	if Config.Crafting.craftCam then
+		CreateThread(function()
+			Wait(1000)
+			RenderScriptCams(false, true, 500, true, true)
+			DestroyAllCams()
+		end)
+	end
 end

shared/make/loaders.lua

@@ -1,239 +1,241 @@
-local time = 500
+local time = 500
-
+
---- Loads a specified model into memory.
+--- Loads a specified model into memory.
----
+---
---- This function checks if the model is valid and not already loaded.
+--- This function checks if the model is valid and not already loaded.
---- If not loaded, it requests the model and waits until it is loaded or times out.
+--- If not loaded, it requests the model and waits until it is loaded or times out.
----
+---
----@param model string|number The name or hash of the model to load.
+---@param model string|number The name or hash of the model to load.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- loadModel('prop_chair_01a')
+--- loadModel('prop_chair_01a')
---- ```
+--- ```
-function loadModel(model)
+function loadModel(model)
-	if not IsModelValid(model) then print("^6Bridge^7: ^1ERROR^7: ^2Model^7 - '^6"..model.."^7' ^2does not exist in server") return
+	if not IsModelValid(model) then print("^6Bridge^7: ^1ERROR^7: ^2Model^7 - '^6"..model.."^7' ^2does not exist in server") return
-	else
+	else
-		if not HasModelLoaded(model) then
+		if not HasModelLoaded(model) then
-			debugPrint("^6Bridge^7: ^2Loading Model^7: '^6"..model.."^7'")
+			debugPrint("^6Bridge^7: ^2Loading Model^7: '^6"..model.."^7'")
-			while not HasModelLoaded(model) and time > 0 do time -= 1 RequestModel(model) Wait(0) end
+			while not HasModelLoaded(model) and time > 0 do time -= 1 RequestModel(model) Wait(0) end
-			if not HasModelLoaded(model) then print("^6Bridge^7: ^3LoadModel^7: ^2Timed out loading model ^7'^6"..model.."^7'") end
+			if not HasModelLoaded(model) then print("^6Bridge^7: ^3LoadModel^7: ^2Timed out loading model ^7'^6"..model.."^7'") end
-		end
+		end
-		time = 500
+		time = 500
-	end
+	end
-end
+end
-
+
---- Unloads a model from memory.
+--- Unloads a model from memory.
----
+---
---- This function marks a model as no longer needed, allowing the game to free up memory.
+--- This function marks a model as no longer needed, allowing the game to free up memory.
----
+---
----@param model string|number The name or hash of the model to unload.
+---@param model string|number The name or hash of the model to unload.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- unloadModel('prop_chair_01a')
+--- unloadModel('prop_chair_01a')
---- ```
+--- ```
-function unloadModel(model)
+function unloadModel(model)
-    debugPrint("^6Bridge^7: ^2Removing Model from memory cache^7: '^6"..model.."^7'")
+    debugPrint("^6Bridge^7: ^2Removing Model from memory cache^7: '^6"..model.."^7'")
-    SetModelAsNoLongerNeeded(model)
+    SetModelAsNoLongerNeeded(model)
-end
+end
-
+
---- Loads an animation dictionary into memory.
+--- Loads an animation dictionary into memory.
----
+---
---- This function checks if the animation dictionary exists and requests it.
+--- This function checks if the animation dictionary exists and requests it.
---- It waits until the animation dictionary is loaded before proceeding.
+--- It waits until the animation dictionary is loaded before proceeding.
----
+---
----@param animDict string The name of the animation dictionary to load.
+---@param animDict string The name of the animation dictionary to load.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- loadAnimDict('amb@world_human_hang_out_street@male_c@base')
+--- loadAnimDict('amb@world_human_hang_out_street@male_c@base')
---- ```
+--- ```
-function loadAnimDict(animDict)
+function loadAnimDict(animDict)
-	if not DoesAnimDictExist(animDict) then
+	if not DoesAnimDictExist(animDict) then
-		print("^6Bridge^7: ^1ERROR^7: ^2Anim Dictionary^7 - '^6"..animDict.."^7' ^2does not exist in server") return
+		print("^6Bridge^7: ^1ERROR^7: ^2Anim Dictionary^7 - '^6"..animDict.."^7' ^2does not exist in server") return
-	else
+	else
-		debugPrint("^6Bridge^7: ^2Loading Anim Dictionary^7: '^6"..animDict.."^7'")
+		debugPrint("^6Bridge^7: ^2Loading Anim Dictionary^7: '^6"..animDict.."^7'")
-		while not HasAnimDictLoaded(animDict) do RequestAnimDict(animDict) Wait(5) end
+		while not HasAnimDictLoaded(animDict) do RequestAnimDict(animDict) Wait(5) end
-	end
+	end
-end
+end
-
+
---- Unloads an animation dictionary from memory.
+--- Unloads an animation dictionary from memory.
----
+---
---- This function removes the animation dictionary from the game's memory cache.
+--- This function removes the animation dictionary from the game's memory cache.
----
+---
----@param animDict string The name of the animation dictionary to unload.
+---@param animDict string The name of the animation dictionary to unload.
----
+---
----@usage
+---@usage
----@
+---@
---- ```lua
+--- ```lua
---- unloadAnimDict('amb@world_human_hang_out_street@male_c@base')
+--- unloadAnimDict('amb@world_human_hang_out_street@male_c@base')
---- ```
+--- ```
-function unloadAnimDict(animDict)
+function unloadAnimDict(animDict)
-    debugPrint("^6Bridge^7: ^2Removing Anim Dictionary from memory cache^7: '^6"..animDict.."^7'")
+    debugPrint("^6Bridge^7: ^2Removing Anim Dictionary from memory cache^7: '^6"..animDict.."^7'")
-    RemoveAnimDict(animDict)
+    RemoveAnimDict(animDict)
-end
+end
-
+
---- Loads a particle effects (ptfx) dictionary into memory.
+--- Loads a particle effects (ptfx) dictionary into memory.
----
+---
---- This function requests the named particle effects asset and waits until it's loaded.
+--- This function requests the named particle effects asset and waits until it's loaded.
----
+---
----@param ptFxName string The name of the particle effects dictionary to load.
+---@param ptFxName string The name of the particle effects dictionary to load.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- loadPtfxDict('core')
+--- loadPtfxDict('core')
---- ```
+--- ```
-function loadPtfxDict(ptFxName)
+function loadPtfxDict(ptFxName)
-	if not HasNamedPtfxAssetLoaded(ptFxName) then
+	if not HasNamedPtfxAssetLoaded(ptFxName) then
-		debugPrint("^6Bridge^7: ^2Loading Ptfx Dictionary^7: '^6"..ptFxName.."^7'")
+		debugPrint("^6Bridge^7: ^2Loading Ptfx Dictionary^7: '^6"..ptFxName.."^7'")
-		while not HasNamedPtfxAssetLoaded(ptFxName) do RequestNamedPtfxAsset(ptFxName) Wait(5) end
+		while not HasNamedPtfxAssetLoaded(ptFxName) do RequestNamedPtfxAsset(ptFxName) Wait(5) end
-	end
+	end
-end
+end
-
+
---- Unloads a particle effects (ptfx) dictionary from memory.
+--- Unloads a particle effects (ptfx) dictionary from memory.
----
+---
---- This function removes the named particle effects asset from the game's memory cache.
+--- This function removes the named particle effects asset from the game's memory cache.
----
+---
----@param dict string The name of the particle effects dictionary to unload.
+---@param dict string The name of the particle effects dictionary to unload.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- unloadPtfxDict('core')
+--- unloadPtfxDict('core')
---- ```
+--- ```
-function unloadPtfxDict(dict)
+function unloadPtfxDict(dict)
-    debugPrint("^6Bridge^7: ^2Removing Ptfx Dictionary^7: '^6"..dict.."^7'")
+    debugPrint("^6Bridge^7: ^2Removing Ptfx Dictionary^7: '^6"..dict.."^7'")
-    RemoveNamedPtfxAsset(dict)
+    RemoveNamedPtfxAsset(dict)
-end
+end
-
+
---- Loads a texture dictionary into memory.
+--- Loads a texture dictionary into memory.
----
+---
---- This function requests the streamed texture dictionary and waits until it's loaded.
+--- This function requests the streamed texture dictionary and waits until it's loaded.
----
+---
----@param dict string The name of the texture dictionary to load.
+---@param dict string The name of the texture dictionary to load.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- loadTextureDict('commonmenu')
+--- loadTextureDict('commonmenu')
---- ```
+--- ```
-function loadTextureDict(dict)
+function loadTextureDict(dict)
-	if not HasStreamedTextureDictLoaded(dict) then
+	if not HasStreamedTextureDictLoaded(dict) then
-		debugPrint("^6Bridge^7: ^2Loading Texture Dictionary^7: '^6"..dict.."^7'")
+		debugPrint("^6Bridge^7: ^2Loading Texture Dictionary^7: '^6"..dict.."^7'")
-		while not HasStreamedTextureDictLoaded(dict) do RequestStreamedTextureDict(dict) Wait(5) end
+		while not HasStreamedTextureDictLoaded(dict) do RequestStreamedTextureDict(dict) Wait(5) end
-	end
+	end
-end
+end
-
+
---- Loads a script audio bank into memory.
+--- Loads a script audio bank into memory.
----
+---
---- This function requests a script audio bank and waits until it's loaded or times out.
+--- This function requests a script audio bank and waits until it's loaded or times out.
----
+---
----@param bank string The name of the script audio bank to load.
+---@param bank string The name of the script audio bank to load.
----
+---
----@return boolean `true` if the audio bank was successfully loaded; otherwise, `false`.
+---@return boolean `true` if the audio bank was successfully loaded; otherwise, `false`.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- local success = loadScriptBank('DLC_HEISTS_GENERAL_FRONTEND_SOUNDS')
+--- local success = loadScriptBank('DLC_HEISTS_GENERAL_FRONTEND_SOUNDS')
---- ```
+--- ```
-function loadScriptBank(bank)
+function loadScriptBank(bank)
-    local timeout = 2000
+    local timeout = 2000
-    debugPrint("^6Debug^7: ^2Loading ^3Script ^2AudioBank^7...")
+    debugPrint("^6Bridge^7: ^2Loading ^3Script ^2AudioBank^7...")
-    while not RequestScriptAudioBank(bank, 0) do Wait(10) timeout -= 10 if timeout <= 0 then break end end
+    while not RequestScriptAudioBank(bank, false) do Wait(10) timeout -= 10 if timeout <= 0 then break end end
-
+
-    local success = RequestScriptAudioBank(bank, 0)
+    local success = RequestScriptAudioBank(bank, false)
-    debugPrint("^6Debug^7: "..(success and "^3Successfully ^2loaded^7: '^4" or "^1Failed to ^2load^7: '^4")..bank.."^7'")
+    debugPrint("^6Bridge^7: "..(success and "^3Successfully ^2loaded^7: '^4" or "^1Failed to ^2load^7: '^4")..bank.."^7'")
-    return success
+    return success
-end
+end
-
+
---- Loads an ambient audio bank into memory.
+--- Loads an ambient audio bank into memory.
----
+---
---- This function requests an ambient audio bank and waits until it's loaded or times out.
+--- This function requests an ambient audio bank and waits until it's loaded or times out.
----
+---
----@param bank string The name of the ambient audio bank to load.
+---@param bank string The name of the ambient audio bank to load.
----
+---
----@return boolean `true` if the audio bank was successfully loaded; otherwise, `false`.
+---@return boolean `true` if the audio bank was successfully loaded; otherwise, `false`.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- local success = loadAmbientBank('AMB_REVERB_GENERIC')
+--- local success = loadAmbientBank('AMB_REVERB_GENERIC')
---- ```
+--- ```
-function loadAmbientBank(bank)
+function loadAmbientBank(bank)
-    local timeout = 2000
+    local timeout = 2000
-    debugPrint("^6Debug^7: ^2Loading ^3Ambient ^2AudioBank^7...")
+    debugPrint("^6Bridge^7: ^2Loading ^3Ambient ^2AudioBank^7...")
-    while not RequestAmbientAudioBank(bank, 0) do
+    while not RequestAmbientAudioBank(bank, 0) do
-        Wait(10)
+        Wait(10)
-        timeout -= 10
+        timeout -= 10
-        if timeout <= 0 then break end
+        if timeout <= 0 then break end
-    end
+    end
-    local success = RequestAmbientAudioBank(bank, 0)
+    local success = RequestAmbientAudioBank(bank, 0)
-    debugPrint("^6Debug^7: "..(success and "^3Successfully ^2loaded^7: '^4" or "^1Failed to ^2load^7: '^4")..bank.."^7'")
+    debugPrint("^6Bridge^7: "..(success and "^3Successfully ^2loaded^7: '^4" or "^1Failed to ^2load^7: '^4")..bank.."^7'")
-    return success
+    return success
-end
+end
-
+
---- Plays an animation on a specified ped.
+--- Plays an animation on a specified ped.
----
+---
---- This function loads the animation dictionary and instructs the ped to play the animation.
+--- This function loads the animation dictionary and instructs the ped to play the animation.
----
+---
----@param animDict string The name of the animation dictionary.
+---@param animDict string The name of the animation dictionary.
----@param animName string The name of the animation within the dictionary.
+---@param animName string The name of the animation within the dictionary.
----@param duration number (optional) The duration to play the animation in milliseconds. Default is `30000`.
+---@param duration number (optional) The duration to play the animation in milliseconds. Default is `30000`.
----@param flag number (optional) The animation flag controlling how the animation is played. Default is `50`.
+---@param flag number (optional) The animation flag controlling how the animation is played. Default is `50`.
----@param ped number (optional) The ped on which to play the animation. Defaults to the player's ped if not specified.
+---@param ped number (optional) The ped on which to play the animation. Defaults to the player's ped if not specified.
----@param speed number (optional) The speed multiplier for the animation. Default is `8.0`.
+---@param speed number (optional) The speed multiplier for the animation. Default is `8.0`.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- playAnim('amb@world_human_hang_out_street@male_c@base', 'base', 5000, 1, PlayerPedId(), 1.0)
+--- playAnim('amb@world_human_hang_out_street@male_c@base', 'base', 5000, 1, PlayerPedId(), 1.0)
---- ```
+--- ```
-function playAnim(animDict, animName, duration, flag, ped, speed)
+function playAnim(animDict, animName, duration, flag, ped, speed)
-    loadAnimDict(animDict)
+    loadAnimDict(animDict)
-    debugPrint("Attempting to make player play anim", animDict, animName)
+    debugPrint("Attempting to make player play anim", animDict, animName)
-	TaskPlayAnim(ped and ped or PlayerPedId(), animDict, animName, speed or 8.0, speed or -8.0, duration or 30000, flag or 50, 1, false, false, false)
+	TaskPlayAnim(ped and ped or PlayerPedId(), animDict, animName, speed or 8.0, speed or -8.0, duration or 30000, flag or 50, 1, false, false, false)
-end
+end
-
+
---- Stops a specified animation on a ped.
+--- Stops a specified animation on a ped.
----
+---
---- This function stops the animation and unloads the animation dictionary from memory.
+--- This function stops the animation and unloads the animation dictionary from memory.
----
+---
----@param animDict string The name of the animation dictionary.
+---@param animDict string The name of the animation dictionary.
----@param animName string The name of the animation within the dictionary.
+---@param animName string The name of the animation within the dictionary.
----@param ped number (optional) The ped on which to stop the animation. Defaults to the player's ped if not specified.
+---@param ped number (optional) The ped on which to stop the animation. Defaults to the player's ped if not specified.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- stopAnim('amb@world_human_hang_out_street@male_c@base', 'base', PlayerPedId())
+--- stopAnim('amb@world_human_hang_out_street@male_c@base', 'base', PlayerPedId())
---- ```
+--- ```
-function stopAnim(animDict, animName, ped)
+function stopAnim(animDict, animName, ped)
-    debugPrint("Stopping anim for "..(ped or PlayerPedId()))
+    debugPrint("Stopping anim for "..(ped or PlayerPedId()))
-    StopAnimTask(ped or PlayerPedId(), animDict, animName, 0.5)
+    StopAnimTask(ped or PlayerPedId(), animDict, animName, 0.5)
-    StopAnimTask(ped or PlayerPedId(), animName, animDict, 0.5)
+    StopAnimTask(ped or PlayerPedId(), animName, animDict, 0.5)
-    unloadAnimDict(animDict)
+    unloadAnimDict(animDict)
-end
+end
-
+
---- Plays a game sound from a specified coordinate or entity.
+--- Plays a game sound from a specified coordinate or entity.
----
+---
---- This function attempts to play a sound from either a coordinate or an entity, using the specified audio bank and sound name.
+--- This function attempts to play a sound from either a coordinate or an entity, using the specified audio bank and sound name.
----
+---
----@param bank string The name of the audio bank containing the sound.
+---@param bank string The name of the audio bank containing the sound.
----@param sound string The name of the sound to play.
+---@param sound string The name of the sound to play.
----@param coords vector3|number A `vector3` coordinate or an entity handle from which to play the sound.
+---@param coords vector3|number A `vector3` coordinate or an entity handle from which to play the sound.
----@param synced boolean A boolean indicating whether the sound is synced across clients.
+---@param synced boolean A boolean indicating whether the sound is synced across clients.
----@param range number (optional) The maximum range at which the sound can be heard. Default is `10.0`.
+---@param range number (optional) The maximum range at which the sound can be heard. Default is `10.0`.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- playGameSound('DLC_HEIST_HACKING_SNAKE_SOUNDS', 'Beep', vector3(0, 0, 0), false, 15.0)
+--- playGameSound('DLC_HEIST_HACKING_SNAKE_SOUNDS', 'Beep', vector3(0, 0, 0), false, 15.0)
---- ```
+--- ```
-function playGameSound(bank, sound, coords, synced, range)
+function playGameSound(audioBank, soundSet, soundRef, coords, synced, range)
-    debugPrint("^6Debug^7: ^2Attempting to play: ^3"..sound.." ^7(^4"..bank.."^7')")
+    debugPrint("^6Bridge^7: ^2Attempting to play: ^3"..soundRef.." ^7('^4"..audioBank.."^7')")
-    local range = range or 10.0
+    loadScriptBank(audioBank)
-    local soundId = GetSoundId()
+    local range = range or 10.0
-    while not soundId do Wait(10) end
+    local soundId = GetSoundId()
-    if type(coords) == "vector3" or type(coords) == "vector4" then
+    while not soundId do Wait(10) end
-        debugPrint("^6Debug^7: ^2Playing sound from Coord^7: "..formatCoord(coords.xyz))
+    if type(coords) == "vector3" or type(coords) == "vector4" then
-        PlaySoundFromCoord(soundId, sound, coords.x, coords.y, coords.z, bank, synced, range, 0)
+        debugPrint("^6Bridge^7: ^2Playing sound from Coord^7: "..formatCoord(coords.xyz))
-    else
+        PlaySoundFromCoord(soundId, soundRef, coords.x, coords.y, coords.z, soundSet, synced, range, 0)
-        debugPrint("^6Debug^7: ^2Playing sound from Entity^7: ^4"..coords.."^7")
+    else
-        PlaySoundFromEntity(soundId, sound, coords, bank, synced, 0)
+        debugPrint("^6Bridge^7: ^2Playing sound from Entity^7: ^4"..coords.."^7")
-    end
+        PlaySoundFromEntity(soundId, soundRef, coords, soundSet, synced, 1.0)
+    end
+    ReleaseScriptAudioBank(audioBank)
 end

shared/make/makeBlip.lua

@@ -1,119 +1,162 @@
---- Creates a blip at specified coordinates with given properties.
+local blipTable = {}
---
+
--- This function adds a map blip at the provided coordinates and sets various display properties such as sprite, color, scale, and more.
+--- Creates a blip at specified coordinates with given properties.
--- It also handles attaching a preview image to the blip if certain resources are running and a preview is provided.
+--
---
+-- This function adds a map blip at the provided coordinates and sets various display properties such as sprite, color, scale, and more.
----@param data A table containing blip data and properties.
+-- It also handles attaching a preview image to the blip if certain resources are running and a preview is provided.
--- - **coords**: A `vector3` containing x, y, z coordinates where the blip will be placed.
+--
--- - **sprite** (optional): The blip sprite/icon ID. Default is `106`.
+---@param data A table containing blip data and properties.
--- - **col** (optional): The color ID of the blip. Default is `5`.
+-- - **coords**: A `vector3` containing x, y, z coordinates where the blip will be placed.
--- - **scale** (optional): The scale of the blip. Default is `0.7`.
+-- - **sprite** (optional): The blip sprite/icon ID. Default is `106`.
--- - **disp** (optional): The display option of the blip. Default is `6`.
+-- - **col** (optional): The color ID of the blip. Default is `5`.
--- - **category** (optional): The category ID for the blip.
+-- - **scale** (optional): The scale of the blip. Default is `0.7`.
--- - **name**: The name of the blip, used for display on the map.
+-- - **disp** (optional): The display option of the blip. Default is `6`.
--- - **preview** (optional): A URL or image path for a preview image to display with the blip.
+-- - **category** (optional): The category ID for the blip.
---
+-- - **name**: The name of the blip, used for display on the map.
----@return blip blipID The handle of the created blip.
+-- - **preview** (optional): A URL or image path for a preview image to display with the blip.
---
+--
----@usage
+---@return blip blipID The handle of the created blip.
--- ```lua
+--
--- local blipData = {
+---@usage
---     coords = vector3(123.4, 567.8, 90.1),
+-- ```lua
---     sprite = 1,
+-- local blipData = {
---     col = 2,
+--     coords = vector3(123.4, 567.8, 90.1),
---     scale = 0.8,
+--     sprite = 1,
---     disp = 4,
+--     col = 2,
---     category = 7,
+--     scale = 0.8,
---     name = "My Blip",
+--     disp = 4,
---     preview = "http://example.com/preview.png"
+--     category = 7,
--- }
+--     name = "My Blip",
--- local blip = makeBlip(blipData)
+--     preview = "http://example.com/preview.png"
--- ```
+-- }
-function makeBlip(data)
+-- local blip = makeBlip(blipData)
-    local blip = AddBlipForCoord(vec3(data.coords.x, data.coords.y, data.coords.z))
+-- ```
-    SetBlipCoords(blip, data.coords.x, data.coords.y, data.coords.z) -- Manually set blip coordinates again as sometimes it just refuses
+function makeBlip(data)
-    SetBlipAsShortRange(blip, true)
+    local blip = nil
-    SetBlipSprite(blip, data.sprite or 106)
+    if gameName == "rdr3" then
-    SetBlipColour(blip, data.col or 5)
+        blip = BlipAddForCoords(1664425300, data.coords.x, data.coords.y, data.coords.z)
-    SetBlipScale(blip, data.scale or 0.7)
+        SetBlipSprite(blip, data.sprite or `blip_shop_market_stall`)
-    SetBlipDisplay(blip, data.disp or 6)
+        SetBlipScale(blip, data.scale or 0.2)
-    if data.category then SetBlipCategory(blip, data.category) end
+        SetBlipName(blip, data.name)
-    BeginTextCommandSetBlipName('STRING')
+        --BlipSetStyle(blip, data.col or `BLIP_STYLE_CREATOR_DEFAULT`)
-    AddTextComponentString(tostring(data.name))
+    else
-    EndTextCommandSetBlipName(blip)
+        blip = AddBlipForCoord(vec3(data.coords.x, data.coords.y, data.coords.z))
-    -- Handle preview image if certain resources are running
+        SetBlipCoords(blip, data.coords.x, data.coords.y, data.coords.z) -- Manually set blip coordinates again as sometimes it just refuses
-    if isStarted("fs_smallresources") or isStarted("blip_info") or isStarted("blipinfo") then
+        SetBlipAsShortRange(blip, true)
-        if data.preview then
+        SetBlipSprite(blip, data.sprite or 106)
-            local txname = string.gsub(tostring(data.name..'preview'..string.gsub(data.coords.z, "%.", "")), "[ ()~]", "")
+        SetBlipColour(blip, data.col or 5)
-            if data.preview:find("http") or data.preview:find("nui") then
+        SetBlipScale(blip, data.scale or 0.7)
-                createDui(txname, data.preview, vec2(512, 256), scriptTxd)
+        SetBlipDisplay(blip, data.disp or 6)
-            else
+        if data.category then
-                CreateRuntimeTextureFromImage(scriptTxd, txname, data.preview)
+            SetBlipCategory(blip, data.category)
-            end
+        end
-            exports["fs_smallresources"]:SetBlipInfoImage(blip, getScript()..'scriptTxd', txname)
+        BeginTextCommandSetBlipName('STRING')
-            exports["fs_smallresources"]:SetBlipInfoTitle(blip, data.name, false)
+        AddTextComponentString(tostring(data.name))
-        end
+        EndTextCommandSetBlipName(blip)
-    end
+        -- Handle preview image if certain resources are running
-    debugPrint("^6Bridge^7: ^6Blip ^2created^7: '^6"..data.name.."^7' - '"..formatCoord(data.coords).."'")
+        if isStarted("fs_smallresources") or isStarted("blip_info") or isStarted("blipinfo") then
-    return blip
+            if data.preview then
-end
+                local txname = string.gsub(tostring(data.name..'preview'..string.gsub(data.coords.z, "%.", "")), "[ ()~]", "")
-
+                if data.preview:find("http") or data.preview:find("nui") then
---- Creates a blip attached to a specified entity with given properties.
+                    createDui(txname, data.preview, vec2(512, 256), scriptTxd)
---
+                else
--- This function adds a map blip attached to the provided entity and sets various display properties such as sprite, color, scale, and more.
+                    CreateRuntimeTextureFromImage(scriptTxd, txname, data.preview)
--- It also handles attaching a preview image to the blip if certain resources are running and a preview is provided.
+                end
---
+                exports["fs_smallresources"]:SetBlipInfoImage(blip, getScript()..'scriptTxd', txname)
----@param data table A table containing blip data and properties.
+                exports["fs_smallresources"]:SetBlipInfoTitle(blip, data.name, false)
--- - **entity**: The entity to which the blip will be attached.
+            end
--- - **sprite** (optional): The blip sprite/icon ID. Default is `106`.
+        end
--- - **col** (optional): The color ID of the blip. Default is `5`.
+    end
--- - **scale** (optional): The scale of the blip. Default is `0.7`.
+    blipTable[blip] = blip
--- - **disp** (optional): The display option of the blip. Default is `6`.
+
--- - **category** (optional): The category ID for the blip.
+    if DoesBlipExist(blip) then
--- - **name**: The name of the blip, used for display on the map.
+        debugPrint("^6Bridge^7: ^6Blip ^2created^7: '^6"..data.name.."^7' - '"..formatCoord(data.coords).."'")
--- - **preview** (optional): A URL or image path for a preview image to display with the blip.
+    else
---
+        print("Error making blip")
---
+    end
----@return number blipID The handle of the created blip.
+    return blip
----@usage
+end
--- ```lua
+
--- local blipData = {
+--- Creates a blip attached to a specified entity with given properties.
---     entity = myEntity,
+--
---     sprite = 1,
+-- This function adds a map blip attached to the provided entity and sets various display properties such as sprite, color, scale, and more.
---     col = 2,
+-- It also handles attaching a preview image to the blip if certain resources are running and a preview is provided.
---     scale = 0.8,
+--
---     disp = 4,
+---@param data table A table containing blip data and properties.
---     category = 7,
+-- - **entity**: The entity to which the blip will be attached.
---     name = "Entity Blip",
+-- - **sprite** (optional): The blip sprite/icon ID. Default is `106`.
---     preview = "http://example.com/preview.png"
+-- - **col** (optional): The color ID of the blip. Default is `5`.
--- }
+-- - **scale** (optional): The scale of the blip. Default is `0.7`.
--- local blip = makeEntityBlip(blipData)
+-- - **disp** (optional): The display option of the blip. Default is `6`.
--- ```
+-- - **category** (optional): The category ID for the blip.
-function makeEntityBlip(data)
+-- - **name**: The name of the blip, used for display on the map.
-    AddBlipForEntity(data.entity)
+-- - **preview** (optional): A URL or image path for a preview image to display with the blip.
-    local blip = GetBlipFromEntity(data.entity)
+--
-    SetBlipAsShortRange(blip, true)
+--
-    SetBlipSprite(blip, data.sprite or 106)
+---@return number blipID The handle of the created blip.
-    SetBlipColour(blip, data.col or 5)
+---@usage
-    SetBlipScale(blip, data.scale or 0.7)
+-- ```lua
-    SetBlipDisplay(blip, data.disp or 6)
+-- local blipData = {
-    if data.category then SetBlipCategory(blip, data.category) end
+--     entity = myEntity,
-    BeginTextCommandSetBlipName('STRING')
+--     sprite = 1,
-    AddTextComponentString(tostring(data.name))
+--     col = 2,
-    EndTextCommandSetBlipName(blip)
+--     scale = 0.8,
-    -- Handle preview image if certain resources are running
+--     disp = 4,
-    if isStarted("fs_smallresources") or isStarted("blip-info") or isStarted("blipinfo") then
+--     category = 7,
-        if data.preview then
+--     name = "Entity Blip",
-            local txname = string.gsub(tostring(data.name..'preview'), "[ ()~]", "")
+--     preview = "http://example.com/preview.png"
-            if data.preview:find("http") or data.preview:find("nui") then
+-- }
-                createDui(txname, data.preview, vec2(512, 256), scriptTxd)
+-- local blip = makeEntityBlip(blipData)
-            else
+-- ```
-                CreateRuntimeTextureFromImage(scriptTxd, txname, data.preview)
+function makeEntityBlip(data)
-            end
+    local blip = nil
-            exports["fs_smallresources"]:SetBlipInfoImage(blip, getScript()..'previewTxd', txname)
+    if gameName == "rdr3" then
-            exports["fs_smallresources"]:SetBlipInfoTitle(blip, data.name, false)
+        blip = BlipAddForEntity(1664425300, data.entity)
-        end
+        SetBlipSprite(blip, data.sprite or `blip_ambient_coach`)
-    end
+        SetBlipScale(blip, data.scale or 0.2)
-    debugPrint("^6Bridge^7: ^6Blip ^2created for Entity^7: '^6"..data.name.."^7'")
+        SetBlipName(blip, data.name)
-    return blip
+
+    else
+        AddBlipForEntity(data.entity)
+        blip = GetBlipFromEntity(data.entity)
+        blipTable[blip] = blip
+        SetBlipAsShortRange(blip, true)
+        SetBlipSprite(blip, data.sprite or 106)
+        SetBlipColour(blip, data.col or 5)
+        SetBlipScale(blip, data.scale or 0.7)
+        SetBlipDisplay(blip, data.disp or 6)
+        if data.category then SetBlipCategory(blip, data.category) end
+        BeginTextCommandSetBlipName('STRING')
+        AddTextComponentString(tostring(data.name))
+        EndTextCommandSetBlipName(blip)
+        -- Handle preview image if certain resources are running
+        if isStarted("fs_smallresources") or isStarted("blip-info") or isStarted("blipinfo") then
+            if data.preview then
+                local txname = string.gsub(tostring(data.name..'preview'), "[ ()~]", "")
+                if data.preview:find("http") or data.preview:find("nui") then
+                    createDui(txname, data.preview, vec2(512, 256), scriptTxd)
+                else
+                    CreateRuntimeTextureFromImage(scriptTxd, txname, data.preview)
+                end
+                exports["fs_smallresources"]:SetBlipInfoImage(blip, getScript()..'previewTxd', txname)
+                exports["fs_smallresources"]:SetBlipInfoTitle(blip, data.name, false)
+            end
+        end
+    end
+    blipTable[blip] = blip
+
+    if DoesBlipExist(blip) then
+        debugPrint("^6Bridge^7: ^6Blip ^2created for Entity^7: '^6"..data.name.."^7'")
+    else
+        print("Error making blip")
+    end
+    return blip
+end
+
+if gameName == "rdr3" then
+    onResourceStop(function()
+        for k in pairs(blipTable) do
+            RemoveBlip(k)
+        end
+    end, true)
 end

shared/make/makePed.lua

@@ -1,230 +1,246 @@
---- A table to keep track of all created Peds.
+--- A table to keep track of all created Peds.
-local Peds = {}
+local Peds = {}
-
+
---- Creates a distance-based Ped (pedestrian) that spawns when the player enters a specified area.
+--- Creates a distance-based Ped (pedestrian) that spawns when the player enters a specified area.
---
+--
--- This function sets up a circular area using `createCirclePoly`. When the player enters this area, a Ped is created using `makePed`.
+-- This function sets up a circular area using `createCirclePoly`. When the player enters this area, a Ped is created using `makePed`.
--- When the player exits the area, the Ped is deleted.
+-- When the player exits the area, the Ped is deleted.
---
+--
----@param data table A table containing Ped data and properties. Should include at least `model` and `coords`.
+---@param data table A table containing Ped data and properties. Should include at least `model` and `coords`.
----@param coords vector4 A `vector3` or `vector4` specifying the coordinates where the Ped will be placed.
+---@param coords vector4 A `vector3` or `vector4` specifying the coordinates where the Ped will be placed.
----@param freeze boolean (optional) Boolean indicating whether the Ped should be frozen in place. Default is `true`.
+---@param freeze boolean (optional) Boolean indicating whether the Ped should be frozen in place. Default is `true`.
----@param collision boolean (optional) Boolean indicating whether collision with the Ped is enabled. Default is `false`.
+---@param collision boolean (optional) Boolean indicating whether collision with the Ped is enabled. Default is `false`.
----@param scenario boolean (optional) String specifying the scenario the Ped should perform.
+---@param scenario boolean (optional) String specifying the scenario the Ped should perform.
----@param anim table (optional) A table containing animation dictionary and name `{animDict, animName}`.
+---@param anim table (optional) A table containing animation dictionary and name `{animDict, animName}`.
----@param synced boolean (optional) Boolean indicating whether the Ped is synced across clients. Default is `false`.
+---@param synced boolean (optional) Boolean indicating whether the Ped is synced across clients. Default is `false`.
---
+--
----@usage
+---@usage
--- ```lua
+-- ```lua
--- makeDistPed(pedData, pedCoords, true, false, 'WORLD_HUMAN_STAND_IMPATIENT', nil, true)
+-- makeDistPed(pedData, pedCoords, true, false, 'WORLD_HUMAN_STAND_IMPATIENT', nil, true)
--- ```
+-- ```
-function makeDistPed(data, coords, freeze, collision, scenario, anim, synced)
+function makeDistPed(data, coords, freeze, collision, scenario, anim, synced)
-    createCirclePoly({
+    local zoneCoords = type(data) == "table" and data.coords or coords
-        name = keyGen()..keyGen(),
+    local randName = keyGen()..keyGen()
-        coords = vec3(data.coords.x, data.coords.y, data.coords.z - 1.03),
+    createCirclePoly({
-        radius = 50.0,
+        name = randName,
-        onEnter = function()
+        coords = vec3(zoneCoords.x, zoneCoords.y, zoneCoords.z - 1.03),
-            Peds[#Peds + 1] = makePed(data, coords, freeze, collision, scenario, anim, synced)
+        radius = 50.0,
-        end,
+        onEnter = function()
-        onExit = function()
+            Peds[randName] = makePed(data, coords, freeze, collision, scenario, anim, synced)
-            DeletePed(Peds[#Peds])
+        end,
-        end,
+        onExit = function()
-        debug = debugMode,
+            DeletePed(Peds[randName])
-    })
+        end,
-end
+        debug = debugMode,
-
+    })
---- Creates a Ped (pedestrian character) with specified properties.
+end
---
+
--- This function creates a Ped at the given coordinates and applies appearance and clothing based on the provided data.
+--- Creates a Ped (pedestrian character) with specified properties.
---
+--
--- If `data` is a table with `custom` properties, it customizes the Ped's appearance accordingly.
+-- This function creates a Ped at the given coordinates and applies appearance and clothing based on the provided data.
---
+--
----@param data modelHash|table Either a string/model hash of the Ped model to use, or a table containing `model` and `custom` data.
+-- If `data` is a table with `custom` properties, it customizes the Ped's appearance accordingly.
----@param coords vector4 `vector3` or `vector4` specifying the coordinates where the Ped will be placed.
+--
----@param freeze boolean (optional) Boolean indicating whether the Ped should be frozen in place. Default is `true`.
+---@param data modelHash|table Either a string/model hash of the Ped model to use, or a table containing `model` and `custom` data.
----@param collision boolean (optional) Boolean indicating whether collision with the Ped is enabled. Default is `false`.
+---@param coords vector4 `vector3` or `vector4` specifying the coordinates where the Ped will be placed.
----@param scenario string (optional) String specifying the scenario the Ped should perform.
+---@param freeze boolean (optional) Boolean indicating whether the Ped should be frozen in place. Default is `true`.
----@param anim table (optional) A table containing animation dictionary and name `{animDict, animName}`.
+---@param collision boolean (optional) Boolean indicating whether collision with the Ped is enabled. Default is `false`.
----@param synced boolean (optional) Boolean indicating whether the Ped is synced across clients. Default is `false`.
+---@param scenario string (optional) String specifying the scenario the Ped should perform.
---
+---@param anim table (optional) A table containing animation dictionary and name `{animDict, animName}`.
----@return ped entityID The handle of the created Ped.
+---@param synced boolean (optional) Boolean indicating whether the Ped is synced across clients. Default is `false`.
---
+--
----@usage
+---@return ped entityID The handle of the created Ped.
--- ```lua
+--
--- local ped = makePed(pedData, pedCoords, true, false, nil, {'animDict', 'animName'}, true)
+---@usage
--- ```
+-- ```lua
-function makePed(data, coords, freeze, collision, scenario, anim, synced)
+-- local ped = makePed(pedData, pedCoords, true, false, nil, {'animDict', 'animName'}, true)
-    local ped = nil
+-- ```
-    local model = nil
+function makePed(data, coords, freeze, collision, scenario, anim, synced)
-    if type(data) == "table" then
+    local ped = nil
-        model = data.model
+    local model = nil
-        loadModel(data.model)
+    if type(data) == "table" then
-        ped = CreatePed(0, model, coords.x, coords.y, coords.z - 1.03, coords.w, synced and synced or false, false)
+        model = data.model
-
+        loadModel(data.model)
-        -- Inheritance
+        ped = CreatePed(0, model, coords.x, coords.y, coords.z - 1.03, coords.w, synced and synced or false, false)
-        SetPedHeadBlendData(ped, data.custom.faceFather, data.custom.faceMother, data.custom.raceShape, data.custom.skinFather, data.custom.skinMother, data.custom.raceSkin, data.custom.faceMix or 0, data.custom.skinMix or 0, data.custom.raceMix or 0, false)
+
-
+        -- Inheritance
-        -- Face Features
+        SetPedHeadBlendData(ped, data.custom.faceFather, data.custom.faceMother, data.custom.raceShape, data.custom.skinFather, data.custom.skinMother, data.custom.raceSkin, data.custom.faceMix or 0, data.custom.skinMix or 0, data.custom.raceMix or 0, false)
-        for k, v in pairs({
+
-            "noseWidth", "noseHeight", "noseSize", "noseBoneHeight", "nosePeakHeight", "noseBoneTwist",
+        -- Face Features
-            "eyebrowHeight", "eyebrowDepth",
+        for k, v in pairs({
-            "cheekBoneHeight", "cheekBoneWidth", "cheeckWidth",
+            "noseWidth", "noseHeight", "noseSize", "noseBoneHeight", "nosePeakHeight", "noseBoneTwist",
-            "eyeOpening", "lipThickness",
+            "eyebrowHeight", "eyebrowDepth",
-            "jawWidth", "jawSize",
+            "cheekBoneHeight", "cheekBoneWidth", "cheeckWidth",
-            "chinLowering", "chinLength", "chinSize", "chinHole",
+            "eyeOpening", "lipThickness",
-            "neckThickness"
+            "jawWidth", "jawSize",
-        }) do
+            "chinLowering", "chinLength", "chinSize", "chinHole",
-            SetPedFaceFeature(ped, k - 1, data.custom[v])
+            "neckThickness"
-        end
+        }) do
-
+            SetPedFaceFeature(ped, k - 1, data.custom[v])
-        -- Appearance
+        end
-        SetPedComponentVariation(ped, 2, data.custom.Hair, 0, 0)
+
-        SetPedHairColor(ped, data.custom.HairTexture, data.custom.HairHighlight or 0)
+        -- Appearance
-        SetPedHeadOverlay(ped, 2, data.custom.Eyebrows, data.custom.EyebrowsOpacity)
+        SetPedComponentVariation(ped, 2, data.custom.Hair, 0, 0)
-        SetPedHeadOverlayColor(ped, 2, 1, data.custom.EyebrowsColor, 0)
+        SetPedHairColor(ped, data.custom.HairTexture, data.custom.HairHighlight or 0)
-        SetPedEyeColor(ped, data.custom.Eyecolor)
+        SetPedHeadOverlay(ped, 2, data.custom.Eyebrows, data.custom.EyebrowsOpacity)
-        SetPedHeadOverlay(ped, 4, data.custom.Makeup, data.custom.MakeupOpacity)
+        SetPedHeadOverlayColor(ped, 2, 1, data.custom.EyebrowsColor, 0)
-        SetPedHeadOverlayColor(ped, 4, 1, data.custom.MakeupColor, 0)
+        SetPedEyeColor(ped, data.custom.Eyecolor)
-        SetPedHeadOverlay(ped, 8, data.custom.Lipstick, data.custom.LipstickOpacity)
+        SetPedHeadOverlay(ped, 4, data.custom.Makeup, data.custom.MakeupOpacity)
-        SetPedHeadOverlayColor(ped, 8, 1, data.custom.LipstickColor, 0)
+        SetPedHeadOverlayColor(ped, 4, 1, data.custom.MakeupColor, 0)
-        SetPedHeadOverlay(ped, 1, data.custom.Beard, data.custom.BeardOpacity)
+        SetPedHeadOverlay(ped, 8, data.custom.Lipstick, data.custom.LipstickOpacity)
-        SetPedHeadOverlayColor(ped, 1, 1, data.custom.BeardColor, 0)
+        SetPedHeadOverlayColor(ped, 8, 1, data.custom.LipstickColor, 0)
-
+        SetPedHeadOverlay(ped, 1, data.custom.Beard, data.custom.BeardOpacity)
-        -- Clothes
+        SetPedHeadOverlayColor(ped, 1, 1, data.custom.BeardColor, 0)
-        SetPedComponentVariation(ped, 1, data.custom.Mask, data.custom.MaskVariant, 0)
+
-        SetPedComponentVariation(ped, 7, data.custom.Scarf, data.custom.ScarfVariant, 0)
+        -- Clothes
-        SetPedComponentVariation(ped, 11, data.custom.Jacket, data.custom.JacketVariant, 0)
+        SetPedComponentVariation(ped, 1, data.custom.Mask, data.custom.MaskVariant, 0)
-        SetPedComponentVariation(ped, 8, data.custom.Shirt, data.custom.ShirtVariant, 0)
+        SetPedComponentVariation(ped, 7, data.custom.Scarf, data.custom.ScarfVariant, 0)
-        SetPedComponentVariation(ped, 9, data.custom.Vest, data.custom.VestVariant, 0)
+        SetPedComponentVariation(ped, 11, data.custom.Jacket, data.custom.JacketVariant, 0)
-        SetPedComponentVariation(ped, 5, data.custom.Bags, data.custom.BagsVariant, 0)
+        SetPedComponentVariation(ped, 8, data.custom.Shirt, data.custom.ShirtVariant, 0)
-        SetPedComponentVariation(ped, 3, data.custom.Arms, data.custom.ArmsVariant, 0)
+        SetPedComponentVariation(ped, 9, data.custom.Vest, data.custom.VestVariant, 0)
-        SetPedComponentVariation(ped, 4, data.custom.Pants, data.custom.PantsVariant, 0)
+        SetPedComponentVariation(ped, 5, data.custom.Bags, data.custom.BagsVariant, 0)
-        SetPedComponentVariation(ped, 6, data.custom.Shoes, data.custom.ShoesVariant, 0)
+        SetPedComponentVariation(ped, 3, data.custom.Arms, data.custom.ArmsVariant, 0)
-        SetPedComponentVariation(ped, 10, data.custom.Decal, data.custom.DecalVariant, 0)
+        SetPedComponentVariation(ped, 4, data.custom.Pants, data.custom.PantsVariant, 0)
-
+        SetPedComponentVariation(ped, 6, data.custom.Shoes, data.custom.ShoesVariant, 0)
-        -- Accessories
+        SetPedComponentVariation(ped, 10, data.custom.Decal, data.custom.DecalVariant, 0)
-        SetPedPropIndex(ped, 0, data.custom.Hat, data.custom.HatVariant, true)
+
-        SetPedPropIndex(ped, 1, data.custom.Glasses, data.custom.GlassesVariant, true)
+        -- Accessories
-
+        SetPedPropIndex(ped, 0, data.custom.Hat, data.custom.HatVariant, true)
-        SetPedPropIndex(ped, 2, data.custom.Ear, data.custom.EarVariant, true)
+        SetPedPropIndex(ped, 1, data.custom.Glasses, data.custom.GlassesVariant, true)
-        SetPedPropIndex(ped, 6, data.custom.Watches, data.custom.WatchesVariant, true)
+
-        SetPedPropIndex(ped, 7, data.custom.Bracelets, data.custom.BraceletsVariant, true)
+        SetPedPropIndex(ped, 2, data.custom.Ear, data.custom.EarVariant, true)
-    else
+        SetPedPropIndex(ped, 6, data.custom.Watches, data.custom.WatchesVariant, true)
-        model = data
+        SetPedPropIndex(ped, 7, data.custom.Bracelets, data.custom.BraceletsVariant, true)
-        loadModel(model)
+    else
-        ped = CreatePed(0, model, coords.x, coords.y, coords.z - 1.03, coords.w, synced or false, false)
+        model = data
-    end
+        loadModel(model)
-
+        if gameName == "rdr3" then
-    SetEntityInvincible(ped, true)
+            ped = CreatePed(model, coords.x, coords.y, coords.z - 1.03, coords.w, synced or false, false)
-    SetBlockingOfNonTemporaryEvents(ped, true)
+            SetEntityVisible(ped, 1) -- SetEntityVisible
-	FreezeEntityPosition(ped, freeze and freeze or true)
+            SetEntityAlpha(ped, 255, false) -- SetEntityAlpha
-
+            SetRandomOutfitVariation(ped, true) -- Invisible without
-    if collision then SetEntityNoCollisionEntity(ped, PlayerPedId(), false) end
+        else
-    if scenario then TaskStartScenarioInPlace(ped, scenario, 0, true) end
+            ped = CreatePed(0, model, coords.x, coords.y, coords.z - 1.03, coords.w, synced or false, false)
-    if anim then
+        end
-        loadAnimDict(anim[1])
+    end
-        TaskPlayAnim(ped, anim[1], anim[2], 0.5, 1.0, -1, 1, 0.2, 0, 0, 0)
+
-    end
+    SetEntityInvincible(ped, true)
-
+    SetBlockingOfNonTemporaryEvents(ped, true)
-    debugPrint("^6Bridge^7: ^1Ped ^2Created^7: '^6"..ped.."^7' | ^2Hash^7: ^7'^5"..(model).."^7' | ^2Coord^7: "..formatCoord(coords))
+	FreezeEntityPosition(ped, freeze and freeze or true)
-    unloadModel(model)
+
-    Peds[#Peds + 1] = ped
+    if collision then SetEntityNoCollisionEntity(ped, PlayerPedId(), false) end
-    return ped
+    if scenario then TaskStartScenarioInPlace(ped, scenario, 0, true) end
-end
+    if anim then
-
+        loadAnimDict(anim[1])
---- Generates random Ped data by filling in missing customization options with random values.
+        TaskPlayAnim(ped, anim[1], anim[2], 0.5, 1.0, -1, 1, 0.2, 0, 0, 0)
---
+    end
--- This function takes in a data table that may have some customization options missing in `data.custom`.
+    if DoesEntityExist(ped) then
---
+        debugPrint("^6Bridge^7: ^1Ped ^2Created^7: '^6"..ped.."^7' | ^2Hash^7: ^7'^5"..(model).."^7' | ^2Coord^7: "..formatCoord(coords))
--- It generates random values for any missing options and returns a new data table with complete customization.
+    else
---
+        print("error ped")
----@param data table A table containing at least a `model` field, and possibly a `custom` table with customization options.
+    end
---
+    unloadModel(model)
----@return generatedTable table A new table containing `model` and `custom` with all customization options filled.
+    Peds[keyGen()..keyGen()] = ped
---
+    return ped
----@usage
+end
--- ```lua
+
--- local pedData = GenerateRandomPedData({ model = `MP_M_Freemode_01`, custom = {} })
+--- Generates random Ped data by filling in missing customization options with random values.
--- ```
+--
-function GenerateRandomPedData(data)
+-- This function takes in a data table that may have some customization options missing in `data.custom`.
-    local newTable = {
+--
-        model = data.model,
+-- It generates random values for any missing options and returns a new data table with complete customization.
-        custom = {},
+--
-    }
+---@param data table A table containing at least a `model` field, and possibly a `custom` table with customization options.
-    local isMale = data.model == `MP_M_Freemode_01`
+--
-    local randomTable = {
+---@return generatedTable table A new table containing `model` and `custom` with all customization options filled.
-        -- Inheritance
+--
-        faceFather = math.random(0, 45), faceMother = math.random(0, 45), faceMix = (math.random(0, 9) / 10),
+---@usage
-        skinFather = math.random(0, 45), skinMother = math.random(0, 45), skinMix = (math.random(0, 9) / 10),
+-- ```lua
-        raceShape = math.random(0, 45), raceSkin = math.random(0, 45), raceMix = (math.random(0, 9) / 10),
+-- local pedData = GenerateRandomPedData({ model = `MP_M_Freemode_01`, custom = {} })
-
+-- ```
-        -- Face Features
+function GenerateRandomPedData(data)
-        noseWidth = (math.random(0, 9) / 10),
+    local newTable = {
-        noseHeight = (math.random(0, 9) / 10),
+        model = data.model,
-        noseSize = (math.random(0, 9) / 10),
+        custom = {},
-        noseBoneHeight = (math.random(0, 9) / 10),
+    }
-        nosePeakHeight = (math.random(0, 9) / 10),
+    local isMale = data.model == `MP_M_Freemode_01`
-        noseBoneTwist = (math.random(0, 9) / 10),
+    local randomTable = {
-
+        -- Inheritance
-        eyebrowHeight = (math.random(0, 9) / 10),
+        faceFather = math.random(0, 45), faceMother = math.random(0, 45), faceMix = (math.random(0, 9) / 10),
-        eyebrowDepth = (math.random(0, 9) / 10),
+        skinFather = math.random(0, 45), skinMother = math.random(0, 45), skinMix = (math.random(0, 9) / 10),
-
+        raceShape = math.random(0, 45), raceSkin = math.random(0, 45), raceMix = (math.random(0, 9) / 10),
-        cheekBoneHeight = (math.random(0, 9) / 10),
+
-        cheekBoneWidth = (math.random(0, 9) / 10),
+        -- Face Features
-        cheeckWidth = (math.random(0, 9) / 10),
+        noseWidth = (math.random(0, 9) / 10),
-
+        noseHeight = (math.random(0, 9) / 10),
-        eyeOpening = (math.random(0, 9) / 10),
+        noseSize = (math.random(0, 9) / 10),
-        lipThickness = (math.random(0, 9) / 10),
+        noseBoneHeight = (math.random(0, 9) / 10),
-
+        nosePeakHeight = (math.random(0, 9) / 10),
-        jawWidth = (math.random(0, 9) / 10),
+        noseBoneTwist = (math.random(0, 9) / 10),
-        jawSize = (math.random(0, 9) / 10),
+
-
+        eyebrowHeight = (math.random(0, 9) / 10),
-        chinLowering = (math.random(0, 9) / 10),
+        eyebrowDepth = (math.random(0, 9) / 10),
-        chinLength = (math.random(0, 9) / 10),
+
-        chinSize = (math.random(0, 9) / 10),
+        cheekBoneHeight = (math.random(0, 9) / 10),
-        chinHole = (math.random(0, 9) / 10),
+        cheekBoneWidth = (math.random(0, 9) / 10),
-
+        cheeckWidth = (math.random(0, 9) / 10),
-        neckThickness = (math.random(0, 9) / 10),
+
-
+        eyeOpening = (math.random(0, 9) / 10),
-        -- Appearance
+        lipThickness = (math.random(0, 9) / 10),
-        Hair = math.random(0, isMale and 147 or 261), HairTexture = math.random(0, 63), HairHighlight = math.random(0, 63),
+
-        Eyebrows = math.random(0, 33),
+        jawWidth = (math.random(0, 9) / 10),
-        EyebrowsOpacity = 0.9, EyebrowsColor = 0,
+        jawSize = (math.random(0, 9) / 10),
-        Eyecolor = math.random(0, 30),
+
-        Makeup = 0, MakeupOpacity = 0, MakeupColor = 0,
+        chinLowering = (math.random(0, 9) / 10),
-        Lipstick = 0, LipstickOpacity = 0, LipstickColor = 0,
+        chinLength = (math.random(0, 9) / 10),
-        Beard = isMale and math.random(0, 28) or -1,
+        chinSize = (math.random(0, 9) / 10),
-        BeardOpacity = isMale and 0.9 or 0.0, BeardColor = 0,
+        chinHole = (math.random(0, 9) / 10),
-
+
-        -- Clothing
+        neckThickness = (math.random(0, 9) / 10),
-        Mask = math.random(0, 252), MaskVariant = 0,
+
-        Scarf = math.random(0, isMale and 249 or 198), ScarfVariant = 0,
+        -- Appearance
-        Jacket = math.random(0, isMale and 634 or 713), JacketVariant = 0,
+        Hair = math.random(0, isMale and 147 or 261), HairTexture = math.random(0, 63), HairHighlight = math.random(0, 63),
-        Shirt = math.random(0, isMale and 237 or 299), ShirtVariant = 0,
+        Eyebrows = math.random(0, 33),
-        Vest = math.random(0, isMale and 81 or 91), VestVariant = 0,
+        EyebrowsOpacity = 0.9, EyebrowsColor = 0,
-        Bags = math.random(0, isMale and 138 or 148), BagsVariant = 0,
+        Eyecolor = math.random(0, 30),
-        Arms = math.random(0, isMale and 224 or 261), ArmsVariant = 0,
+        Makeup = 0, MakeupOpacity = 0, MakeupColor = 0,
-        Pants = math.random(0, isMale and 255 or 275), PantsVariant = 0,
+        Lipstick = 0, LipstickOpacity = 0, LipstickColor = 0,
-        Shoes = math.random(0, isMale and 157 or 199), ShoesVariant = 0,
+        Beard = isMale and math.random(0, 28) or -1,
-        Decal = math.random(0, isMale and 238 or 253), DecalVariant = 0,
+        BeardOpacity = isMale and 0.9 or 0.0, BeardColor = 0,
-
+
-        -- Accessories
+        -- Clothing
-        Hat = math.random(0, isMale and 232 or 229), HatVariant = 0,
+        Mask = math.random(0, 252), MaskVariant = 0,
-        Glasses = math.random(0, isMale and 68 or 71), GlassesVariant = 0,
+        Scarf = math.random(0, isMale and 249 or 198), ScarfVariant = 0,
-        Ear = math.random(0, isMale and 51 or 40), EarVariant = 0,
+        Jacket = math.random(0, isMale and 634 or 713), JacketVariant = 0,
-        Watches = math.random(0, isMale and 46 or 35), WatchesVariant = 0,
+        Shirt = math.random(0, isMale and 237 or 299), ShirtVariant = 0,
-        Bracelets = math.random(0, isMale and 13 or 20), BraceletsVariant = 0,
+        Vest = math.random(0, isMale and 81 or 91), VestVariant = 0,
-    }
+        Bags = math.random(0, isMale and 138 or 148), BagsVariant = 0,
-    for option in pairs(randomTable) do
+        Arms = math.random(0, isMale and 224 or 261), ArmsVariant = 0,
-        if not data.custom[option] then
+        Pants = math.random(0, isMale and 255 or 275), PantsVariant = 0,
-            newTable.custom[option] = randomTable[option]
+        Shoes = math.random(0, isMale and 157 or 199), ShoesVariant = 0,
-            debugPrint("^6Bridge^7: ^2Picking Random Ped option ^7[^5"..option.."^7]: ^6"..newTable.custom[option].."^7")
+        Decal = math.random(0, isMale and 238 or 253), DecalVariant = 0,
-        else
+
-            newTable.custom[option] = data.custom[option]
+        -- Accessories
-        end
+        Hat = math.random(0, isMale and 232 or 229), HatVariant = 0,
-    end
+        Glasses = math.random(0, isMale and 68 or 71), GlassesVariant = 0,
-    return newTable
+        Ear = math.random(0, isMale and 51 or 40), EarVariant = 0,
-end
+        Watches = math.random(0, isMale and 46 or 35), WatchesVariant = 0,
-
+        Bracelets = math.random(0, isMale and 13 or 20), BraceletsVariant = 0,
---- Cleans up all created Peds when the resource stops.
+    }
-onResourceStop(function() for i = 1, #Peds do DeletePed(Peds[i]) end end, true)
+    for option in pairs(randomTable) do
+        if not data.custom[option] then
+            newTable.custom[option] = randomTable[option]
+            debugPrint("^6Bridge^7: ^2Picking Random Ped option ^7[^5"..option.."^7]: ^6"..newTable.custom[option].."^7")
+        else
+            newTable.custom[option] = data.custom[option]
+        end
+    end
+    return newTable
+end
+
+--- Cleans up all created Peds when the resource stops.
+onResourceStop(function()
+    for k in pairs(Peds) do
+        DeletePed(Peds[k])
+    end
+end, true)

shared/make/makeProp.lua

@@ -1,90 +1,94 @@
-local Props = {}
+local Props = {}
-
+
---- Creates a prop (object) in the game world at specified coordinates.
+--- Creates a prop (object) in the game world at specified coordinates.
----
+---
---- This function loads the model, creates the object, sets its heading, and freezes it if specified.
+--- This function loads the model, creates the object, sets its heading, and freezes it if specified.
----
+---
----@param data table A table containing prop data.
+---@param data table A table containing prop data.
---- - **prop** `string`: The model name or hash of the prop to create.
+--- - **prop** `string`: The model name or hash of the prop to create.
---- - **coords** `vector4`: The coordinates where the prop will be placed. Should include x, y, z, and w (heading).
+--- - **coords** `vector4`: The coordinates where the prop will be placed. Should include x, y, z, and w (heading).
----@param freeze boolean (optional) Whether to freeze the prop in place. Defaults to `false`.
+---@param freeze boolean (optional) Whether to freeze the prop in place. Defaults to `false`.
----@param synced boolean (optional) Whether the prop should be synced across clients. Defaults to `false`.
+---@param synced boolean (optional) Whether the prop should be synced across clients. Defaults to `false`.
----
+---
----@return number entityID The handle of the created prop object.
+---@return number entityID The handle of the created prop object.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- local propData = {
+--- local propData = {
----     prop = 'prop_chair_01a',
+---     prop = 'prop_chair_01a',
----     coords = vector4(123.4, 567.8, 90.1, 180.0)
+---     coords = vector4(123.4, 567.8, 90.1, 180.0)
---- }
+--- }
---- local prop = makeProp(propData, true, false)
+--- local prop = makeProp(propData, true, false)
---- ```
+--- ```
-function makeProp(data, freeze, synced)
+function makeProp(data, freeze, synced)
-    loadModel(data.prop)
+    loadModel(data.prop)
-    local prop = CreateObject(data.prop, data.coords.x, data.coords.y, data.coords.z-1.03, synced and synced or false, synced and synced or false, false)
+    local prop = CreateObject(data.prop, data.coords.x, data.coords.y, data.coords.z-1.03, synced and synced or false, synced and synced or false, false)
-    SetEntityHeading(prop, data.coords.w + 180.0)
+    SetEntityHeading(prop, (data.coords.w or 0) + 180.0)
-    FreezeEntityPosition(prop, freeze or false)
+    FreezeEntityPosition(prop, freeze or false)
-
+
-    debugPrint("^6Bridge^7: ^1Prop ^2Created^7: '^6"..prop.."^7' | ^2Hash^7: ^7'^6"..data.prop.."^7' | ^2Coord^7: "..formatCoord(data.coords))
+    debugPrint("^6Bridge^7: ^1Prop ^2Created^7: '^6"..prop.."^7' | ^2Hash^7: ^7'^6"..data.prop.."^7' | ^2Coord^7: "..formatCoord(data.coords))
-    SetModelAsNoLongerNeeded(data.prop)
+    SetModelAsNoLongerNeeded(data.prop)
-    Props[#Props + 1] = prop
+    Props[keyGen()..keyGen()] = prop
-    return prop
+    return prop
-end
+end
-
+
---- Creates a prop that appears when the player is within a certain distance.
+--- Creates a prop that appears when the player is within a certain distance.
----
+---
---- This function sets up a proximity area, and when the player enters it, the prop is created.
+--- This function sets up a proximity area, and when the player enters it, the prop is created.
---- When the player exits the area, the prop is destroyed.
+--- When the player exits the area, the prop is destroyed.
----
+---
----@param data table A table containing prop data.
+---@param data table A table containing prop data.
---- - **prop** `string`: The model name or hash of the prop to create.
+--- - **prop** `string`: The model name or hash of the prop to create.
---- - **coords** `vector4`: The coordinates where the prop will be placed. Should include x, y, z, and w (heading).
+--- - **coords** `vector4`: The coordinates where the prop will be placed. Should include x, y, z, and w (heading).
----@param freeze boolean (optional) Whether to freeze the prop in place. Defaults to `false`.
+---@param freeze boolean (optional) Whether to freeze the prop in place. Defaults to `false`.
----@param synced boolean (optional) Whether the prop should be synced across clients. Defaults to `false`.
+---@param synced boolean (optional) Whether the prop should be synced across clients. Defaults to `false`.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- local propData = {
+--- local propData = {
----     prop = 'prop_chair_01a',
+---     prop = 'prop_chair_01a',
----     coords = vector4(123.4, 567.8, 90.1, 180.0)
+---     coords = vector4(123.4, 567.8, 90.1, 180.0)
---- }
+--- }
---- makeDistProp(propData, true, false)
+--- makeDistProp(propData, true, false)
---- ```
+--- ```
-function makeDistProp(data, freeze, synced)
+function makeDistProp(data, freeze, synced, range)
-    local prop = nil
+    local name = keyGen()..keyGen()
-    createCirclePoly({
+    createCirclePoly({
-        name = keyGen()..keyGen(),
+        name = name,
-        coords = vec3(data.coords.x, data.coords.y, data.coords.z - 1.03),
+        coords = vec3(data.coords.x, data.coords.y, data.coords.z - 1.03),
-        radius = 50.0,
+        radius = range or 50.0,
-        onEnter = function()
+        onEnter = function()
-            prop = makeProp(data, freeze, synced)
+            Props[name] = makeProp(data, freeze, synced)
-        end,
+        end,
-        onExit = function()
+        onExit = function()
-            destroyProp(prop)
+            destroyProp(Props[name])
-        end,
+        end,
-        debug = debugMode,
+        debug = debugMode,
-    })
+    })
-end
+end
-
+
---- Destroys a prop, detaching it if attached to the player beforehand.
+--- Destroys a prop, detaching it if attached to the player beforehand.
----
+---
----@param entity number The handle of the prop entity to destroy.
+---@param entity number The handle of the prop entity to destroy.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- destroyProp(prop)
+--- destroyProp(prop)
---- ```
+--- ```
-function destroyProp(entity)
+function destroyProp(entity)
-    if entity then
+    if entity then
-        debugPrint("^6Bridge^7: ^2Destroying Prop^7: '^6"..entity.."^7'")
+        debugPrint("^6Bridge^7: ^2Destroying Prop^7: '^6"..entity.."^7'")
-        if IsEntityAttachedToEntity(entity, PlayerPedId()) then
+        if IsEntityAttachedToEntity(entity, PlayerPedId()) then
-            SetEntityAsMissionEntity(entity)
+            SetEntityAsMissionEntity(entity)
-            DetachEntity(entity, true, true)
+            DetachEntity(entity, true, true)
-        end
+        end
-        DeleteObject(entity)
+        DeleteObject(entity)
-    end
+    end
-end
+end
-
+
---- Cleans up all created props when the resource stops.
+--- Cleans up all created props when the resource stops.
-onResourceStop(function() for i = 1, #Props do destroyProp(Props[i]) end end, true)
+onResourceStop(function()
+    for k in pairs(Props) do
+        destroyProp(Props[k])
+    end
+end, true)

shared/make/makeVeh.lua

@@ -1,73 +1,107 @@
-local Vehicles = {}
+local Vehicles = {}
-
+
---- Creates a vehicle with the specified model and coordinates.
+--- Creates a vehicle with the specified model and coordinates.
----
+---
---- This function loads the vehicle model, creates the vehicle in the world at the given coordinates, sets initial properties, and returns the vehicle handle.
+--- This function loads the vehicle model, creates the vehicle in the world at the given coordinates, sets initial properties, and returns the vehicle handle.
----
+---
----@param model string|number The model name or hash of the vehicle to create.
+---@param model string|number The model name or hash of the vehicle to create.
----@param coords vector4 The coordinates where the vehicle will be placed, including x, y, z, and w (heading).
+---@param coords vector4 The coordinates where the vehicle will be placed, including x, y, z, and w (heading).
----
+---
----@return number entityID The handle of the created vehicle.
+---@return number entityID The handle of the created vehicle.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- local vehicle = makeVeh('adder', vector4(123.4, 567.8, 90.1, 180.0))
+--- local vehicle = makeVeh('adder', vector4(123.4, 567.8, 90.1, 180.0))
---- ```
+--- ```
-function makeVeh(model, coords)
+function makeVeh(model, coords)
-	loadModel(model)
+	loadModel(model)
-    local veh = CreateVehicle(model, coords.x, coords.y, coords.z, coords.w, true, false)
+    local veh = CreateVehicle(model, coords.x, coords.y, coords.z, coords.w, true, false)
-    SetVehicleHasBeenOwnedByPlayer(veh, true)
+    SetVehicleHasBeenOwnedByPlayer(veh, true)
-    SetNetworkIdCanMigrate(NetworkGetNetworkIdFromEntity(veh), true)
+	if gameName ~= "rdr3" then
-	Wait(100)
+		SetNetworkIdCanMigrate(NetworkGetNetworkIdFromEntity(veh), true)
-    SetVehicleNeedsToBeHotwired(veh, false)
+		Wait(100)
-    SetVehRadioStation(veh, 'OFF')
+		SetVehicleNeedsToBeHotwired(veh, false)
-    SetVehicleFuelLevel(veh, 100.0)
+		SetVehRadioStation(veh, 'OFF')
-	SetVehicleModKit(veh, 0)
+		SetVehicleFuelLevel(veh, 100.0)
-	SetVehicleOnGroundProperly(veh)
+		SetVehicleModKit(veh, 0)
-
+	end
-	debugPrint("^6Bridge^7: ^1Veh ^2Created^7: '^6"..veh.."^7' | ^2Hash^7: ^7'^6"..model.."^7' | ^2Coord^7: "..formatCoord(coords))
+	SetVehicleOnGroundProperly(veh)
-	unloadModel(model)
+
-	Vehicles[#Vehicles + 1] = veh
+	debugPrint("^6Bridge^7: ^1Veh ^2Created^7: '^6"..veh.."^7' | ^2Hash^7: ^7'^6"..model.."^7' | ^2Coord^7: "..formatCoord(coords))
-	return veh
+	unloadModel(model)
-end
+	Vehicles[#Vehicles + 1] = veh
-
+	return veh
---- Attempts to gain network control of a vehicle and set it as a mission entity.
+end
----
+
---- This function forces synchronization of a vehicle with other players by requesting network control and setting the vehicle as a mission entity.
+local distanceVehicles = {}
----
+--- Creates a vehicle that spawns when the player enters a designated polyzone area.
----@param entity number The handle of the vehicle entity to push.
+---
----
+--- This function sets up a circular polyzone; when the player enters the zone, the vehicle is spawned,
----@usage
+--- and when the player exits, the vehicle is deleted.
---- ```lua
+---
---- pushVehicle(vehicle)
+---@param data table A table containing vehicle data.
---- ```
+--- - **vehicle** `string`: The model name or hash of the vehicle to spawn.
-function pushVehicle(entity)
+--- - **coords** `vector4`: The coordinates where the vehicle will be placed. Should include x, y, z, and w (heading).
-	SetVehicleModKit(entity, 0)
+---@param freeze boolean (optional) Whether to freeze the vehicle in place. Defaults to `false`.
-	if entity ~= 0 and DoesEntityExist(entity) then
+---@param synced boolean (optional) Whether the vehicle should be synced across clients. Defaults to `false`.
-		if not NetworkHasControlOfEntity(entity) then
+function makeDistVehicle(data, radius, onEnter, onExit)
-			debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Requesting network control of vehicle^7.")
+    local vehicle = nil
-			NetworkRequestControlOfEntity(entity)
+	local zoneId = keyGen() .. keyGen()
-			local timeout = 2000
+    local zone = createCirclePoly({
-			while timeout > 0 and not NetworkHasControlOfEntity(entity) do
+        name = zoneId,
-				Wait(100)
+        coords = vec3(data.coords.x, data.coords.y, data.coords.z),
-				timeout -= 100
+        radius = radius,
-			end
+        onEnter = function()
-			if NetworkHasControlOfEntity(entity) then debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Network has control of entity^7.") end
+            vehicle = makeVeh(data.model, data.coords)
-		end
+			if onEnter then
-		if not IsEntityAMissionEntity(entity) then
+				debugPrint("makeDistVehicle onEnter running")
-			debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Setting vehicle as a ^7'^2mission^7' ^2entity^7.")
+				onEnter(vehicle)
-			SetEntityAsMissionEntity(entity, true, true)
+			end
-			local timeout = 2000
+        end,
-			while timeout > 0 and not IsEntityAMissionEntity(entity) do
+        onExit = function()
-				Wait(100)
+            deleteVehicle(vehicle)
-				timeout -= 100
+			if onExit then
-			end
+				debugPrint("makeDistVehicle onExit running")
-			if IsEntityAMissionEntity(entity) then debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Vehicle is a ^7'^2mission^7'^2 entity^7.") end
+				onExit(vehicle)
-		end
+			end
-	end
+        end,
-end
+        debug = debugMode,
-
+    })
---- Cleans up all created vehicles when the resource stops.
+	distanceVehicles[zoneId] = { zone = zone, vehicle = vehicle }
-onResourceStop(function(r)
+	return zoneId
-	for i = 1, #Vehicles do DeleteVehicle(Vehicles[i]) end
+end
+
+--- Removes a specific distance-based vehicle spawning zone.
+---
+---@param zoneId string The unique identifier of the zone to remove.
+function removeDistVehicleZone(zoneId)
+    if distanceVehicles[zoneId].zone then
+        removePolyZone(distanceVehicles[zoneId].zone) -- Adjust this if your polyzone library uses a different removal method.
+        if distanceVehicles[zoneId].vehicle then
+			deleteVehicle(distanceVehicles[zoneId].vehicle)
+		end
+		distanceVehicles[zoneId] = nil
+        print("Removed polyzone for zoneId: " .. zoneId)
+    else
+        print("No zone found with zoneId: " .. zoneId)
+    end
+end
+
+--- Deletes a spawned vehicle.
+---
+---@param vehicle number The handle of the vehicle entity to delete.
+function deleteVehicle(vehicle)
+    if vehicle then
+        debugPrint("^6Bridge^7: ^2Destroying Vehicle^7: '^6" .. vehicle .. "^7'")
+        if IsEntityAttachedToEntity(vehicle, PlayerPedId()) then
+            SetEntityAsMissionEntity(vehicle)
+            DetachEntity(vehicle, true, true)
+        end
+        DeleteVehicle(vehicle)
+    end
+end
+
+--- Cleans up all created vehicles when the resource stops.
+onResourceStop(function(r)
+	for i = 1, #Vehicles do DeleteVehicle(Vehicles[i]) end
 end)

shared/make/progressBars.lua

@@ -1,209 +1,302 @@
-local inProgress = false
+local inProgress = false
-
+
---- Displays a progress bar using the configured progress bar system.
+--- Displays a progress bar using the configured progress bar system.
----
+---
---- This function handles displaying a progress bar to the player using the specified progress bar system (e.g., ox, qb, esx, gta).
+--- This function handles displaying a progress bar to the player using the specified progress bar system (e.g., ox, qb, esx, gta).
---- It supports shared progress bars between players, animations, camera effects, and more.
+--- It supports shared progress bars between players, animations, camera effects, and more.
----
+---
----@param data table A table containing the progress bar configuration.
+---@param data table A table containing the progress bar configuration.
---- - **label** (`string`): The text label to display on the progress bar.
+--- - **label** (`string`): The text label to display on the progress bar.
---- - **time** (`number`): The duration of the progress bar in milliseconds.
+--- - **time** (`number`): The duration of the progress bar in milliseconds.
---- - **dict** (`string`, optional): The animation dictionary to use.
+--- - **dict** (`string`, optional): The animation dictionary to use.
---- - **anim** (`string`, optional): The animation name to play.
+--- - **anim** (`string`, optional): The animation name to play.
---- - **task** (`string`, optional): The task scenario to perform.
+--- - **task** (`string`, optional): The task scenario to perform.
---- - **flag** (`number`, optional): The animation flag.
+--- - **flag** (`number`, optional): The animation flag.
---- - **dead** (`boolean`, optional): Whether to allow the progress bar when the player is dead. Default is `false`.
+--- - **dead** (`boolean`, optional): Whether to allow the progress bar when the player is dead. Default is `false`.
---- - **cancel** (`boolean`, optional): Whether the progress bar can be canceled by the player. Default is `true`.
+--- - **cancel** (`boolean`, optional): Whether the progress bar can be canceled by the player. Default is `true`.
---- - **icon** (`string`, optional): The icon to display (for qb progress bar).
+--- - **icon** (`string`, optional): The icon to display (for qb progress bar).
---- - **cam** (`number`, optional): The camera handle to use.
+--- - **cam** (`number`, optional): The camera handle to use.
---- - **shared** (`table`, optional): Data for shared progress bars.
+--- - **shared** (`table`, optional): Data for shared progress bars.
----   - **pid** (`number`): The player ID to share the progress bar with.
+---   - **pid** (`number`): The player ID to share the progress bar with.
----   - **label** (`string`): The label to display on the shared progress bar.
+---   - **label** (`string`): The label to display on the shared progress bar.
----
+---
---- @return boolean `true` if the progress bar completed successfully, or `false` if it was canceled.
+--- @return boolean `true` if the progress bar completed successfully, or `false` if it was canceled.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- local success = progressBar({
+--- local success = progressBar({
----     label = "Processing...",
+---     label = "Processing...",
----     time = 5000,
+---     time = 5000,
----     dict = "amb@world_human_hang_out_street@female_hold_arm@base",
+---     dict = "amb@world_human_hang_out_street@female_hold_arm@base",
----     anim = "base",
+---     anim = "base",
----     flag = 49,
+---     flag = 49,
----     cancel = true,
+---     cancel = true,
---- })
+--- })
---- ```
+--- ```
-function progressBar(data)
+function progressBar(data)
-    local ped = PlayerPedId()
+    local ped = PlayerPedId()
-    if data.shared then
+    if data.shared then
-        debugPrint("^6Bridge^7: ^6Sharing progressBar to player^7: ^6"..data.shared.pid.."^7")
+        debugPrint("^6Bridge^7: ^6Sharing progressBar to player^7: ^6"..data.shared.pid.."^7")
-        storedPID = data.shared.pid
+        storedPID = data.shared.pid
-        TriggerServerEvent(getScript()..":server:sharedProg:Start", data)
+        TriggerServerEvent(getScript()..":server:sharedProg:Start", data)
-    end
+    end
-    local result = nil
+    local result = nil
-    if data.cam then startTempCam(data.cam) end
+    if data.cam then startTempCam(data.cam) end
-    if Config.System.ProgressBar == "ox" then
+    if Config.System.ProgressBar == "ox" then
-        if exports[OXLibExport]:progressBar({
+        if exports[OXLibExport]:progressBar({
-            duration = debugMode and 1000 or data.time,
+            duration = debugMode and 1000 or data.time,
-            label = data.label,
+            label = data.label,
-            useWhileDead = data.dead or false,
+            useWhileDead = data.dead or false,
-			canCancel = data.cancel and data.cancel or true,
+			canCancel = data.cancel and data.cancel or true,
-            anim = {
+            anim = {
-                dict = data.dict,
+                dict = data.dict,
-                clip = data.anim,
+                clip = data.anim,
-                flag = (data.flag == 8 and 32 or data.flag) or nil,
+                flag = (data.flag == 8 and 32 or data.flag) or nil,
-                scenario = data.task
+                scenario = data.task
-            },
+            },
-            disable = {
+            disable = {
-                combat = true
+                combat = true
-            },
+            },
-        }) then
+        }) then
-            result = true
+            result = true
-        else
+        else
-            result = false
+            result = false
-        end
+        end
-
+
-    elseif Config.System.ProgressBar == "qb" then
+    elseif Config.System.ProgressBar == "qb" then
-        Core.Functions.Progressbar("progbar",
+        Core.Functions.Progressbar("progbar",
-            data.label,
+            data.label,
-            debugMode and 1000 or data.time,
+            debugMode and 1000 or data.time,
-            data.dead or false,
+            data.dead or false,
-			data.cancel or true,
+			data.cancel or true,
-            { disableMovement = true, disableCarMovement = true, disableMouse = false, disableCombat = true },
+            { disableMovement = true, disableCarMovement = true, disableMouse = false, disableCombat = true },
-            { animDict = data.dict, anim = data.anim, flags = data.flag or 32, task = data.task }, {}, {},
+            { animDict = data.dict, anim = data.anim, flags = data.flag or 32, task = data.task }, {}, {},
-            function()
+            function()
-                result = true
+                result = true
-            end, function()
+            end, function()
-                result = false
+                result = false
-            end, data.icon)
+            end, data.icon)
-
+
-    elseif Config.System.ProgressBar == "esx" then
+    elseif Config.System.ProgressBar == "esx" then
-        ESX.Progressbar(data.label, debugMode and 1000 or data.time, {
+        ESX.Progressbar(data.label, debugMode and 1000 or data.time, {
-            FreezePlayer = true,
+            FreezePlayer = true,
-            animation = {
+            animation = {
-                type = data.anim,
+                type = data.anim,
-                dict = data.dict,
+                dict = data.dict,
-                scenario = data.task,
+                scenario = data.task,
-            },
+            },
-            onFinish = function()
+            onFinish = function()
-                result = true
+                result = true
-            end,
+            end,
-            onCancel = function()
+            onCancel = function()
-                result = false
+                result = false
-            end
+            end
-        })
+        })
-
+
-    elseif Config.System.ProgressBar == "gta" then
+    elseif Config.System.ProgressBar == "red" then
-        local wait = debugMode and 1000 or data.time
+        -- Currently only uses jim-redui if you choose this option
-        inProgress = true
+        if exports["jim-redui"]:progressBar({
-        if not (data.dead or false) then
+            label = data.label,
-            lockInv(true)
+            time = debugMode and 1000 or data.time,
-            displaySpinner(data.label)
+            dict = data.dict,
-            if data.dict then
+            anim = data.anim,
-                playAnim(data.dict, data.anim, -1, (data.flag == 8 and 32 or data.flag) or nil)
+            flag = data.flag or 32,
-            end
+            task = data.task,
-            if data.task then
+            cancel = true,
-                TaskStartScenarioInPlace(ped, data.task, -1, true)
+        }) then
-            end
+            result = true
-            while inProgress and wait > 0 do
+        else
-                wait -= 15
+            result = false
-                local waitTimer = 0
+        end
-                DisablePlayerFiring(ped, true)
+
-                DisableControlAction(0, 25, true) -- Disable aim
+    elseif Config.System.ProgressBar == "gta" then
-                DisableControlAction(0, 21, true) -- Disable sprint
+        loadTextureDict("timerbars")
-                DisableControlAction(0, 30, true) -- Disable move left/right
+        if inProgress then return false end
-                DisableControlAction(0, 31, true) -- Disable move forward/back
+        inProgress = true
-                DisableControlAction(0, 36, true) -- Disable stealth
+        local wait = debugMode and 1000 or data.time
-                if data.cam ~= nil then
+        local endTime = GetGameTimer() + wait
-                    DisableControlAction(0, 1, true)   -- Disable look left/right
+        local ped = PlayerPedId()
-                    DisableControlAction(0, 2, true)   -- Disable look up/down
+
-                    DisableControlAction(0, 106, true) -- Disable vehicle mouse control
+        -- Setup Animation/Task if specified
-                end
+        if data.dict then
-                if data.cancel then
+            playAnim(data.dict, data.anim, -1, data.flag or 32)
-                    if IsControlJustReleased(0, 202) or IsControlJustReleased(0, 77) then -- Cancel key (Backspace or Delete)
+        elseif data.task then
-                        inProgress = false
+            TaskStartScenarioInPlace(ped, data.task, -1, true)
-                        waitTimer = 1500
+        end
-                        displaySpinner(Loc[Config.Lan].error["cancel"])
+
-                    end
+        -- Progress bar rendering loop
-                end
+        CreateThread(function()
-                Wait(waitTimer)
+            while GetGameTimer() < endTime and inProgress do
-            end
+                Wait(0)
-            inProgress = false
+                local elapsed = GetGameTimer()
-            if data.dict then stopAnim(data.dict, data.anim, ped) end
+                local percentage = ((elapsed - (endTime - wait)) / wait) * 100
-            ClearPedTasks(ped)
+
-        end
+                -- Convert to segmented progress (assuming 5 segments here)
-        stopSpinner()
+                local segments = 5  -- Number of segments in the bar
-        result = (wait <= 0)
+                local segmentProgress = {}
-    end
+                local progressPerSegment = 100 / segments
-
+
-    while result == nil do Wait(10) end
+                for i = 1, segments do
-
+                    local segmentStart = (i - 1) * progressPerSegment
-    -- Cleanup
+                    local segmentEnd = i * progressPerSegment
-    FreezeEntityPosition(ped, false)
+                    if percentage >= segmentEnd then
-    lockInv(false)
+                        segmentProgress[i] = 100
-    if data.cam then stopTempCam(data.cam) end
+                    elseif percentage <= segmentStart then
-    if result == false and data.shared then
+                        segmentProgress[i] = 0
-        debugPrint("^6Bridge^7: ^2Sending cancel to ^6"..storedPID.."^7")
+                    else
-        TriggerServerEvent(getScript().."server:sharedProg:cancel", storedPID)
+                        segmentProgress[i] = ((percentage - segmentStart) / progressPerSegment) * 100
-    end
+                    end
-    storedPID = nil
+                end
-    return result
+
-end
+                percentage = percentage >= 100 and 100 or percentage
-
+                -- Draw your segmented progress bar
---- Stops the current progress bar.
+                ShowGTAProgressBar(segmentProgress, data.label, ("%.0f%%"):format(percentage))
----
+
---- This function cancels the progress bar based on the configured progress bar system, handling any necessary cleanup.
+                -- Controls to disable during progress
-function stopPropgressBar()
+                DisablePlayerFiring(ped, true)
-    if Config.System.ProgressBar == "ox" then
+                DisableControlAction(0, 25, true) -- Disable aim
-        exports[OXLibExport]:cancelProgress()
+                DisableControlAction(0, 21, true) -- Disable sprint
-    elseif Config.System.ProgressBar == "qb" then
+                DisableControlAction(0, 30, true) -- Disable move left/right
-        TriggerEvent("progressbar:client:cancel")
+                DisableControlAction(0, 31, true) -- Disable move forward/back
-    elseif Config.System.ProgressBar == "gta" then
+                DisableControlAction(0, 36, true) -- Disable stealth
-        inProgress = false
+
-        BusyspinnerOff()
+                if data.cancel and (IsControlJustReleased(0, 202) or IsControlJustReleased(0, 177) or IsControlJustReleased(0, 73)) then
-    end
+                    inProgress = false
-end
+                end
-
+            end
--- System to handle sending/sharing progress bars between players --
+        end)
--- For example, healing someone --
+
-
+        -- Wait for completion or cancel
-local storedPID = nil
+        while GetGameTimer() < endTime and inProgress do
-
+            Wait(100)
---- Server event handler for starting a shared progress bar.
+        end
---- This event is triggered when a player wants to start a progress bar on another player.
+
---- It adjusts the data to prevent loops and sends the data to the target client.
+        -- Cleanup animations/tasks
-RegisterNetEvent(getScript()..":server:sharedProg:Start", function(data)
+        if data.dict then stopAnim(data.dict, data.anim, ped) end
-    local pid = data.shared.pid     -- Get player ID from the client
+        ClearPedTasks(ped)
-    data.label = data.shared.label  -- Set progress bar label to the shared label
+
-    data.cancel = false             -- Make it so it can't be canceled
+        result = inProgress
-    data.dead = true                -- Allow progress bar even if player is dead
+        inProgress = false
-    data.shared = nil               -- Remove shared info to prevent loops
+    end
-    data.anim = nil                 -- Remove animation so players don't share it
+
-    debugPrint("^6Bridge^7: ^6"..source.." ^2is sending shared progressBar to player^7, ^6"..pid.."^7")
+    while result == nil do Wait(10) end
-    TriggerClientEvent(getScript()..":client:sharedProg:Start", pid, data)
+
-end)
+    -- Cleanup
-
+    FreezeEntityPosition(ped, false)
---- Client event handler for starting a shared progress bar.
+    lockInv(false)
---- This event is triggered when the server wants the client to start a shared progress bar.
+    if data.cam then
-RegisterNetEvent(getScript()..":client:sharedProg:Start", function(data)
+        stopTempCam(data.cam)
-    debugPrint("^6Bridge^7: ^2You have been sent a progressBar^7")
+    end
-    progressBar(data)
+    if result == false and data.shared then
-end)
+        debugPrint("^6Bridge^7: ^2Sending cancel to ^6"..storedPID.."^7")
-
+        TriggerServerEvent(getScript().."server:sharedProg:cancel", storedPID)
---- Server event handler for canceling a shared progress bar.
+    end
---- This event is triggered when a progress bar is canceled and the server needs to notify the other player.
+    storedPID = nil
-RegisterNetEvent(getScript()..":server:sharedProg:Cancel", function(pid)
+    if result == false then
-    debugPrint("^6Bridge^7: ^2Sending cancel progressBar to ^6"..pid.."^7")
+        currentToken = nil
-    TriggerClientEvent(getScript()..":client:sharedProg:Cancel", pid)
+        TriggerServerEvent(getScript()..":clearAuthToken")
-end)
+    end
-
+    if result == true and data.request then
---- Client event handler for canceling a shared progress bar.
+        TriggerServerEvent(getScript()..":clearAuthToken")
---- This event is triggered when the server wants the client to cancel a shared progress bar.
+        currentToken = triggerCallback(AuthEvent)
-RegisterNetEvent(getScript()..":client:sharedProg:Cancel", function()
+    end
-    debugPrint("^6Bridge^7: ^2Receiving cancel progressBar^7")
+    return result
-    stopPropgressBar()
+end
-end)
+
-
+function ShowGTAProgressBar(currentProg, title, level)
---- Cleans up when the resource stops.
+    local loc = vec2(0.37, 0.90)
---- This event handler ensures that any active spinners or progress bars are stopped when the resource is stopped.
+    local size = vec2(0.3, 0.03)
-onResourceStop(function() stopSpinner() end, true)
+
+    -- Draw background box
+    DrawSprite("timerbars", "all_black_bg", loc.x +0.028, loc.y-0.01, 0.15, 0.07, 0.0, 255, 255, 255, 255)
+    DrawSprite("timerbars", "all_black_bg", loc.x +0.170, loc.y-0.01, 0.15, 0.07, 180.0, 255, 255, 255, 255)
+
+    SetTextFont(0)
+    SetTextProportional(1)
+    SetTextScale(0.35, 0.35)
+    SetTextColour(255, 255, 255, 255)
+    SetTextDropshadow(0, 0, 0, 0, 255)
+    SetTextDropShadow()
+    SetTextOutline()
+    SetTextEntry("STRING")
+    AddTextComponentString(title)
+    DrawText(loc.x - size.x / 4 + 0.074, loc.y - 0.034)  -- Adjust text position
+
+    SetTextFont(0)
+    SetTextProportional(1)
+    SetTextScale(0.35, 0.25)
+    SetTextColour(255, 255, 255, 255)
+    SetTextEntry("STRING")
+    AddTextComponentString(level)
+    DrawText(loc.x - size.x / 4 + 0.246, loc.y - 0.030)  -- Right-aligned additional text
+
+    local segmentWidth = (size.x + 0.05) / (#currentProg * 2)  -- Divide the total width by 18 (9 segments * 2 gaps for each)
+    local gap = segmentWidth / #currentProg  -- Smaller gap between segments
+
+    for i = 1, #currentProg do
+        local segmentX = (loc.x - size.x / 4 ) + 0.075 + (i - 1) * (segmentWidth + gap)
+        local fillPercentage = currentProg[i]
+        local progressBarWidth = segmentWidth * (fillPercentage / 100)
+
+        -- Semi-transparent background for each segment
+        DrawRect(segmentX + segmentWidth / 2, loc.y, segmentWidth, size.y / 3.4, 100, 100, 100, 255)
+
+        -- Filling progress for each segment
+        if progressBarWidth > 0 then
+            DrawRect(segmentX + progressBarWidth / 2, loc.y, progressBarWidth, size.y / 3.4, 93, 182, 229, 255)  -- Blue progress
+        end
+    end
+end
+
+--- Stops the current progress bar.
+---
+--- This function cancels the progress bar based on the configured progress bar system, handling any necessary cleanup.
+function stopProgressBar()
+    if Config.System.ProgressBar == "ox" then
+        exports[OXLibExport]:cancelProgress()
+    elseif Config.System.ProgressBar == "qb" then
+        TriggerEvent("progressbar:client:cancel")
+    elseif Config.System.ProgressBar == "gta" then
+        inProgress = false
+    end
+end
+
+-- System to handle sending/sharing progress bars between players --
+-- For example, healing someone --
+
+local storedPID = nil
+
+--- Server event handler for starting a shared progress bar.
+--- This event is triggered when a player wants to start a progress bar on another player.
+--- It adjusts the data to prevent loops and sends the data to the target client.
+RegisterNetEvent(getScript()..":server:sharedProg:Start", function(data)
+    local pid = data.shared.pid     -- Get player ID from the client
+    data.label = data.shared.label  -- Set progress bar label to the shared label
+    data.cancel = false             -- Make it so it can't be canceled
+    data.dead = true                -- Allow progress bar even if player is dead
+    data.shared = nil               -- Remove shared info to prevent loops
+    data.anim = nil                 -- Remove animation so players don't share it
+    debugPrint("^6Bridge^7: ^6"..source.." ^2is sending shared progressBar to player^7, ^6"..pid.."^7")
+    TriggerClientEvent(getScript()..":client:sharedProg:Start", pid, data)
+end)
+
+--- Client event handler for starting a shared progress bar.
+--- This event is triggered when the server wants the client to start a shared progress bar.
+RegisterNetEvent(getScript()..":client:sharedProg:Start", function(data)
+    debugPrint("^6Bridge^7: ^2You have been sent a progressBar^7")
+    progressBar(data)
+end)
+
+--- Server event handler for canceling a shared progress bar.
+--- This event is triggered when a progress bar is canceled and the server needs to notify the other player.
+RegisterNetEvent(getScript()..":server:sharedProg:Cancel", function(pid)
+    debugPrint("^6Bridge^7: ^2Sending cancel progressBar to ^6"..pid.."^7")
+    TriggerClientEvent(getScript()..":client:sharedProg:Cancel", pid)
+end)
+
+--- Client event handler for canceling a shared progress bar.
+--- This event is triggered when the server wants the client to cancel a shared progress bar.
+RegisterNetEvent(getScript()..":client:sharedProg:Cancel", function()
+    debugPrint("^6Bridge^7: ^2Receiving cancel progressBar^7")
+    stopProgressBar()
+end)

shared/metaHandlers.lua

@@ -0,0 +1,157 @@
+--[[
+    Player Metadata Utilities Module
+    ----------------------------------
+    This module provides functions for retrieving and setting metadata for players
+    across different frameworks (QB, ESX, OXCore). It also registers server callbacks
+    for getting and setting metadata.
+]]
+
+-------------------------------------------------------------
+-- Player Retrieval
+-------------------------------------------------------------
+
+--- Retrieves the player object using the active core export.
+---
+--- @param source number The server ID of the player.
+--- @return table|nil table The player object, or nil if no supported core is detected.
+---
+--- @usage
+--- ```lua
+--- local player = GetPlayer(playerId)
+--- ```
+function GetPlayer(source)
+    if isStarted(QBExport) then
+        debugPrint("^6Bridge^7: ^3GetPlayer^7() QBExport")
+        return exports[QBExport]:GetCoreObject().Functions.GetPlayer(source)
+
+    elseif isStarted(QBXExport) then
+        debugPrint("^6Bridge^7: ^3GetPlayer^7() QBOXExport")
+        return exports[QBXExport]:GetCoreObject().Functions.GetPlayer(source)
+
+    elseif isStarted(ESXExport) then
+        debugPrint("^6Bridge^7: ^3GetPlayer^7() ESXExport")
+        return ESX.GetPlayerFromId(source)
+
+    elseif isStarted(OXCoreExport) then
+        debugPrint("^6Bridge^7: ^3GetPlayer^7() OXCoreExport")
+        return exports[OXCoreExport]:GetPlayer(source)
+
+    elseif isStarted(RSGExport) then
+        debugPrint("^6Bridge^7: ^3GetPlayer^7() RSGExport")
+        return exports[RSGExport]:GetCoreObject().Functions.GetPlayer(source)
+
+    end
+    return nil
+end
+
+-------------------------------------------------------------
+-- Metadata Retrieval
+-------------------------------------------------------------
+
+--- Retrieves metadata from a player object.
+---
+--- If called client-side (player is nil), it triggers a server callback to retrieve metadata.
+---
+--- @param player table|nil The player object; if nil, metadata is retrieved via a server callback.
+--- @param key string The metadata key to retrieve.
+--- @return any The value of the requested metadata, or nil if not found.
+---
+--- @usage
+--- ```lua
+--- local myMeta = GetMetadata(player, "myKey")
+--- ```
+function GetMetadata(player, key)
+    if not player then
+        debugPrint("^6Bridge^7: ^3GetMetadata^7() calling server: "..key)
+        return triggerCallback(getScript()..":server:GetMetadata", key)
+    else
+        if isStarted(QBExport) or isStarted(QBXExport) then
+            debugPrint("^6Bridge^7: ^3GetMetadata^7() QBExport/QBXExport", key)
+            return player.PlayerData.metadata[key]
+
+        elseif isStarted(ESXExport) then
+            debugPrint("^6Bridge^7: ^3GetMetadata^7() ESXExport", key)
+            return player.getMeta(key)
+
+        elseif isStarted(OXCoreExport) then
+            debugPrint("^6Bridge^7: ^3GetMetadata^7() OXCoreExport", key)
+            return player.get(key)
+
+        elseif isStarted(RSGExport) then
+            debugPrint("^6Bridge^7: ^3GetMetadata^7() RSGExport", key)
+            return player.PlayerData.metadata[key]
+
+        end
+    end
+    return nil
+end
+
+-- Register a server callback for retrieving metadata.
+createCallback(getScript()..":server:GetMetadata", function(source, key)
+    debugPrint("^6Bridge^7: ^3GetMetadata Callback^7 from source: "..tostring(source)..", key: "..tostring(key))
+    local player = GetPlayer(source)
+    if not player then
+        print("Error getting metadata: player not found for source "..tostring(source))
+        return
+    end
+
+    if type(key) == "table" then
+        local Metadata = {}
+        for _, k in ipairs(key) do
+            Metadata[k] = GetMetadata(player, k)
+        end
+        return Metadata
+    elseif type(key) == "string" then
+        return GetMetadata(player, key)
+    end
+end)
+
+-------------------------------------------------------------
+-- Metadata Setting
+-------------------------------------------------------------
+
+--- Sets metadata on a player object.
+---
+--- The function updates the player's metadata using the active core export.
+---
+--- @param player table The player object.
+--- @param key string The metadata key to set.
+--- @param value any The new value for the metadata key.
+---
+--- @usage
+--- ```lua
+--- SetMetadata(player, "myKey", "newValue")
+--- ```
+function SetMetadata(player, key, value)
+    debugPrint("^6Bridge^7: ^3SetMetadata^7() setting metadata for key: "..key)
+    if isStarted(QBExport) or isStarted(QBXExport) then
+        debugPrint("^6Bridge^7: ^3SetMetadata^7() using QBExport/QBXExport")
+        player.Functions.SetMetaData(key, value)
+
+    elseif isStarted(ESXExport) then
+        debugPrint("^6Bridge^7: ^3SetMetadata^7() using ESXExport")
+        player.setMeta(key, value)
+
+    elseif isStarted(OXCoreExport) then
+        debugPrint("^6Bridge^7: ^3SetMetadata^7() using OXCoreExport")
+        player.set(key, value)
+
+    elseif isStarted(RSGExport) then
+        debugPrint("^6Bridge^7: ^3SetMetadata^7() using RSGExport")
+        player.Functions.SetMetaData(key, value)
+
+    end
+end
+
+-- Register a server callback for setting metadata.
+createCallback(getScript()..":server:SetMetadata", function(source, key, value)
+    debugPrint("SetMetadata callback triggered for source:", source, "key:", key, "value:", value)
+    local player = GetPlayer(source)
+    --[[if not player then
+        print("Error setting metadata: player not found for source "..tostring(source))
+        return false
+    end]]
+    SetMetadata(player, key, value)
+    print("Metadata set successfully.", key)
+    return true
+end)

shared/notify.lua

@@ -1,88 +1,140 @@
--- NOTIFICATIONS --
+--[[
--- This function is widely used to display notifications to the player, can be used server side or client side --
+    Notifications Module
-
+    ----------------------
---- Displays notifications to the player using the configured notification system.
+    This module provides a unified interface for displaying notifications using various
----
+    notification systems. The active system is determined by the Config.System.Notify setting.
---- This function supports multiple notification systems based on the `Config.System.Notify` setting.
+
---- It can be triggered from both client-side and server-side scripts. Depending on the configuration,
+    Supported systems include:
---- it utilizes different exports or events to display the notification.
+      • okok
----
+      • qb
----@param title string|nil The title of the notification. Optional, used by certain notification systems.
+      • ox
----@param message string The main message content of the notification.
+      • gta (default)
----@param type string The type/category of the notification (e.g., "success", "error", "info").
+      • esx
----@param src number|nil Optional. The server ID of the player to send the notification to. If `nil`, the notification is sent to the caller.
+]]
----
+
----@usage
+--- Displays notifications to the player using the configured notification system.
---- ```lua
+---
---- -- Client-side usage without specifying a player (shows to the current player)
+--- Supports multiple notification systems based on Config.System.Notify. Can be triggered from both
---- triggerNotify("Success", "You have completed the task!", "success")
+--- client and server contexts.
----
+---
---- -- Server-side usage specifying a player by their server ID
+--- @param title string|nil The notification title (optional for some systems).
---- triggerNotify("Alert", "You have been warned for misconduct.", "error", playerId)
+--- @param message string The main message content.
---- ```
+--- @param type string The notification type ("success", "error", "info").
-function triggerNotify(title, message, type, src)
+--- @param src number|nil Optional server ID; if provided, the notification is sent to that player.
-	if Config.System.Notify == "okok" then
+---
-		if not src then TriggerEvent('okokNotify:Alert', title, message, 6000, type)
+--- @usage
-		else TriggerClientEvent('okokNotify:Alert', src, title, message, 6000, type) end
+--- ```lua
-	elseif Config.System.Notify == "qb" then
+--- -- Client-side usage without specifying a player (shows to the current player)
-		if not src then	TriggerEvent("QBCore:Notify", message, type)
+--- triggerNotify("Success", "You have completed the task!", "success")
-		else TriggerClientEvent("QBCore:Notify", src, message, type) end
+---
-	elseif Config.System.Notify == "ox" then
+--- -- Server-side usage specifying a player by their server ID
-		if not src then TriggerEvent('ox_lib:notify', {title = title, description = message, type = type or "success"})
+--- triggerNotify("Alert", "You have been warned for misconduct.", "error", playerId)
-		else TriggerClientEvent('ox_lib:notify', src, { type = type or "success", title = title, description = message }) end
+--- ```
-	elseif Config.System.Notify == "gta" then
+function triggerNotify(title, message, type, src)
-		if not src then TriggerEvent(getScript()..":DisplayGTANotify", title, message)
+    if Config.System.Notify == "okok" then
-		else TriggerClientEvent(getScript()..":DisplayGTANotify", src, title, message) end
+        if not src then
-    elseif Config.System.Notify == "esx" then
+            TriggerEvent('okokNotify:Alert', title, message, 6000, type)
-		if not src then exports["esx_notify"]:Notify(type, 4000, message)
+        else
-		else TriggerClientEvent(getScript()..":DisplayESXNotify", src, type, title, message) end
+            TriggerClientEvent('okokNotify:Alert', src, title, message, 6000, type)
-	end
+        end
-end
+    elseif Config.System.Notify == "qb" then
-
+        if not src then
---- Registers a server-side event to display ESX notifications to clients.
+            TriggerEvent("QBCore:Notify", message, type)
----
+        else
---- This event listens for `DisplayESXNotify` and triggers the ESX notification on the client side.
+            TriggerClientEvent("QBCore:Notify", src, message, type)
----
+        end
---- @param type string The type/category of the notification (e.g., "success", "error", "info").
+    elseif Config.System.Notify == "ox" then
---- @param title string The title of the notification.
+        if not src then
---- @param text string The main message content of the notification.
+            TriggerEvent('ox_lib:notify', { title = title, description = message, type = type or "success" })
----
+        else
---- @usage
+            TriggerClientEvent('ox_lib:notify', src, { title = title, description = message, type = type or "success" })
---- ```lua
+        end
---- -- Server-side event trigger
+    elseif Config.System.Notify == "gta" then
---- TriggerClientEvent(getScript()..":DisplayESXNotify", playerId, "success", "Achievement Unlocked", "You have unlocked a new achievement!")
+        if isStarted("jim-gtaui") then
---- ```
+            if not src then
-RegisterNetEvent(getScript()..":DisplayESXNotify", function(type, title, text)
+                TriggerEvent("jim-gtaui:Notify", title, message, type)
-    exports["esx_notify"]:Notify(type, 4000, text)
+            else
-end)
+                TriggerClientEvent("jim-gtaui:Notify", src, title, message, type)
-
+            end
---- Displays default GTA-style text notifications.
+        else
----
+            if not src then
---- This event handles displaying text-based notifications using GTA's native functions.
+                TriggerEvent(getScript()..":DisplayGTANotify", title, message)
---- It supports specific scenarios by assigning different icons based on the script name.
+            else
----
+                TriggerClientEvent(getScript()..":DisplayGTANotify", src, title, message)
----@param title string The title or identifier for the notification, used to select the appropriate icon.
+            end
----@param text string The main message content of the notification.
+        end
----
+    elseif Config.System.Notify == "esx" then
----@usage
+        if not src then
---- ```lua
+            exports["esx_notify"]:Notify(type, 4000, message)
---- -- Client-side event trigger
+        else
---- TriggerEvent(getScript()..":DisplayGTANotify", "taxiname", "Taxi service has arrived.")
+            TriggerClientEvent(getScript()..":DisplayESXNotify", src, type, message)
---- ```
+        end
-RegisterNetEvent(getScript()..":DisplayGTANotify", function(title, text)
+
-    local iconTable = {}
+    elseif Config.System.Notify == "red" then
-    if getScript() == "jim-npcservice" then
+        if isStarted("jim-redui") then
-        iconTable = {
+            if not src then
-            [Loc[Config.Lan].notify["taxiname"]] = "CHAR_TAXI",
+                TriggerEvent("jim-redui:Notify", title, message, type)
-            [Loc[Config.Lan].notify["limoname"]] = "CHAR_CASINO",
+            else
-            [Loc[Config.Lan].notify["ambiname"]] = "CHAR_CALL911",
+                TriggerClientEvent("jim-redui:Notify", src, title, message, type)
-            [Loc[Config.Lan].notify["pilotname"]] = "CHAR_DEFAULT",
+            end
-            [Loc[Config.Lan].notify["planename"]] = "CHAR_BOATSITE2",
+        end
-            [Loc[Config.Lan].notify["heliname"]] = "CHAR_BOATSITE2",
+    end
-        }
+end
-    end
+
-    BeginTextCommandThefeedPost("STRING")
+-------------------------------------------------------------
-    AddTextComponentSubstringKeyboardDisplay(text)
+-- ESX Notifications
-    EndTextCommandThefeedPostMessagetext(iconTable[title] or "CHAR_DEFAULT", iconTable[title] or "CHAR_DEFAULT", true, 1, title, nil, text)
+-------------------------------------------------------------
-    EndTextCommandThefeedPostTicker(true, false)
+
+--- Registers a server-side event to display ESX notifications to clients.
+---
+--- Listens for DisplayESXNotify events and triggers the ESX notification on the client.
+---
+--- @param type string The notification type.
+--- @param title string The notification title.
+--- @param text string The notification message.
+---
+--- @usage
+--- ```lua
+--- TriggerClientEvent(getScript()..":DisplayESXNotify", playerId, "success", "New achievement unlocked!")
+--- ```
+RegisterNetEvent(getScript()..":DisplayESXNotify", function(type, text)
+    exports["esx_notify"]:Notify(type, 4000, text)
+end)
+
+-------------------------------------------------------------
+-- GTA-style Notifications
+-------------------------------------------------------------
+
+--- Displays GTA-style text notifications using native GTA functions.
+---
+--- Selects an appropriate icon based on the current script (if applicable) and renders the notification.
+---
+--- @param title string The notification title/identifier (used to select an icon).
+--- @param text string The notification message.
+---
+--- @usage
+--- ```lua
+--- TriggerEvent(getScript()..":DisplayGTANotify", "taxiname", "Taxi service has arrived.")
+--- ```
+RegisterNetEvent(getScript()..":DisplayGTANotify", function(title, text)
+    local iconTable = {}
+    if getScript() == "jim-npcservice" then
+        iconTable = {
+            [Loc[Config.Lan].notify["taxiname"]] = "CHAR_TAXI",
+            [Loc[Config.Lan].notify["limoname"]] = "CHAR_CASINO",
+            [Loc[Config.Lan].notify["ambiname"]] = "CHAR_CALL911",
+            [Loc[Config.Lan].notify["pilotname"]] = "CHAR_DEFAULT",
+            [Loc[Config.Lan].notify["planename"]] = "CHAR_BOATSITE2",
+            [Loc[Config.Lan].notify["heliname"]] = "CHAR_BOATSITE2",
+        }
+    end
+
+    BeginTextCommandThefeedPost("STRING")
+    AddTextComponentSubstringKeyboardDisplay(text)
+    EndTextCommandThefeedPostMessagetext(
+        iconTable[title] or "CHAR_DEFAULT",
+        iconTable[title] or "CHAR_DEFAULT",
+        true, 1, title, nil, text
+    )
+    EndTextCommandThefeedPostTicker(true, false)
 end)

shared/phones.lua

@@ -0,0 +1,171 @@
+--[[
+    Phone Mails Module
+    ------------------
+    This module handles sending phone mails using different phone systems.
+    Supported systems include:
+      - gksphone
+      - yflip-phone
+      - qs-smartphone
+      - qs-smartphone-pro
+      - roadphone
+      - lb-phone
+      - qb-phone
+      - jpr-phonesystem
+]]
+
+--- Sends a phone mail using the detected phone system.
+--- The function iterates through a prioritized list of supported phone systems.
+--- Once an active system is found (via `isStarted`), the corresponding mail function is executed.
+---
+--- @param data table A table containing the mail data.
+---   - subject (string): The email subject.
+---   - sender (string): The sender identifier.
+---   - message (string): The email body content.
+---   - actions (table|nil): Optional action buttons for the email.
+--- @usage
+--- sendPhoneMail({
+---     subject = "Welcome!",
+---     sender = "Admin",
+---     message = "Thank you for joining our server.",
+---     actions = {
+---         { label = "Reply", action = replyFunction }
+---     }
+--- })
+function sendPhoneMail(data)
+    -- Define each supported phone system and its corresponding mail-sending function.
+    local phoneSystems = {
+        {   name = "gksphone",
+            send = function(mailData)
+                exports["gksphone"]:SendNewMail(mailData)
+            end,
+        },
+        {   name = "yflip-phone",
+            send = function(mailData)
+                TriggerServerEvent(getScript()..":yflip:SendMail", mailData)
+            end,
+        },
+        {   name = "qs-smartphone",
+            send = function(mailData)
+                TriggerServerEvent('qs-smartphone:server:sendNewMail', mailData)
+            end,
+        },
+        {   name = "qs-smartphone-pro",
+            send = function(mailData)
+                TriggerServerEvent('phone:sendNewMail', mailData)
+            end,
+        },
+        {   name = "roadphone",
+            send = function(mailData)
+                -- Convert HTML line breaks to newlines for roadphone.
+                mailData.message = mailData.message:gsub("%<br>", "\n")
+                exports["roadphone"]:sendMail(mailData)
+            end,
+        },
+        {   name = "lb-phone",
+            send = function(mailData)
+                -- Convert HTML line breaks to newlines for lb-phone.
+                mailData.message = mailData.message:gsub("%<br>", "\n")
+                TriggerServerEvent(getScript()..":lbphone:SendMail", mailData)
+            end,
+        },
+        {   name = "qb-phone",
+            send = function(mailData)
+                TriggerServerEvent('qb-phone:server:sendNewMail', mailData)
+            end,
+        },
+        {   name = "jpr-phonesystem",
+            send = function(mailData)
+                TriggerServerEvent(getScript()..":jpr:SendMail", mailData)
+            end,
+        },
+        {   name = "ef-phone",
+            send = function(mailData)
+                TriggerServerEvent('qb-phone:server:sendNewMail', mailData)
+            end,
+        },
+    }
+
+    local activePhone = nil
+    -- Check each phone system in order and use the first active one.
+    for _, phone in ipairs(phoneSystems) do
+        if isStarted(phone.name) then
+            activePhone = phone.name
+            phone.send(data)
+            break
+        end
+    end
+
+    if activePhone then
+        debugPrint("^6Bridge^7[^3"..activePhone.."^7]: ^2Sending mail to player")
+    else
+        print("^6Bridge^7: ^1ERROR ^2Sending mail to player ^7- ^2No supported phone found")
+    end
+end
+
+-------------------------------------------------------------
+-- Phone System Event Handlers
+-------------------------------------------------------------
+
+--- Handles sending mail for lb-phone.
+--- Listens for the `lbphone:SendMail` event and sends an email using lb-phone's API.
+---
+--- @event lbphone:SendMail
+--- @param data table The mail data.
+---   - subject (string): The email subject.
+---   - message (string): The email content.
+---   - buttons (table|nil): Optional action buttons (mapped from data.actions if present).
+RegisterNetEvent(getScript()..":lbphone:SendMail", function(data)
+    local src = source
+    local phoneNumber = exports["lb-phone"]:GetEquippedPhoneNumber(src)
+    local emailAddress = exports["lb-phone"]:GetEmailAddress(phoneNumber)
+    -- Map actions to buttons if provided.
+    data.buttons = data.actions or data.buttons
+
+    exports["lb-phone"]:SendMail({
+        to = emailAddress,
+        subject = data.subject,
+        message = data.message,
+        actions = data.buttons,
+    })
+end)
+
+--- Handles sending mail for yflip-phone.
+--- Listens for the `yflip:SendMail` event and sends an email using yflip-phone's API.
+---
+--- @event yflip:SendMail
+--- @param data table The mail data.
+---   - subject (string): The email subject.
+---   - sender (string): The sender identifier.
+---   - message (string): The email content.
+---   - buttons (table|nil): Optional action buttons.
+RegisterNetEvent(getScript()..":yflip:SendMail", function(data)
+    local src = source
+    exports["yflip-phone"]:SendMail({
+        title = data.subject,
+        sender = data.sender,
+        senderDisplayName = data.sender,
+        content = data.message,
+        actions = data.buttons,
+    }, 'source', src)
+end)
+
+--- Handles sending mail for jpr-phonesystem.
+--- Listens for the `jpr:SendMail` event and sends an email using jpr-phonesystem's API.
+---
+--- @event jpr:SendMail
+--- @param data table The mail data.
+---   - subject (string): The email subject.
+---   - sender (string): The sender identifier.
+---   - message (string): The email content.
+---   - buttons (table|nil): Optional action buttons.
+RegisterNetEvent(getScript()..":jpr:SendMail", function(data)
+    local src = source
+    local Player = Core.Functions.GetPlayer(src)
+    TriggerEvent('jpr-phonesystem:server:sendEmail', {
+        Assunto = data.subject,                     -- Email subject
+        Conteudo = data.message,                    -- Email content
+        Enviado = data.sender,                      -- Sender information
+        Destinatario = Player.PlayerData.citizenid, -- Recipient identifier
+        Event = {},                                 -- Optional event details
+    })
+end)

shared/polyZone.lua

@@ -1,116 +1,140 @@
--- This automatically detects what polyzone script it should use to create a polyzone --
+--[[
--- if ox_lib is detected, it will automatically use that instead of PolyZone --
+    PolyZone Management Module
--- createPoly({ name = 'name', debug = true, points = { vec2(), vec2() }, onEnter = function() end, onExit = function() end, })
+    ----------------------------
----
+    This module automatically detects the available polyzone library (ox_lib or PolyZone)
---- Creates a polygonal zone using the detected polyzone library (ox_lib or PolyZone).
+    and creates polygonal and circular zones accordingly. It also provides a function to remove
----
+    previously created zones.
---- This function automatically detects whether `ox_lib` or `PolyZone` is active and creates a polygonal zone accordingly.
+
---- It supports setting up entry and exit callbacks for the zone.
+    Functions:
----
+      • createPoly(data)       - Creates a polygonal zone.
----@param data table A table containing the zone configuration.
+      • createCirclePoly(data) - Creates a circular zone.
---- - **name** (`string`): The name of the zone.
+      • removePolyZone(Location) - Removes a created zone.
---- - **debug** (`boolean`): Whether to enable debug mode for the zone.
+]]
---- - **points** (`table`): A list of `vec2` points defining the polygon.
+
---- - **onEnter** (`function`): Callback function to execute when a player enters the zone.
+-------------------------------------------------------------
---- - **onExit** (`function`): Callback function to execute when a player exits the zone.
+-- Polygonal Zone Creation
----
+-------------------------------------------------------------
----@return table|nil table Returns the created zone object or `nil` if creation failed.
+
----
+--- Creates a polygonal zone using the detected polyzone library (ox_lib or PolyZone).
----@usage
+---
---- ```lua
+--- Automatically checks which polyzone script is active. When using ox_lib, it converts the provided
---- createPoly({
+--- 2D points to 3D (setting a constant z value) and sets a thickness value. For PolyZone, it creates the zone
----     name = 'testZone',
+--- and attaches onEnter and onExit callbacks.
----     debug = true,
+---
----     points = { vec2(100.0, 100.0), vec2(200.0, 100.0), vec2(200.0, 200.0), vec2(100.0, 200.0) },
+--- @param data table Zone configuration table with the following keys:
----     onEnter = function() print("Entered Test Zone") end,
+---     - name (string): The zone's identifier.
----     onExit = function() print("Exited Test Zone") end,
+---     - debug (boolean): Whether debug mode is enabled.
---- })
+---     - points (table): A list of vec2 points defining the polygon.
---- ```
+---     - onEnter (function): Callback when a player enters the zone.
-function createPoly(data)
+---     - onExit (function): Callback when a player exits the zone.
-    local Location = nil
+---
-    if isStarted(OXLibExport) then -- if it finds ox_lib, use it instead of PolyZone
+--- @return table|nil table Returns the created zone object or nil if creation failed.
-        debugPrint("^6Bridge^7: ^2Creating new poly with ^7'^4"..OXLibExport.."^7': "..data.name)
+---
-        for i = 1, #data.points do
+---@usage
-            data.points[i] = vec3(data.points[i].x, data.points[i].y, 12.0)
+---```lua
-        end
+---createPoly({
-        data.thickness = 1000
+---    name = 'testZone',
-        Location = lib.zones.poly(data)
+---    debug = true,
-    elseif isStarted("PolyZone") then
+---    points = { vec2(100.0, 100.0), vec2(200.0, 100.0), vec2(200.0, 200.0), vec2(100.0, 200.0) },
-        debugPrint("^6Bridge^7: ^2Creating new poly with ^7'^4PolyZone^7': "..data.name)
+---    onEnter = function() print("Entered Test Zone") end,
-        Location = PolyZone:Create(data.points, { name = data.name, debugPoly = data.debug })
+---    onExit = function() print("Exited Test Zone") end,
-        Location:onPlayerInOut(function(isPointInside)
+---})
-            if isPointInside then data.onEnter() else data.onExit() end
+---```
-        end)
+function createPoly(data)
-    else
+    local Location = nil
-        print("^4ERROR^7: ^2No PolyZone creation script detected ^7- ^2Check ^3exports^1.^2lua^7")
+    if isStarted(OXLibExport) then
-    end
+        debugPrint("^6Bridge^7: ^2Creating new poly with ^7'^4"..OXLibExport.."^7': "..data.name)
-    return Location
+        -- Convert 2D points to 3D with a fixed Z coordinate (e.g., 12.0)
-end
+        for i = 1, #data.points do
-
+            data.points[i] = vec3(data.points[i].x, data.points[i].y, 12.0)
---- Creates a circular zone using the detected polyzone library (ox_lib or PolyZone).
+        end
----
+        data.thickness = 1000  -- Set a default thickness value
---- This function automatically detects whether `ox_lib` or `PolyZone` is active and creates a circular zone accordingly.
+        Location = lib.zones.poly(data)
---- It supports setting up entry and exit callbacks for the zone.
+    elseif isStarted("PolyZone") then
----
+        debugPrint("^6Bridge^7: ^2Creating new poly with ^7'^4PolyZone^7': "..data.name)
----@param data table A table containing the circular zone configuration.
+        Location = PolyZone:Create(data.points, { name = data.name, debugPoly = data.debug })
---- - **name** (`string`): The name of the circular zone.
+        Location:onPlayerInOut(function(isPointInside)
---- - **coords** (`vector3`): The center coordinates of the circle.
+            if isPointInside then data.onEnter() else data.onExit() end
---- - **radius** (`number`): The radius of the circle.
+
---- - **onEnter** (`function`): Callback function to execute when a player enters the zone.
+        end)
---- - **onExit** (`function`): Callback function to execute when a player exits the zone.
+    else
----
+        print("^4ERROR^7: ^2No PolyZone creation script detected ^7- ^2Check ^3exports^1.^2lua^7")
----@return table|nil table Returns the created circular zone object or `nil` if creation failed.
+    end
----
+    return Location
----@usage
+end
---- ```lua
+
---- createCirclePoly({
+-------------------------------------------------------------
----     name = 'circleZone',
+-- Circular Zone Creation
----     coords = vector3(150.0, 150.0, 20.0),
+-------------------------------------------------------------
----     radius = 50.0,
+
----     onEnter = function() print("Entered Circle Zone") end,
+--- Creates a circular zone using the detected polyzone library (ox_lib or PolyZone).
----     onExit = function() print("Exited Circle Zone") end,
+---
---- })
+--- When using ox_lib, it creates a sphere zone. For PolyZone, it creates a CircleZone and attaches
---- ```
+--- onEnter and onExit callbacks.
-function createCirclePoly(data)
+---
-    local Location = nil
+--- @param data table Zone configuration with the following keys:
-    if isStarted(OXLibExport) then -- if it finds ox_lib, use it instead of PolyZone
+---     - name (string): The zone's identifier.
-        debugPrint("^6Bridge^7: ^2Creating new ^3Cricle^2 poly with ^7"..OXLibExport.." "..data.name)
+---     - coords (vector3): The center of the circle.
-        Location = lib.zones.sphere(data)
+---     - radius (number): The radius of the circle.
-    elseif isStarted("PolyZone") then
+---     - onEnter (function): Callback when a player enters the zone.
-        debugPrint("^6Bridge^7: ^2Creating new ^3Cricle^2 poly with ^7PolyZone ".. data.name)
+---     - onExit (function): Callback when a player exits the zone.
-        Location = CircleZone:Create(data.coords, data.radius, { name = data.name, debugPoly = debugMode })
+---
-        Location:onPlayerInOut(function(isPointInside)
+--- @return table|nil table Returns the created circular zone object or nil if creation failed.
-            if isPointInside then
+---
-                data.onEnter()
+--- @usage
-            else
+--- ```lua
-                data.onExit()
+--- createCirclePoly({
-            end
+---     name = 'circleZone',
-        end)
+---     coords = vector3(150.0, 150.0, 20.0),
-    else
+---     radius = 50.0,
-        print("^4ERROR^7: ^2No PolyZone creation script detected ^7- ^2Check ^3exports^1.^2lua^7")
+---     onEnter = function() print("Entered Circle Zone") end,
-    end
+---     onExit = function() print("Exited Circle Zone") end,
-    debugPrint("^6Bridge^7: ^2Zone Stats - Coords: "..formatCoord(data.coords).." Radius: "..data.radius)
+--- })
-    return Location
+--- ```
-end
+function createCirclePoly(data)
-
+    local Location = nil
---- Removes a previously created polyzone.
+    if isStarted(OXLibExport) then
----
+        debugPrint("^6Bridge^7: ^2Creating new ^3Cricle^2 poly with ^7"..OXLibExport.." "..data.name)
---- This function detects the active polyzone library (`ox_lib` or `PolyZone`) and removes the specified zone accordingly.
+        Location = lib.zones.sphere(data)
----
+    elseif isStarted("PolyZone") then
---- @param Location table The zone object to be removed.
+        debugPrint("^6Bridge^7: ^2Creating new ^3Cricle^2 poly with ^7PolyZone ".. data.name)
----
+        Location = CircleZone:Create(data.coords, data.radius, { name = data.name, debugPoly = debugMode })
---- @usage
+        Location:onPlayerInOut(function(isPointInside)
---- ```lua
+            if isPointInside then
---- local zone = createPoly({...})
+                data.onEnter()
---- -- Later in the code
+            else
---- removePolyZone(zone)
+                data.onExit()
---- ```
+            end
-function removePolyZone(Location)
+        end)
-    if isStarted(OXLibExport) then -- if it finds ox_lib, use it instead of PolyZone
+    else
-        debugPrint("^6Bridge^7: ^2Removing ^2poly with ^7"..OXLibExport)
+        print("^4ERROR^7: ^2No PolyZone creation script detected ^7- ^2Check ^3starter^1.^2lua^7")
-        Location:remove()
+    end
-    elseif isStarted("PolyZone") then
+    debugPrint("^6Bridge^7: ^2Zone Stats - Coords: "..formatCoord(data.coords).." Radius: "..data.radius)
-        debugPrint("^6Bridge^7: ^2poly with ^7PolyZone")
+    return Location
-        Location:destroy()
+end
-    end
+
+-------------------------------------------------------------
+-- PolyZone Removal Function
+-------------------------------------------------------------
+
+--- Removes a previously created polyzone.
+---
+--- Detects the active polyzone library and calls the appropriate removal method.
+---
+--- @param Location table The zone object to be removed.
+---
+--- @usage
+--- ```lua
+--- local zone = createPoly({...})
+---
+--- removePolyZone(zone)
+--- ```
+function removePolyZone(Location)
+    if isStarted(OXLibExport) then
+        debugPrint("^6Bridge^7: ^2Removing ^2poly with ^7"..OXLibExport)
+        Location:remove()
+    elseif isStarted("PolyZone") then
+        debugPrint("^6Bridge^7: ^2poly with ^7PolyZone")
+        Location:destroy()
+    end
 end

shared/scaleEntity.lua

@@ -1,77 +1,77 @@
-local cacheOrigScale = {}
+local cacheOrigScale = {}
-local initialOffset = {}
+local initialOffset = {}
-
+
---- Sets the scale of an entity.
+--- Sets the scale of an entity.
----
+---
---- This function scales an entity by adjusting its forward, right, and up vectors.
+--- This function scales an entity by adjusting its forward, right, and up vectors.
---- It also applies an initial offset to maintain the entity's position relative to the ground.
+--- It also applies an initial offset to maintain the entity's position relative to the ground.
----
+---
----@param entity number The entity ID to scale.
+---@param entity number The entity ID to scale.
----@param scale number The scale factor to apply to the entity.
+---@param scale number The scale factor to apply to the entity.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- -- Scale an entity to twice its original size
+--- -- Scale an entity to twice its original size
---- SetEntityScale(entityId, 2.0)
+--- SetEntityScale(entityId, 2.0)
---- ```
+--- ```
-function SetEntityScale(entity, scale)
+function SetEntityScale(entity, scale)
-    local forward, right, up = GetEntityMatrix(entity)
+    local forward, right, up = GetEntityMatrix(entity)
-    if not cacheOrigScale[entity] then
+    if not cacheOrigScale[entity] then
-        cacheOrigScale[entity] = {
+        cacheOrigScale[entity] = {
-            forward = forward,
+            forward = forward,
-            right = right,
+            right = right,
-            up = up
+            up = up
-        }
+        }
-    end
+    end
-    local minDim, maxDim = GetModelDimensions(GetEntityModel(entity))
+    local minDim, maxDim = GetModelDimensions(GetEntityModel(entity))
-    local originalHeight = maxDim.z - minDim.z
+    local originalHeight = maxDim.z - minDim.z
-    local newHeight = originalHeight * scale
+    local newHeight = originalHeight * scale
-    initialOffset[entity] = (newHeight - originalHeight) / 3
+    initialOffset[entity] = (newHeight - originalHeight) / 3
-
+
-    local forwardTemp = cacheOrigScale[entity].forward * scale
+    local forwardTemp = cacheOrigScale[entity].forward * scale
-    local rightTemp = cacheOrigScale[entity].right * scale
+    local rightTemp = cacheOrigScale[entity].right * scale
-    local upTemp = cacheOrigScale[entity].up * scale
+    local upTemp = cacheOrigScale[entity].up * scale
-
+
-    -- Apply the initial offset to the current position
+    -- Apply the initial offset to the current position
-    local currentPosition = GetEntityCoords(entity)
+    local currentPosition = GetEntityCoords(entity)
-    local newPosition = vector3(currentPosition.x, currentPosition.y, currentPosition.z + initialOffset[entity])
+    local newPosition = vector3(currentPosition.x, currentPosition.y, currentPosition.z + initialOffset[entity])
-
+
-    SetEntityMatrix(entity, forwardTemp, rightTemp, upTemp, currentPosition)
+    SetEntityMatrix(entity, forwardTemp, rightTemp, upTemp, currentPosition)
-end
+end
-
+
---- Resets the scale of an entity to its original values.
+--- Resets the scale of an entity to its original values.
----
+---
---- This function restores an entity's original forward, right, and up vectors,
+--- This function restores an entity's original forward, right, and up vectors,
---- effectively undoing any scaling applied by `SetEntityScale`.
+--- effectively undoing any scaling applied by `SetEntityScale`.
----
+---
----@param entity number The entity ID to reset.
+---@param entity number The entity ID to reset.
----
+---
----@usage
+---@usage
---- ```lua
+--- ```lua
---- -- Reset the scale of an entity
+--- -- Reset the scale of an entity
---- resetScale(entityId)
+--- resetScale(entityId)
---- ```
+--- ```
-function resetScale(entity)
+function resetScale(entity)
-    if cacheOrigScale[entity] then
+    if cacheOrigScale[entity] then
-        SetEntityMatrix(entity, cacheOrigScale[entity].forward, cacheOrigScale[entity].right, cacheOrigScale[entity].up, GetEntityCoords(entity))
+        SetEntityMatrix(entity, cacheOrigScale[entity].forward, cacheOrigScale[entity].right, cacheOrigScale[entity].up, GetEntityCoords(entity))
-        cacheOrigScale[entity] = nil
+        cacheOrigScale[entity] = nil
-    end
+    end
-end
+end
-
+
---[[
+--[[
-CreateThread(function()
+CreateThread(function()
-    -- Example usage:
+    -- Example usage:
-    -- local prop = makeProp({prop = "v_res_r_figcat", coords = vec4(-1025.88, -1417.58, 5.43, 76.30)}, false, false)
+    -- local prop = makeProp({prop = "v_res_r_figcat", coords = vec4(-1025.88, -1417.58, 5.43, 76.30)}, false, false)
-    -- local ped = makePed(`a_c_cat_01`, vec4(-1022.42, -1429.97, 13.79, 68.36), true, false, nil)
+    -- local ped = makePed(`a_c_cat_01`, vec4(-1022.42, -1429.97, 13.79, 68.36), true, false, nil)
-    -- SetEntityCollision(prop, false, true)
+    -- SetEntityCollision(prop, false, true)
-
+
-    SetEntityScale(prop, 12)
+    SetEntityScale(prop, 12)
-    --[[CreateThread(function()
+    --[[CreateThread(function()
-        while true do
+        while true do
-            Wait(1000)
+            Wait(1000)
-            resetScale(prop)
+            resetScale(prop)
-            Wait(1000)
+            Wait(1000)
-        end
+        end
-    end)
+    end)
-end)
+end)
 ]]

shared/scaleforms.lua

@@ -1,61 +0,0 @@
-function makeInstructionalButtons(info)
-    local build = RequestScaleformMovie("instructional_buttons")
-    while not HasScaleformMovieLoaded(build) do Wait(0) end
-
-    DrawScaleformMovieFullscreen(build, 255, 255, 255, 0, 0)
-    BeginScaleformMovieMethod(build, "CLEAR_ALL")
-    EndScaleformMovieMethod()
-    BeginScaleformMovieMethod(build, "SET_CLEAR_SPACE")
-    ScaleformMovieMethodAddParamInt(200)
-    EndScaleformMovieMethod()
-
-    for i = 1, #info do
-        BeginScaleformMovieMethod(build, "SET_DATA_SLOT")
-        ScaleformMovieMethodAddParamInt(i - 1)
-        for k = 1, #info[i].keys do
-            ScaleformMovieMethodAddParamPlayerNameString(GetControlInstructionalButton(2, info[i].keys[k], true))
-        end
-        BeginTextCommandScaleformString("STRING")
-        AddTextComponentSubstringKeyboardDisplay(info[i].text)
-        EndTextCommandScaleformString()
-        EndScaleformMovieMethod()
-    end
-
-    BeginScaleformMovieMethod(build, "DRAW_INSTRUCTIONAL_BUTTONS")
-    EndScaleformMovieMethod()
-    BeginScaleformMovieMethod(build, "SET_BACKGROUND_COLOUR")
-    ScaleformMovieMethodAddParamInt(0)
-    ScaleformMovieMethodAddParamInt(0)
-    ScaleformMovieMethodAddParamInt(0)
-    ScaleformMovieMethodAddParamInt(80)
-    EndScaleformMovieMethod()
-
-    DrawScaleformMovieFullscreen(build, 255, 255, 255, 255, 0)
-end
-
--- Testing showing variables on the screen instead of only in f8
-function debugScaleForm(textTable, loc)
-    if debugMode then
-        -- Define the display position (top left corner)
-        local loc = loc or vec2(0.05, 0.65)
-
-        -- Calculate dynamic height based on the number of lines in the textTable
-        local lineHeight = 0.025  -- Height of each line of text
-        local totalHeight = #textTable * lineHeight  -- Dynamic height based on number of lines
-        local boxPadding = 0.01  -- Padding to add around the text inside the box
-        local size = vec2(0.18, totalHeight + boxPadding * 2)  -- Width remains fixed, height is dynamic
-
-        DrawRect(loc.x + size.x / 2, loc.y + size.y / 2, size.x, size.y, 0, 0, 0, 255)
-
-        for i = 1, #textTable do
-            local textLine = textTable[i]
-
-            SetTextScale(0.30, 0.30)
-
-            BeginTextCommandDisplayText("STRING")
-            AddTextComponentSubstringKeyboardDisplay(textLine)
-
-            EndTextCommandDisplayText(loc.x + 0.005, loc.y + (i - 1) * lineHeight + 0.01)
-        end
-    end
-end

shared/scaleforms/bigMessageInstance.lua

@@ -1,277 +1,306 @@
-BigMessage = {}
+--[[
-BigMessage.__index = BigMessage
+    BigMessage Module
-
+    -----------------
-function BigMessage:new()
+    This module provides a flexible way to display large, attention-grabbing messages
-    local self = setmetatable({}, BigMessage)
+    on screen using a Scaleform movie ("MP_BIG_MESSAGE_FREEMODE"). It supports multiple
-    self.scaleform = nil
+    message types (mission passed, colored shard, old-style, simple shard, rank-up, weapon purchased,
-    self.startTime = 0
+    and large multiplayer messages), including customizable transitions and durations.
-    self.duration = 0
+]]
-    self.transition = "TRANSITION_OUT"
+
-    self.transitionDuration = 0.15
+BigMessage = {}
-    self.transitionPreventAutoExpansion = false
+BigMessage.__index = BigMessage
-    self.transitionExecuted = false
+
-    self.manualDispose = false
+--- Creates a new BigMessage instance.
-    self.isDisplaying = false
+--- @return table table A new BigMessage object.
-    return self
+function BigMessage:new()
-end
+    local self = setmetatable({}, BigMessage)
-
+    self.scaleform = nil
-function BigMessage:Load()
+    self.startTime = 0
-    if self.scaleform then return end
+    self.duration = 0
-    self.scaleform = RequestScaleformMovie("MP_BIG_MESSAGE_FREEMODE")
+    self.transition = "TRANSITION_OUT"
-    while not HasScaleformMovieLoaded(self.scaleform) do
+    self.transitionDuration = 0.15
-        Wait(0)
+    self.transitionPreventAutoExpansion = false
-    end
+    self.transitionExecuted = false
-end
+    self.manualDispose = false
-
+    self.isDisplaying = false
--- Dispose of the scaleform
+    return self
-function BigMessage:Dispose()
+end
-    if not self.scaleform then return end
+
-
+--- Loads the Scaleform movie if it has not been loaded yet.
-    if self.manualDispose then
+function BigMessage:Load()
-        BeginScaleformMovieMethod(self.scaleform, self.transition)
+    if self.scaleform then return end
-        ScaleformMovieMethodAddParamBool(false)
+    self.scaleform = RequestScaleformMovie("MP_BIG_MESSAGE_FREEMODE")
-        ScaleformMovieMethodAddParamFloat(self.transitionDuration)
+    while not HasScaleformMovieLoaded(self.scaleform) do
-        ScaleformMovieMethodAddParamBool(self.transitionPreventAutoExpansion)
+        Wait(0)
-        EndScaleformMovieMethod()
+    end
-
+end
-        Wait((self.transitionDuration * 0.5) * 1000)
+
-
+--- Disposes of the Scaleform movie.
-        self.manualDispose = false
+--- If manualDispose is true, executes a transition before disposing.
-    end
+function BigMessage:Dispose()
-
+    if not self.scaleform then return end
-    self.startTime = 0
+
-    self.transitionExecuted = false
+    if self.manualDispose then
-    SetScaleformMovieAsNoLongerNeeded(self.scaleform)
+        BeginScaleformMovieMethod(self.scaleform, self.transition)
-    self.scaleform = nil
+        ScaleformMovieMethodAddParamBool(false)
-    self.isDisplaying = false
+        ScaleformMovieMethodAddParamFloat(self.transitionDuration)
-end
+        ScaleformMovieMethodAddParamBool(self.transitionPreventAutoExpansion)
-
+        EndScaleformMovieMethod()
-function BigMessage:Update()
+
-    if not self.scaleform then return end
+        -- Wait a fraction of the transition duration (in milliseconds)
-    DrawScaleformMovieFullscreen(self.scaleform, 255, 255, 255, 255, 0)
+        Wait((self.transitionDuration * 0.5) * 1000)
-
+        self.manualDispose = false
-    if self.manualDispose then return end
+    end
-
+
-    if self.startTime ~= 0 and (GetGameTimer() - self.startTime) > self.duration then
+    self.startTime = 0
-        if not self.transitionExecuted then
+    self.transitionExecuted = false
-            BeginScaleformMovieMethod(self.scaleform, self.transition)
+    SetScaleformMovieAsNoLongerNeeded(self.scaleform)
-            ScaleformMovieMethodAddParamBool(false)
+    self.scaleform = nil
-            ScaleformMovieMethodAddParamFloat(self.transitionDuration)
+    self.isDisplaying = false
-            ScaleformMovieMethodAddParamBool(self.transitionPreventAutoExpansion)
+end
-            EndScaleformMovieMethod()
+
-            self.transitionExecuted = true
+--- Updates the display by drawing the Scaleform movie fullscreen.
-            self.duration = self.duration + ((self.transitionDuration * 0.5) * 1000)
+function BigMessage:Update()
-        else
+    if not self.scaleform then return end
-            self:Dispose()
+
-        end
+    DrawScaleformMovieFullscreen(self.scaleform, 255, 255, 255, 255, 0)
-    end
+
-end
+    if self.manualDispose then return end
-
+
-function BigMessage:SetTransition(transition, duration, preventAutoExpansion)
+    if self.startTime ~= 0 and (GetGameTimer() - self.startTime) > self.duration then
-    self.transition = transition or "TRANSITION_OUT"
+        if not self.transitionExecuted then
-    self.transitionDuration = duration or 0.4
+            BeginScaleformMovieMethod(self.scaleform, self.transition)
-    self.transitionPreventAutoExpansion = preventAutoExpansion or true
+            ScaleformMovieMethodAddParamBool(false)
-end
+            ScaleformMovieMethodAddParamFloat(self.transitionDuration)
-
+            ScaleformMovieMethodAddParamBool(self.transitionPreventAutoExpansion)
-function BigMessage:StartUpdate()
+            EndScaleformMovieMethod()
-    if self.isDisplaying then return end
+            self.transitionExecuted = true
-    self.isDisplaying = true
+            -- Extend duration slightly for smooth transition
-    CreateThread(function()
+            self.duration = self.duration + ((self.transitionDuration * 0.5) * 1000)
-        while self.isDisplaying do
+        else
-            Wait(0)
+            self:Dispose()
-            self:Update()
+        end
-        end
+    end
-    end)
+end
-end
+
-
+--- Sets the transition properties for disposing the message.
---- Displays a mission passed message.
+--- @param transition string The transition function name (default: "TRANSITION_OUT").
----
+--- @param duration number The duration for the transition (default: 0.4).
---- @param msg string The main message to display.
+--- @param preventAutoExpansion boolean Whether to prevent auto-expansion (default: true).
---- @param duration number|nil The duration in milliseconds the message should be displayed. Defaults to 5000.
+function BigMessage:SetTransition(transition, duration, preventAutoExpansion)
---- @param manualDispose boolean|nil Whether to manually dispose of the scaleform after the message. Defaults to false.
+    self.transition = transition or "TRANSITION_OUT"
-function BigMessage:ShowMissionPassedMessage(msg, duration, manualDispose)
+    self.transitionDuration = duration or 0.4
-    duration = duration or 5000
+    self.transitionPreventAutoExpansion = preventAutoExpansion or true
-    self:Load()
+end
-    self.startTime = GetGameTimer()
+
-    self.manualDispose = manualDispose or false
+--- Starts a thread to continuously update the HUD until the message is done.
-
+function BigMessage:StartUpdate()
-    BeginScaleformMovieMethod(self.scaleform, "SHOW_MISSION_PASSED_MESSAGE")
+    if self.isDisplaying then return end
-    ScaleformMovieMethodAddParamPlayerNameString(msg)
+
-    ScaleformMovieMethodAddParamPlayerNameString("")
+    self.isDisplaying = true
-    ScaleformMovieMethodAddParamInt(100)
+    CreateThread(function()
-    ScaleformMovieMethodAddParamBool(true)
+        while self.isDisplaying do
-    ScaleformMovieMethodAddParamInt(0)
+            Wait(0)
-    ScaleformMovieMethodAddParamBool(true)
+            self:Update()
-    EndScaleformMovieMethod()
+        end
-
+    end)
-    self.duration = duration
+end
-    self:StartUpdate()
+
-end
+--- Displays a mission passed message.
-
+--- @param msg string The message to display.
---- Displays a colored shard message.
+--- @param duration number|nil The duration (in milliseconds) to display the message (default: 5000).
----
+--- @param manualDispose boolean|nil Whether to manually dispose the Scaleform after display (default: false).
---- @param msg string The main message to display.
+--- @usage
---- @param desc string The description text.
+--- ```lua
---- @param textColor number The color index for the text.
+--- BigMessage:ShowMissionPassedMessage("MISSION PASSED", 5000)
---- @param bgColor number The color index for the background.
+--- ```
---- @param duration number|nil The duration in milliseconds the message should be displayed. Defaults to 5000.
+function BigMessage:ShowMissionPassedMessage(msg, duration, manualDispose)
---- @param manualDispose boolean|nil Whether to manually dispose of the scaleform after the message. Defaults to false.
+    duration = duration or 5000
-function BigMessage:ShowColoredShard(msg, desc, textColor, bgColor, duration, manualDispose)
+    self:Load()
-    duration = duration or 5000
+    self.startTime = GetGameTimer()
-    self:Load()
+    self.manualDispose = manualDispose or false
-    self.startTime = GetGameTimer()
+
-    self.manualDispose = manualDispose or false
+    BeginScaleformMovieMethod(self.scaleform, "SHOW_MISSION_PASSED_MESSAGE")
-
+    ScaleformMovieMethodAddParamPlayerNameString(msg)
-    BeginScaleformMovieMethod(self.scaleform, "SHOW_SHARD_CENTERED_MP_MESSAGE")
+    ScaleformMovieMethodAddParamPlayerNameString("")
-    ScaleformMovieMethodAddParamPlayerNameString(msg)
+    ScaleformMovieMethodAddParamInt(100)
-    ScaleformMovieMethodAddParamPlayerNameString(desc)
+    ScaleformMovieMethodAddParamBool(true)
-    ScaleformMovieMethodAddParamInt(bgColor)
+    ScaleformMovieMethodAddParamInt(0)
-    ScaleformMovieMethodAddParamInt(textColor)
+    ScaleformMovieMethodAddParamBool(true)
-    EndScaleformMovieMethod()
+    EndScaleformMovieMethod()
-
+
-    self.duration = duration
+    self.duration = duration
-    self:StartUpdate()
+    self:StartUpdate()
-end
+end
-
+
---- Displays an old-style mission passed message.
+--- Displays a colored shard message.
----
+--- @param msg string The main message.
---- @param msg string The main message to display.
+--- @param desc string The description text.
---- @param duration number|nil The duration in milliseconds the message should be displayed. Defaults to 5000.
+--- @param textColor number The text color index.
---- @param manualDispose boolean|nil Whether to manually dispose of the scaleform after the message. Defaults to false.
+--- @param bgColor number The background color index.
----
+--- @param duration number|nil Duration in milliseconds (default: 5000).
---- @return void
+--- @param manualDispose boolean|nil Whether to manually dispose the Scaleform (default: false).
-function BigMessage:ShowOldMessage(msg, duration, manualDispose)
+function BigMessage:ShowColoredShard(msg, desc, textColor, bgColor, duration, manualDispose)
-    duration = duration or 5000
+    duration = duration or 5000
-    self:Load()
+    self:Load()
-    self.startTime = GetGameTimer()
+    self.startTime = GetGameTimer()
-    self.manualDispose = manualDispose or false
+    self.manualDispose = manualDispose or false
-
+
-    BeginScaleformMovieMethod(self.scaleform, "SHOW_MISSION_PASSED_MESSAGE")
+    BeginScaleformMovieMethod(self.scaleform, "SHOW_SHARD_CENTERED_MP_MESSAGE")
-    ScaleformMovieMethodAddParamPlayerNameString(msg)
+    ScaleformMovieMethodAddParamPlayerNameString(msg)
-    EndScaleformMovieMethod()
+    ScaleformMovieMethodAddParamPlayerNameString(desc)
-
+    ScaleformMovieMethodAddParamInt(textColor)
-    self.duration = duration
+    ScaleformMovieMethodAddParamInt(bgColor)
-    self:StartUpdate()
+    EndScaleformMovieMethod()
-end
+
-
+    self.duration = duration
---- Displays a simple shard message.
+    self:StartUpdate()
----
+end
---- @param msg string The main message to display.
+
---- @param subtitle string The subtitle text.
+--- Displays an old-style mission passed message.
---- @param duration number|nil The duration in milliseconds the message should be displayed. Defaults to 5000.
+--- @param msg string The message.
---- @param manualDispose boolean|nil Whether to manually dispose of the scaleform after the message. Defaults to false.
+--- @param duration number|nil Duration in milliseconds (default: 5000).
----
+--- @param manualDispose boolean|nil Whether to manually dispose (default: false).
---- @return void
+function BigMessage:ShowOldMessage(msg, duration, manualDispose)
-function BigMessage:ShowSimpleShard(msg, subtitle, duration, manualDispose)
+    duration = duration or 5000
-    duration = duration or 5000
+    self:Load()
-    self:Load()
+    self.startTime = GetGameTimer()
-    self.startTime = GetGameTimer()
+    self.manualDispose = manualDispose or false
-    self.manualDispose = manualDispose or false
+
-
+    BeginScaleformMovieMethod(self.scaleform, "SHOW_MISSION_PASSED_MESSAGE")
-    BeginScaleformMovieMethod(self.scaleform, "SHOW_SHARD_CREW_RANKUP_MP_MESSAGE")
+    ScaleformMovieMethodAddParamPlayerNameString(msg)
-    ScaleformMovieMethodAddParamPlayerNameString(msg)
+    EndScaleformMovieMethod()
-    ScaleformMovieMethodAddParamPlayerNameString(subtitle)
+
-    EndScaleformMovieMethod()
+    self.duration = duration
-
+    self:StartUpdate()
-    self.duration = duration
+end
-    self:StartUpdate()
+
-end
+--- Displays a simple shard message.
-
+--- @param msg string The main message.
---- Displays a rank-up message.
+--- @param subtitle string The subtitle text.
----
+--- @param duration number|nil Duration in milliseconds (default: 5000).
---- @param msg string The main message to display.
+--- @param manualDispose boolean|nil Whether to manually dispose (default: false).
---- @param subtitle string The subtitle text.
+function BigMessage:ShowSimpleShard(msg, subtitle, duration, manualDispose)
---- @param rank number The rank level achieved.
+    duration = duration or 5000
---- @param duration number|nil The duration in milliseconds the message should be displayed. Defaults to 5000.
+    self:Load()
---- @param manualDispose boolean|nil Whether to manually dispose of the scaleform after the message. Defaults to false.
+    self.startTime = GetGameTimer()
-function BigMessage:ShowRankupMessage(msg, subtitle, rank, duration, manualDispose)
+    self.manualDispose = manualDispose or false
-    duration = duration or 5000
+
-    self:Load()
+    BeginScaleformMovieMethod(self.scaleform, "SHOW_SHARD_CREW_RANKUP_MP_MESSAGE")
-    self.startTime = GetGameTimer()
+    ScaleformMovieMethodAddParamPlayerNameString(msg)
-    self.manualDispose = manualDispose or false
+    ScaleformMovieMethodAddParamPlayerNameString(subtitle)
-
+    EndScaleformMovieMethod()
-    BeginScaleformMovieMethod(self.scaleform, "SHOW_BIG_MP_MESSAGE")
+
-    ScaleformMovieMethodAddParamPlayerNameString(msg)
+    self.duration = duration
-    ScaleformMovieMethodAddParamPlayerNameString(subtitle)
+    self:StartUpdate()
-    ScaleformMovieMethodAddParamInt(rank)
+end
-    ScaleformMovieMethodAddParamPlayerNameString("")
+
-    ScaleformMovieMethodAddParamPlayerNameString("")
+--- Displays a rank-up message.
-    EndScaleformMovieMethod()
+--- @param msg string The main message.
-
+--- @param subtitle string The subtitle text.
-    self.duration = duration
+--- @param rank number The rank level achieved.
-    self:StartUpdate()
+--- @param duration number|nil Duration in milliseconds (default: 5000).
-end
+--- @param manualDispose boolean|nil Whether to manually dispose (default: false).
-
+function BigMessage:ShowRankupMessage(msg, subtitle, rank, duration, manualDispose)
---- Displays a weapon purchased message.
+    duration = duration or 5000
----
+    self:Load()
---- @param bigMessage string The main message to display.
+    self.startTime = GetGameTimer()
---- @param weaponName string The name of the weapon purchased.
+    self.manualDispose = manualDispose or false
---- @param weaponHash number The hash identifier of the weapon.
+
---- @param duration number|nil The duration in milliseconds the message should be displayed. Defaults to 5000.
+    BeginScaleformMovieMethod(self.scaleform, "SHOW_BIG_MP_MESSAGE")
---- @param manualDispose boolean|nil Whether to manually dispose of the scaleform after the message. Defaults to false.
+    ScaleformMovieMethodAddParamPlayerNameString(msg)
-function BigMessage:ShowWeaponPurchasedMessage(bigMessage, weaponName, weaponHash, duration, manualDispose)
+    ScaleformMovieMethodAddParamPlayerNameString(subtitle)
-    duration = duration or 5000
+    ScaleformMovieMethodAddParamInt(rank)
-    self:Load()
+    ScaleformMovieMethodAddParamPlayerNameString("")
-    self.startTime = GetGameTimer()
+    ScaleformMovieMethodAddParamPlayerNameString("")
-    self.manualDispose = manualDispose or false
+    EndScaleformMovieMethod()
-
+
-    BeginScaleformMovieMethod(self.scaleform, "SHOW_WEAPON_PURCHASED")
+    self.duration = duration
-    ScaleformMovieMethodAddParamPlayerNameString(bigMessage)
+    self:StartUpdate()
-    ScaleformMovieMethodAddParamPlayerNameString(weaponName)
+end
-    ScaleformMovieMethodAddParamInt(weaponHash)
+
-    ScaleformMovieMethodAddParamPlayerNameString("")
+--- Displays a weapon purchased message.
-    ScaleformMovieMethodAddParamInt(100)
+--- @param bigMessage string The main message.
-    EndScaleformMovieMethod()
+--- @param weaponName string The name of the weapon purchased.
-
+--- @param weaponHash number The weapon hash.
-    self.duration = duration
+--- @param duration number|nil Duration in milliseconds (default: 5000).
-    self:StartUpdate()
+--- @param manualDispose boolean|nil Whether to manually dispose (default: false).
-end
+function BigMessage:ShowWeaponPurchasedMessage(bigMessage, weaponName, weaponHash, duration, manualDispose)
-
+    duration = duration or 5000
---- Displays a large multiplayer message.
+    self:Load()
----
+    self.startTime = GetGameTimer()
---- @param msg string The main message to display.
+    self.manualDispose = manualDispose or false
---- @param duration number|nil The duration in milliseconds the message should be displayed. Defaults to 5000.
+
---- @param manualDispose boolean|nil Whether to manually dispose of the scaleform after the message. Defaults to false.
+    BeginScaleformMovieMethod(self.scaleform, "SHOW_WEAPON_PURCHASED")
-function BigMessage:ShowMpMessageLarge(msg, duration, manualDispose)
+    ScaleformMovieMethodAddParamPlayerNameString(bigMessage)
-    duration = duration or 5000
+    ScaleformMovieMethodAddParamPlayerNameString(weaponName)
-    self:Load()
+    ScaleformMovieMethodAddParamInt(weaponHash)
-    self.startTime = GetGameTimer()
+    ScaleformMovieMethodAddParamPlayerNameString("")
-    self.manualDispose = manualDispose or false
+    ScaleformMovieMethodAddParamInt(100)
-
+    EndScaleformMovieMethod()
-    BeginScaleformMovieMethod(self.scaleform, "SHOW_CENTERED_MP_MESSAGE_LARGE")
+
-    ScaleformMovieMethodAddParamPlayerNameString(msg)
+    self.duration = duration
-    ScaleformMovieMethodAddParamPlayerNameString("")
+    self:StartUpdate()
-    ScaleformMovieMethodAddParamInt(100)
+end
-    ScaleformMovieMethodAddParamBool(true)
+
-    ScaleformMovieMethodAddParamInt(100)
+--- Displays a large multiplayer message.
-    EndScaleformMovieMethod()
+--- @param msg string The main message.
-
+--- @param duration number|nil Duration in milliseconds (default: 5000).
-    BeginScaleformMovieMethod(self.scaleform, "TRANSITION_IN")
+--- @param manualDispose boolean|nil Whether to manually dispose (default: false).
-    EndScaleformMovieMethod()
+function BigMessage:ShowMpMessageLarge(msg, duration, manualDispose)
-
+    duration = duration or 5000
-    self.duration = duration
+    self:Load()
-    self:StartUpdate()
+    self.startTime = GetGameTimer()
-end
+    self.manualDispose = manualDispose or false
-
+
---- Displays a "Wasted" multiplayer message.
+    BeginScaleformMovieMethod(self.scaleform, "SHOW_CENTERED_MP_MESSAGE_LARGE")
----
+    ScaleformMovieMethodAddParamPlayerNameString(msg)
---- @param msg string The main message to display.
+    ScaleformMovieMethodAddParamPlayerNameString("")
---- @param subtitle string The subtitle text.
+    ScaleformMovieMethodAddParamInt(100)
---- @param duration number|nil The duration in milliseconds the message should be displayed. Defaults to 5000.
+    ScaleformMovieMethodAddParamBool(true)
---- @param manualDispose boolean|nil Whether to manually dispose of the scaleform after the message. Defaults to false.
+    ScaleformMovieMethodAddParamInt(100)
-function BigMessage:ShowMpWastedMessage(msg, subtitle, duration, manualDispose)
+    EndScaleformMovieMethod()
-    duration = duration or 5000
+
-    self:Load()
+    BeginScaleformMovieMethod(self.scaleform, "TRANSITION_IN")
-    self.startTime = GetGameTimer()
+    EndScaleformMovieMethod()
-    self.manualDispose = manualDispose or false
+
-
+    self.duration = duration
-    BeginScaleformMovieMethod(self.scaleform, "SHOW_SHARD_WASTED_MP_MESSAGE")
+    self:StartUpdate()
-    ScaleformMovieMethodAddParamPlayerNameString(msg)
+end
-    ScaleformMovieMethodAddParamPlayerNameString(subtitle)
+
-    EndScaleformMovieMethod()
+--- Displays a "Wasted" multiplayer message.
-
+--- @param msg string The main message.
-    self.duration = duration
+--- @param subtitle string The subtitle text.
-    self:StartUpdate()
+--- @param duration number|nil Duration in milliseconds (default: 5000).
-end
+--- @param manualDispose boolean|nil Whether to manually dispose (default: false).
-
+function BigMessage:ShowMpWastedMessage(msg, subtitle, duration, manualDispose)
+    duration = duration or 5000
+    self:Load()
+    self.startTime = GetGameTimer()
+    self.manualDispose = manualDispose or false
+
+    BeginScaleformMovieMethod(self.scaleform, "SHOW_SHARD_WASTED_MP_MESSAGE")
+    ScaleformMovieMethodAddParamPlayerNameString(msg)
+    ScaleformMovieMethodAddParamPlayerNameString(subtitle)
+    EndScaleformMovieMethod()
+
+    self.duration = duration
+    self:StartUpdate()
+end
+
+--- Starts the update loop for displaying the message.
+function BigMessage:StartUpdate()
+    if self.isDisplaying then return end
+    self.isDisplaying = true
+    CreateThread(function()
+        while self.isDisplaying do
+            Wait(0)
+            self:Update()
+        end
+    end)
+end
+
+-- Create an instance of BigMessage and return it.
+BigMessage = BigMessage:new()
+
 return BigMessage

shared/scaleforms/countDownHandler.lua

@@ -1,116 +1,135 @@
-CountdownHandler = {}
+--[[
-CountdownHandler.__index = CountdownHandler
+    CountdownHandler Module
-
+    -------------------------
-function CountdownHandler:new()
+    This module provides a countdown HUD using a Scaleform movie ("COUNTDOWN").
-    local self = setmetatable({}, CountdownHandler)
+    It handles loading, updating, and disposing of the scaleform, as well as
-    self.scaleform = nil
+    playing sounds and displaying messages for each countdown tick.
-    self.renderCountdown = false
+
-    self.colour = { r = 255, g = 255, b = 255, a = 255 }
+    TriggerNetEvent(getScript()..":startCountdown", 5, 25)
-    return self
+]]
-end
+
-
+CountdownHandler = {}
-function CountdownHandler:Load()
+CountdownHandler.__index = CountdownHandler
-    if self.scaleform then return end
+
-    self.scaleform = RequestScaleformMovie("COUNTDOWN")
+--- Creates a new CountdownHandler instance.
-    while not HasScaleformMovieLoaded(self.scaleform) do
+--- @return table table A new CountdownHandler object.
-        Wait(0)
+function CountdownHandler:new()
-    end
+    local self = setmetatable({}, CountdownHandler)
-end
+    self.scaleform = nil
-
+    self.renderCountdown = false
-function CountdownHandler:Dispose()
+    self.colour = { r = 255, g = 255, b = 255, a = 255 }
-    if self.scaleform then
+    return self
-        SetScaleformMovieAsNoLongerNeeded(self.scaleform)
+end
-        self.scaleform = nil
+
-    end
+--- Loads the "COUNTDOWN" scaleform movie.
-end
+function CountdownHandler:Load()
-
+    if self.scaleform then
-function CountdownHandler:Update()
+        return
-    if self.scaleform then
+    end
-        DrawScaleformMovieFullscreen(self.scaleform, 255, 255, 255, 255, 0)
+    self.scaleform = RequestScaleformMovie("COUNTDOWN")
-    end
+    while not HasScaleformMovieLoaded(self.scaleform) do
-end
+        Wait(0)
-
+    end
-function CountdownHandler:ShowMessage(message)
+end
-    local r, g, b, a = self.colour.r, self.colour.g, self.colour.b, self.colour.a
+
-
+--- Disposes of the currently loaded scaleform movie.
-    BeginScaleformMovieMethod(self.scaleform, "SET_MESSAGE")
+function CountdownHandler:Dispose()
-    ScaleformMovieMethodAddParamPlayerNameString(message)
+    if self.scaleform then
-    ScaleformMovieMethodAddParamInt(r)
+        SetScaleformMovieAsNoLongerNeeded(self.scaleform)
-    ScaleformMovieMethodAddParamInt(g)
+        self.scaleform = nil
-    ScaleformMovieMethodAddParamInt(b)
+    end
-    ScaleformMovieMethodAddParamBool(true)
+end
-    EndScaleformMovieMethod()
+
-
+--- Updates the HUD by drawing the scaleform movie fullscreen.
-    BeginScaleformMovieMethod(self.scaleform, "FADE_MP")
+function CountdownHandler:Update()
-    ScaleformMovieMethodAddParamPlayerNameString(message)
+    if self.scaleform then
-    ScaleformMovieMethodAddParamInt(r)
+        DrawScaleformMovieFullscreen(self.scaleform, 255, 255, 255, 255, 0)
-    ScaleformMovieMethodAddParamInt(g)
+    end
-    ScaleformMovieMethodAddParamInt(b)
+end
-    EndScaleformMovieMethod()
+
-end
+--- Displays a message on the countdown HUD.
-
+--- @param message string The message to display.
---- Starts the countdown with the specified number and HUD color.
+function CountdownHandler:ShowMessage(message)
----
+    local r, g, b, a = self.colour.r, self.colour.g, self.colour.b, self.colour.a
---- @param number number|nil The starting number for the countdown. Defaults to 3.
+
---- @param hudColour number|nil The HUD color index. Defaults to 18.
+    -- Set the message in the scaleform.
----
+    BeginScaleformMovieMethod(self.scaleform, "SET_MESSAGE")
---- @return boolean `true` when the countdown has finished.
+    ScaleformMovieMethodAddParamPlayerNameString(message)
----
+    ScaleformMovieMethodAddParamInt(r)
---- @usage
+    ScaleformMovieMethodAddParamInt(g)
---- ```lua
+    ScaleformMovieMethodAddParamInt(b)
---- -- Start a countdown of 5 seconds with HUD color 25
+    ScaleformMovieMethodAddParamBool(true)
---- if CountdownHandler:Start(5, 25) then
+    EndScaleformMovieMethod()
----     print("Countdown Complete")
+
---- end
+    -- Trigger a fade effect (optional).
---- ```
+    BeginScaleformMovieMethod(self.scaleform, "FADE_MP")
-function CountdownHandler:Start(number, hudColour)
+    ScaleformMovieMethodAddParamPlayerNameString(message)
-    local finished = false
+    ScaleformMovieMethodAddParamInt(r)
-    number = number or 3
+    ScaleformMovieMethodAddParamInt(g)
-    hudColour = hudColour or 18
+    ScaleformMovieMethodAddParamInt(b)
-
+    EndScaleformMovieMethod()
-    local r, g, b, a = GetHudColour(hudColour)
+end
-    self.colour = { r = r, g = g, b = b, a = a }
+
-
+--- Starts the countdown HUD.
-    self:Load()
+--- @param number number|nil The starting number for the countdown (default: 3).
-
+--- @param hudColour number|nil The HUD colour index (default: 18).
-    self.renderCountdown = true
+--- @return boolean boolean True when the countdown has finished.
-    CreateThread(function()
+--- @usage
-        while self.renderCountdown do
+--- ```lua
-            Wait(0)
+--- if CountdownHandler:Start(5, 25) then
-            self:Update()
+---     -- When run in an if statement, the script will wait until its finished to continue
-        end
+---     print("Countdown Complete")
-    end)
+--- end
-
+--- ```
-    -- Begin the countdown
+function CountdownHandler:Start(number, hudColour)
-    CreateThread(function()
+    local finished = false
-        local currentNumber = number
+    number = number or 3
-        while currentNumber > 0 do
+    hudColour = hudColour or 18
-            -- Play countdown sound
+
-            playSound("Count")
+    -- Get HUD colour using framework function; alternatives could be added here.
-            self:ShowMessage(tostring(currentNumber))
+    local r, g, b, a = GetHudColour(hudColour)
-            Wait(1000)
+    self.colour = { r = r, g = g, b = b, a = a }
-            currentNumber = currentNumber - 1
+
-        end
+    self:Load()
-        playSound("Go")
+
-
+    self.renderCountdown = true
-        self:ShowMessage("GO")
+    CreateThread(function()
-        finished = true
+        while self.renderCountdown do
-
+            Wait(0)
-        Wait(1000)
+            self:Update()
-        self.renderCountdown = false
+        end
-        self:Dispose()
+    end)
-        finished = true
+
-    end)
+    -- Countdown logic
-    while not finished do Wait(10) end
+    CreateThread(function()
-    return true
+        local currentNumber = number
-end
+        while currentNumber > 0 do
-
+            playSound("Count")
--- Create an instance of CountdownHandler
+            self:ShowMessage(tostring(currentNumber))
-CountdownHandler = CountdownHandler:new()
+            Wait(1000)
-
+            currentNumber = currentNumber - 1
--- Optional: Register an event to start the countdown
+        end
-RegisterNetEvent(getScript()..":startCountdown", function(number, hudColour)
+
-    CountdownHandler:Start(number, hudColour)
+        playSound("Go")
-end)
+        self:ShowMessage("GO")
-
+        finished = true
+
+        Wait(1000)
+        self.renderCountdown = false
+        self:Dispose()
+        finished = true
+    end)
+
+    while not finished do Wait(10) end
+    return true
+end
+
+-- Create a singleton instance of CountdownHandler.
+CountdownHandler = CountdownHandler:new()
+
+-- Register an event to start the countdown.
+RegisterNetEvent(getScript()..":startCountdown", function(number, hudColour)
+    CountdownHandler:Start(number, hudColour)
+end)
+
 return CountdownHandler

shared/scaleforms/debugScaleform.lua

@@ -1,41 +1,44 @@
-
+-------------------------------------------------------------
---- Displays debug information on the player's screen.
+-- Debug Text Display Functionality
----
+-------------------------------------------------------------
---- This function renders a semi-transparent box with multiple lines of text for debugging purposes.
+
---- It is controlled by the `debugMode` flag and can be positioned dynamically on the screen.
+--- Draws debug text on the screen if debugMode is enabled.
----
+---
---- @param textTable table A table containing strings to display.
+--- Calculates a background rectangle based on the number of text lines and renders each line on-screen.
---- @param loc vector2|nil Optional. The screen position to display the debug box. Defaults to `vec2(0.05, 0.65)`.
+---
----
+--- @param textTable table An array of strings to display.
---- @usage
+--- @param loc vector2 (Optional) Top-left coordinate for the text box (default: vec2(0.05, 0.65)).
---- ```lua
+---
---- debugScaleForm({
+--- @usage
----     "Player Position: X=123.45 Y=678.90 Z=12.34",
+--- ```lua
----     "Current Action: Running",
+---CreateThread(function()
---- })
+---     while true do
---- ```
+---         debugScaleForm({
-function debugScaleForm(textTable, loc)
+---             "Line 1: Debug info",
-    if debugMode then
+---             "Line 2: More info"
-        -- Define the display position (top left corner)
+---         })
-        local loc = loc or vec2(0.05, 0.65)
+---         Wait(0)
-
+---     end
-        -- Calculate dynamic height based on the number of lines in the textTable
+---end)
-        local lineHeight = 0.025  -- Height of each line of text
+--- ```
-        local totalHeight = #textTable * lineHeight  -- Dynamic height based on number of lines
+function debugScaleForm(textTable, loc)
-        local boxPadding = 0.01  -- Padding to add around the text inside the box
+    if debugMode then
-        local size = vec2(0.18, totalHeight + boxPadding * 2)  -- Width remains fixed, height is dynamic
+        loc = loc or vec2(0.05, 0.65)
-
+
-        DrawRect(loc.x + size.x / 2, loc.y + size.y / 2, size.x, size.y, 0, 0, 0, 255)
+        local lineHeight = 0.025        -- Height per line.
-
+        local totalHeight = #textTable * lineHeight
-        for i = 1, #textTable do
+        local boxPadding = 0.01         -- Padding around the text.
-            local textLine = textTable[i]
+        local size = vec2(0.18, totalHeight + boxPadding * 2)
-
+
-            SetTextScale(0.30, 0.30)
+        -- Draw background rectangle.
-
+        DrawRect(loc.x + size.x / 2, loc.y + size.y / 2, size.x, size.y, 0, 0, 0, 200)
-            BeginTextCommandDisplayText("STRING")
+
-            AddTextComponentSubstringKeyboardDisplay(textLine)
+        -- Render each line of text.
-
+        for i = 1, #textTable do
-            EndTextCommandDisplayText(loc.x + 0.005, loc.y + (i - 1) * lineHeight + 0.01)
+            SetTextScale(0.30, 0.30)
-        end
+            BeginTextCommandDisplayText("STRING")
-    end
+            AddTextComponentSubstringKeyboardDisplay(textTable[i])
-end
+            EndTextCommandDisplayText(loc.x + 0.005, loc.y + (i - 1) * lineHeight + 0.01)
+        end
+    end
+end

shared/scaleforms/instructionalButtons.lua

@@ -1,50 +1,110 @@
---- Creates instructional buttons using the detected polyzone library (ox_lib or PolyZone).
+-------------------------------------------------------------
----
+-- Instructional Buttons Functionality
---- This function generates instructional buttons on the player's screen based on the provided information.
+-------------------------------------------------------------
---- It supports different polyzone libraries by automatically detecting which one is active.
+
----
+--- Loads and draws instructional buttons on-screen using a scaleform movie.
----@param info table A table containing the instructional buttons configuration.
+---
---- - **keys** (`table`): A list of control keys to display.
+--- Requests the "instructional_buttons" scaleform, clears previous data, sets clear space,
---- - **text** (`string`): The description text for the buttons.
+--- creates data slots for each button option provided in `info`, and then draws the scaleform fullscreen.
----
+---
----@usage
+--- @param info table An array of tables, where each table represents a button option:
---- ```lua
+---     - keys (table): An array of key codes (e.g., {38, 29}) to display.
---- makeInstructionalButtons({
+---     - text (string): The label for the button.
----     { keys = { 38 }, text = "Interact" },
+---
----     { keys = { 47 }, text = "Pick Up" },
+--- @usage
---- })
+--- ```lua
---- ```
+---CreateThread(function()
-function makeInstructionalButtons(info)
+---    while true do
-    local build = RequestScaleformMovie("instructional_buttons")
+---         makeInstructionalButtons({
-    while not HasScaleformMovieLoaded(build) do Wait(0) end
+---             { keys = {38, 29}, text = "Open Menu" },
-
+---             { keys = {45}, text = "Close Menu" }
-    DrawScaleformMovieFullscreen(build, 255, 255, 255, 0, 0)
+---         })
-    BeginScaleformMovieMethod(build, "CLEAR_ALL")
+---         Wait(0)
-    EndScaleformMovieMethod()
+---    end
-    BeginScaleformMovieMethod(build, "SET_CLEAR_SPACE")
+---end)
-    ScaleformMovieMethodAddParamInt(200)
+--- ```
-    EndScaleformMovieMethod()
+function makeInstructionalButtons(info)
-
+    local build = RequestScaleformMovie("instructional_buttons")
-    for i = 1, #info do
+    while not HasScaleformMovieLoaded(build) do Wait(0) end
-        BeginScaleformMovieMethod(build, "SET_DATA_SLOT")
+
-        ScaleformMovieMethodAddParamInt(i - 1)
+    -- Draw the scaleform fullscreen (initial draw).
-        for k = 1, #info[i].keys do
+    DrawScaleformMovieFullscreen(build, 255, 255, 255, 0, 0)
-            ScaleformMovieMethodAddParamPlayerNameString(GetControlInstructionalButton(2, info[i].keys[k], true))
+
-        end
+    -- Clear previous instructions.
-        BeginTextCommandScaleformString("STRING")
+    BeginScaleformMovieMethod(build, "CLEAR_ALL")
-        AddTextComponentSubstringKeyboardDisplay(info[i].text)
+    EndScaleformMovieMethod()
-        EndTextCommandScaleformString()
+
-        EndScaleformMovieMethod()
+    -- Set clear spacing between buttons.
-    end
+    BeginScaleformMovieMethod(build, "SET_CLEAR_SPACE")
-
+    ScaleformMovieMethodAddParamInt(200)
-    BeginScaleformMovieMethod(build, "DRAW_INSTRUCTIONAL_BUTTONS")
+    EndScaleformMovieMethod()
-    EndScaleformMovieMethod()
+
-    BeginScaleformMovieMethod(build, "SET_BACKGROUND_COLOUR")
+    -- Add each button option to the scaleform.
-    ScaleformMovieMethodAddParamInt(0)
+    for i = 1, #info do
-    ScaleformMovieMethodAddParamInt(0)
+        BeginScaleformMovieMethod(build, "SET_DATA_SLOT")
-    ScaleformMovieMethodAddParamInt(0)
+        ScaleformMovieMethodAddParamInt(i - 1)
-    ScaleformMovieMethodAddParamInt(80)
+        for k = 1, #info[i].keys do
-    EndScaleformMovieMethod()
+            ScaleformMovieMethodAddParamPlayerNameString(GetControlInstructionalButton(2, info[i].keys[k], true))
-
+        end
-    DrawScaleformMovieFullscreen(build, 255, 255, 255, 255, 0)
+        BeginTextCommandScaleformString("STRING")
-end
+        AddTextComponentSubstringKeyboardDisplay(info[i].text)
+        EndTextCommandScaleformString()
+        EndScaleformMovieMethod()
+    end
+
+    -- Draw the instructional buttons.
+    BeginScaleformMovieMethod(build, "DRAW_INSTRUCTIONAL_BUTTONS")
+    EndScaleformMovieMethod()
+
+    -- Set a translucent black background.
+    BeginScaleformMovieMethod(build, "SET_BACKGROUND_COLOUR")
+    ScaleformMovieMethodAddParamInt(0)
+    ScaleformMovieMethodAddParamInt(0)
+    ScaleformMovieMethodAddParamInt(0)
+    ScaleformMovieMethodAddParamInt(80)
+    EndScaleformMovieMethod()
+
+    -- Final full-screen draw with full opacity.
+    DrawScaleformMovieFullscreen(build, 255, 255, 255, 255, 0)
+end
+
+-- EXPERIMENTAL --
+-- RedM Button Prompts --
+-- Creates the promot, then shows it, this needs to be run in a loop
+local promptGroups = {}
+
+function makeRedInstructionalButtons(info, title)
+    if not promptGroups[title] then  -- Create group if not exists
+        promptGroups[title] = {
+            title = CreateVarString(10, 'LITERAL_STRING', title),
+            id = GetRandomIntInRange(0, 0xffffff),
+            prompts = {},
+        }
+        for i = 1, #info do
+            promptGroups[title].prompts[i] = {
+                keys = info[i].keys,
+                text = info[i].text,
+            }
+            local keyTitle = CreateVarString(10, 'LITERAL_STRING', info[i].text)
+            -- Create one prompt per entry
+            local promptSet = UiPromptRegisterBegin()
+            -- Register all keys for this prompt
+            for k = 1, #info[i].keys do
+                PromptSetControlAction(promptSet, info[i].keys[k])
+            end
+            PromptSetText(promptSet, keyTitle)
+            PromptSetEnabled(promptSet, true)
+            PromptSetVisible(promptSet, true)
+            PromptSetGroup(promptSet, promptGroups[title].id)
+            PromptRegisterEnd(promptSet)
+        end
+    end
+    PromptSetActiveGroupThisFrame(promptGroups[title].id, promptGroups[title].title)
+end
+
+onResourceStop(function()
+    for k, v in pairs(promptGroups) do
+        print("^5Bridge^7: ^2Removing Prompt Group^7: ^3" .. k .. "^7")
+        PromptDelete(promptGroups[k].id, 1)
+    end
+end, true)

shared/scaleforms/scaleform_basic.lua

@@ -0,0 +1,115 @@
+-------------------------------------------------------------
+-- 3D Text Rendering
+-------------------------------------------------------------
+
+--- Draws 3D text at specified world coordinates.
+---
+--- Configures text properties, draws the text, and displays a background rectangle behind it.
+---
+--- @param coord table A vector3 with x, y, and z coordinates.
+--- @param text string The text to display.
+--- @param highlight boolean (Optional) If true, highlights parts of the text.
+---
+--- @usage
+--- ```lua
+--- CreateThread(function()
+---     while true do
+---         DrawText3D(vector3(100, 200, 300), "Hello World", true)
+---         Wait(0)
+---     end
+--- end)
+--- ```
+function DrawText3D(coord, text, highlight)
+    SetTextScale(0.30, 0.30)
+    SetTextFont(0)
+    SetTextProportional(1)
+    SetTextColour(255, 255, 255, 215)
+    SetTextEntry("STRING")
+    SetTextCentre(true)
+
+    local totalLength = string.len(text)
+    local textMaxLength = 99 -- max 99
+    local text = totalLength > textMaxLength and text:sub(1, totalLength - (totalLength - textMaxLength)) or text
+    AddTextComponentString(highlight and text:gsub("%~w~", "~y~") or text)
+    SetDrawOrigin(coord.x, coord.y, coord.z, 0)
+    DrawText(0.0, 0.0)
+    local count, length = GetLineCountAndMaxLength(text)
+
+    local padding = 0.005
+    local heightFactor = (count / 43) + padding
+    local weightFactor = (length / 150) + padding
+
+    local height = (heightFactor / 2) - padding / 1
+    local width = (weightFactor / 2) - padding / 1
+
+    DrawRect(0.0, height, width, heightFactor, 0, 0, 0, 150)
+    ClearDrawOrigin()
+end
+
+--- Calculates the number of lines and the maximum line length from the given text.
+---
+--- @param text string The text to analyze.
+--- @return number, number The line count and maximum line length.
+---
+--- @usage
+--- ```lua
+--- local count, maxLen = GetLineCountAndMaxLength("Hello World")
+--- ```
+function GetLineCountAndMaxLength(text)
+    local lineCount, maxLength = 0, 0
+    for line in text:gmatch("[^\n]+") do
+        lineCount += 1
+        local lineLength = string.len(line)
+        if lineLength > maxLength then
+            maxLength = lineLength
+        end
+    end
+    if lineCount == 0 then lineCount = 1 end
+    return lineCount, maxLength
+end
+
+-------------------------------------------------------------
+-- Additional UI Helpers
+-------------------------------------------------------------
+
+--- Displays a help message on the screen.
+---
+--- @param text string The message to display.
+---
+--- @usage
+--- ```lua
+--- DisplayHelpMsg("Press E to interact")
+--- ```
+function DisplayHelpMsg(text)
+    BeginTextCommandDisplayHelp("STRING")
+    AddTextComponentScaleform(text)
+    EndTextCommandDisplayHelp(0, true, false, -1)
+end
+
+--- Displays a "Saving/Loading" spinner with a custom message.
+---
+--- @param text string The message to display alongside the spinner.
+---
+--- @usage
+--- ```lua
+--- displaySpinner("Saving data...")
+--- ```
+function displaySpinner(text)
+    BeginTextCommandBusyspinnerOn('STRING')
+    AddTextComponentSubstringPlayerName(text)
+    EndTextCommandBusyspinnerOn(4)
+end
+
+--- Stops the "Saving/Loading" spinner.
+---
+--- This function should only be called client-side.
+---
+--- @usage
+--- ```lua
+--- stopSpinner()
+--- ```
+function stopSpinner()
+    if not isServer() then
+        BusyspinnerOff()
+    end
+end

shared/scaleforms/timerBars.lua

@@ -1,60 +1,78 @@
-function createTimerHud(title, data, alpha)
+--- Creates and displays a timer HUD on the screen.
-    loadTextureDict("timerbars")
+--- Draws a title (if provided) and a series of timer bars from the supplied data.
-
+---
-    local loc = vec2(0.89, 0.90)
+--- @param title string|nil Optional title to display at the top of the HUD.
-    alpha = alpha or 255  -- Default to fully opaque if alpha is not provided
+--- @param data table A table of timer bar entries. Each entry should include:
-
+---     - stat (string): The statistic name.
-    if title then
+---     - value (string): The value to display.
-        local x = loc.x+0.037
+---     - multi (number|nil): Optional, indicates multiple checkpoints (e.g., progress levels).
-        local y = 0.1
+--- @param alpha number|nil Optional alpha value (transparency) for the HUD; defaults to 255.
-
+---
-        DrawSprite("timerbars", "all_black_bg", x, y, 0.12, 0.05, 0.0, 255, 255, 255, alpha)
+--- @usage
-        SetTextScale(0.80, 0.80)
+--- ```lua
-        SetTextWrap(0.75, 0.985)
+--- createTimerHud("Timer", {
-        SetTextJustification(2)
+---     { stat = "Health", value = "85%" },
-        SetTextFont(4)
+---     { stat = "Armor", value = "50%", multi = 2 },
-        SetTextColour(255, 255, 255, alpha)
+---     { stat = "Stamina", value = "100%" },
-        BeginTextCommandDisplayText("STRING")
+--- }, 255)
-        AddTextComponentSubstringKeyboardDisplay("~y~"..title)
+--- ```
-        EndTextCommandDisplayText(x+0.06, y - 0.026)
+function createTimerHud(title, data, alpha)
-    end
+    loadTextureDict("timerbars")
-
+
-    local displayIndex = 0
+    local loc = vec2(0.89, 0.90)
-    for i = #data, 1, -1 do
+    alpha = alpha or 255  -- Default to fully opaque if alpha is not provided
-        local space = 0.044 * displayIndex
+
-
+    if title then
-        DrawSprite("timerbars", "all_black_bg", loc.x+0.02, loc.y - space, 0.15, 0.04, 0.0, 255, 255, 255, alpha)
+        local x = loc.x+0.037
-        SetTextScale(0.0, 0.35)
+        local y = 0.1
-        SetTextWrap(0.5, 0.92)
+
-        SetTextJustification(2)
+        DrawSprite("timerbars", "all_black_bg", x, y, 0.12, 0.05, 0.0, 255, 255, 255, alpha)
-        SetTextColour(255, 255, 255, alpha)
+        SetTextScale(0.80, 0.80)
-        BeginTextCommandDisplayText("STRING")
+        SetTextWrap(0.75, 0.985)
-        AddTextComponentSubstringKeyboardDisplay(data[i].stat:upper())
+        SetTextJustification(2)
-        EndTextCommandDisplayText(loc.x-0.05, (loc.y - space) - 0.0125)
+        SetTextFont(4)
-
+        SetTextColour(255, 255, 255, alpha)
-        SetTextScale(0.55, 0.55)
+        BeginTextCommandDisplayText("STRING")
-        SetTextWrap(0.85, 0.98  - (data[i].multi and 0.026  or 0.0))
+        AddTextComponentSubstringKeyboardDisplay("~y~"..title)
-        SetTextFont(4)
+        EndTextCommandDisplayText(x+0.06, y - 0.026)
-        SetTextJustification(2)
+    end
-        SetTextColour(255, 255, 255, alpha)
+
-        if data[i].multi then
+    local displayIndex = 0
-            local startX = 0.071
+    for i = #data, 1, -1 do
-            DrawSprite("timerbars", "circle_checkpoints",
+        local space = 0.044 * displayIndex
-            loc.x + startX, (loc.y - space)+0.005,
+
-            0.011, 0.018, 0.0, 255, 191, 0, 200)
+        DrawSprite("timerbars", "all_black_bg", loc.x+0.02, loc.y - space, 0.15, 0.04, 0.0, 255, 255, 255, alpha)
-
+        SetTextScale(0.0, 0.35)
-            DrawSprite("timerbars", "circle_checkpoints",
+        SetTextWrap(0.5, 0.92)
-            loc.x + (startX + 0.008), (loc.y - space)+0.005,
+        SetTextJustification(2)
-            0.011, 0.018, 0.0, 255, 191, 0, data[i].multi > 1 and 200 or 75)
+        SetTextColour(255, 255, 255, alpha)
-
+        BeginTextCommandDisplayText("STRING")
-            DrawSprite("timerbars", "circle_checkpoints",
+        AddTextComponentSubstringKeyboardDisplay(data[i].stat:upper())
-            loc.x + (startX + 0.016), (loc.y - space)+0.005,
+        EndTextCommandDisplayText(loc.x-0.05, (loc.y - space) - 0.0125)
-            0.011, 0.018, 0.0, 255, 191, 0, data[i].multi > 2 and 200 or 75)
+
-        end
+        SetTextScale(0.55, 0.55)
-        BeginTextCommandDisplayText("STRING")
+        SetTextWrap(0.85, 0.98  - (data[i].multi and 0.026  or 0.0))
-        AddTextComponentSubstringKeyboardDisplay(data[i].value)
+        SetTextFont(4)
-        EndTextCommandDisplayText(loc.x - 0.02, (loc.y - space) - 0.017)
+        SetTextJustification(2)
-        displayIndex += 1
+        SetTextColour(255, 255, 255, alpha)
-    end
+        if data[i].multi then
-    makeInstructionalButtons({ { text = "Exit", keys = { 194 }}})
+            local startX = 0.071
+            DrawSprite("timerbars", "circle_checkpoints",
+            loc.x + startX, (loc.y - space)+0.005,
+            0.011, 0.018, 0.0, 255, 191, 0, 200)
+
+            DrawSprite("timerbars", "circle_checkpoints",
+            loc.x + (startX + 0.008), (loc.y - space)+0.005,
+            0.011, 0.018, 0.0, 255, 191, 0, data[i].multi > 1 and 200 or 75)
+
+            DrawSprite("timerbars", "circle_checkpoints",
+            loc.x + (startX + 0.016), (loc.y - space)+0.005,
+            0.011, 0.018, 0.0, 255, 191, 0, data[i].multi > 2 and 200 or 75)
+        end
+        BeginTextCommandDisplayText("STRING")
+        AddTextComponentSubstringKeyboardDisplay(data[i].value)
+        EndTextCommandDisplayText(loc.x - 0.02, (loc.y - space) - 0.017)
+        displayIndex += 1
+    end
+    makeInstructionalButtons({ { text = "Exit", keys = { 194 }}})
 end

shared/shops.lua

@@ -0,0 +1,261 @@
+-------------------------------------------------------------
+-- Selling Menu and Animation
+-------------------------------------------------------------
+
+--- Opens a selling menu with available items and prices.
+---
+--- @param data table Contains selling menu data:
+---     - sellTable (`table`) Table with Header and Items (item names and prices).
+---     - ped (optional) (`number`) Ped entity involved.
+---     - onBack (optional) (`function`) Callback for returning.
+--- @usage
+--- ```lua
+--- sellMenu({
+---     sellTable = {
+---         Header = "Sell Items",
+---         Items = {
+---             ["gold_ring"] = 100,
+---             ["diamond"] = 500,
+---         },
+---     },
+---     ped = pedEntity,
+---     onBack = function() print("Returning to previous menu") end,
+--- })
+--- ```
+function sellMenu(data)
+    local origData = data
+    local Menu = {}
+    if data.sellTable.Items then
+        local itemList = {}
+        for k, v in pairs(data.sellTable.Items) do itemList[k] = 1 end
+        local _, hasTable = hasItem(itemList)
+        for k, v in pairsByKeys(data.sellTable.Items) do
+            if Items[k] then
+                Menu[#Menu + 1] = {
+                    isMenuHeader = not hasTable[k].hasItem,
+                    icon = invImg(k),
+                    header = Items[k].label..(hasTable[k].hasItem and "💰 (x"..hasTable[k].count..")" or ""),
+                    txt = Loc[Config.Lan].info["sell_all"]..v.." "..Loc[Config.Lan].info["sell_each"],
+                    onSelect = function()
+                        sellAnim({ item = k, price = v, ped = data.ped, onBack = function() sellMenu(data) end })
+                    end,
+                }
+            end
+        end
+    else
+        for k, v in pairsByKeys(data.sellTable) do
+            if type(v) == "table" then
+                Menu[#Menu + 1] = {
+                    arrow = true,
+                    header = k,
+                    txt = "Amount of items: "..countTable(v.Items),
+                    onSelect = function()
+                        v.onBack = function()
+                            sellMenu(origData)
+                        end
+                        v.sellTable = data.sellTable[k]
+                        sellMenu(v)
+                    end,
+                }
+            end
+        end
+    end
+    openMenu(Menu, {
+        header = data.sellTable.Header or "Amount of items: "..countTable(data.sellTable.Items or data.sellTable),
+        headertxt = data.sellTable.Header and "Amount of items: "..countTable(data.sellTable.Items or data.sellTable),
+        canClose = true,
+        onBack = data.onBack,
+    })
+end
+
+--- Plays the selling animation and processes the sale transaction.
+---
+--- Checks if the player has the item, plays animations, triggers the server event for selling,
+--- and then calls the onBack callback if provided.
+---
+--- @param data table Contains:
+---   `- item: The item to sell.
+---   `- price: Price per item.
+---   `- ped (optional): Ped entity involved.
+---   `- onBack (optional): Callback to call on completion.
+---@usage
+--- ```lua
+--- sellAnim({
+---     item = "gold_ring",
+---     price = 100,
+---     ped = pedEntity,
+---     onBack = function() sellMenu(data) end,
+--- })
+--- ```
+function sellAnim(data)
+    if not hasItem(data.item, 1) then
+        triggerNotify(nil, Loc[Config.Lan].error["dont_have"].." "..Items[data.item].label, "error")
+        return
+    end
+
+    -- Remove any attached clipboard objects.
+    for _, obj in pairs(GetGamePool('CObject')) do
+        for _, model in pairs({ `p_cs_clipboard` }) do
+            if GetEntityModel(obj) == model and IsEntityAttachedToEntity(data.ped, obj) then
+                DeleteObject(obj)
+                DetachEntity(obj, 0, 0)
+                SetEntityAsMissionEntity(obj, true, true)
+                Wait(100)
+                DeleteEntity(obj)
+            end
+        end
+    end
+
+    TriggerServerEvent(getScript().."Sellitems", data)
+    lookEnt(data.ped)
+    local dict = "mp_common"
+    playAnim(dict, "givetake2_a", 0.3, 48)
+    playAnim(dict, "givetake2_b", 0.3, 48, data.ped)
+    Wait(2000)
+    StopAnimTask(PlayerPedId(), dict, "givetake2_a", 0.5)
+    StopAnimTask(data.ped, dict, "givetake2_b", 0.5)
+    if data.onBack then
+        data.onBack()
+    end
+end
+
+--- Server event handler for processing item sales.
+--- Removes sold items from inventory and funds the player based on the sale.
+RegisterNetEvent(getScript().."Sellitems", function(data)
+    local src = source
+    local hasItems, hasTable = hasItem(data.item, 1, src)
+    if hasItems then
+        removeItem(data.item, hasTable[data.item].count, src)
+        fundPlayer((hasTable[data.item].count * data.price), "cash", src)
+    else
+        triggerNotify(nil, Loc[Config.Lan].error["dont_have"].." "..Items[data.item].label, "error", src)
+    end
+end)
+
+-------------------------------------------------------------
+-- Shop Interface
+-------------------------------------------------------------
+
+--- Opens a shop interface for the player.
+---
+--- Checks job/gang restrictions, then uses the active inventory system to open the shop.
+--- @param data table Contains:
+---     - shop (`string`) The shop identifier.
+---     - items (`table`) The items available in the shop.
+---     - coords (`vector3`) where the shop is located.
+---     - job/gang (optional) (`string`) Job or gang requirements.
+---@usage
+--- ```lua
+--- openShop({
+---     shop = "weapon_shop",
+---     items = weaponShopItems,
+---     coords = vector3(100.0, 200.0, 300.0),
+---     job = "police",
+--- })
+--- ```
+function openShop(data)
+    jsonPrint(data)
+    if (data.job or data.gang) and not jobCheck(data.job or data.gang) then return end
+
+    if Config.General.JimShops then
+        TriggerServerEvent("jim-shops:ShopOpen", "shop", data.items.label, data.items)
+
+    elseif isStarted(OXInv) then
+        exports[OXInv]:openInventory('shop', { type = data.shop })
+
+    elseif isStarted(QSInv) or isStarted(CodeMInv) then
+        TriggerServerEvent("inventory:server:OpenInventory", "shop", data.items.label, data.items)
+
+    elseif isStarted(TgiannInv) then
+        TriggerServerEvent(getScript()..':server:openServerShop', data.shop)
+
+    elseif isStarted(QBInv) then
+        if QBInvNew then
+            TriggerServerEvent(getScript()..':server:openServerShop', data.shop)
+        else
+            TriggerServerEvent("inventory:server:OpenInventory", "shop", data.items.label, data.items)
+        end
+
+    elseif isStarted(PSInv) then
+        if QBInvNew then
+            TriggerServerEvent(getScript()..':server:openServerShop', data.shop)
+        else
+            TriggerServerEvent("inventory:server:OpenInventory", "shop", data.items.label, data.items)
+        end
+
+    elseif isStarted(RSGInv) then
+        TriggerServerEvent(getScript()..':server:openServerShop', data.shop)
+    end
+    lookEnt(data.coords)
+end
+
+RegisterNetEvent(getScript()..':server:openServerShop', function(data)
+    if isStarted(QBInv) then
+        exports[QBInv]:OpenShop(source, data)
+    end
+    if isStarted(PSInv) then
+        exports[PSInv]:OpenShop(source, data)
+    end
+    if isStarted(TgiannInv) then
+        exports[TgiannInv]:OpenShop(source, data)
+    end
+    if isStarted(RSGInv) then
+        exports[RSGInv]:OpenShop(source, data)
+    end
+end)
+
+--- Registers a shop with the active inventory system.
+--- Supports either OXInv or QBInv (with QBInvNew flag).
+---
+--- @param name string Unique shop identifier.
+--- @param label string Display name for the shop.
+--- @param items table List of available shop items.
+--- @param society string|nil (Optional) Society identifier for shared shops.
+--- @usage
+--- ```lua
+--- registerShop("weaponShop", "Weapon Shop", weaponItems, "society_weapons")
+--- ```
+function registerShop(name, label, items, society)
+    if isStarted(OXInv) then
+        debugPrint("^6Bridge^7: ^2Registering ^3OX ^2Store^7:", name, label)
+        exports[OXInv]:RegisterShop(name, {
+            name = label,
+            inventory = items,
+            society = society,
+        })
+
+    elseif isStarted(TgiannInv) then
+        debugPrint("^6Bridge^7: ^2Registering ^3Tgiann ^2Store^7:", name, label)
+        exports[TgiannInv]:RegisterShop(name, items)
+
+    elseif isStarted(QBInv) and QBInvNew then
+        debugPrint("^6Bridge^7: ^2Registering ^3QB ^2Store^7:", name, label)
+        exports[QBInv]:CreateShop({
+            name = name,
+            label = label,
+            slots = #items,
+            items = items,
+            society = society,
+        })
+
+    elseif isStarted(PSInv) and QBInvNew then
+        debugPrint("^6Bridge^7: ^2Registering ^3PS ^2Store^7:", name, label)
+        exports[PSInv]:CreateShop({
+            name = name,
+            label = label,
+            slots = #items,
+            items = items,
+            society = society,
+        })
+
+    elseif isStarted(RSGInv) then
+        debugPrint("^6Bridge^7: ^2Registering ^3RSG ^2Store^7:", name, label)
+        exports[RSGInv]:CreateShop({
+            name = name,
+            label = label,
+            slots = #items,
+            items = items,
+            society = society,
+        })
+    end
+end

shared/skillcheck.lua

@@ -0,0 +1,156 @@
+local activeSkillCheck = false
+
+function skillCheck(data)
+    local result = false
+
+    if Config.System.skillCheck == "qb" then
+        local Skillbar = exports["qb-minigames"]:Skillbar()
+        if Skillbar then
+            result = true
+        else
+            result = false
+        end
+
+    elseif Config.System.skillCheck == "ox" then
+        local Skillbar = exports[OXLibExport]:skillCheck(
+            {
+                "easy",
+                "easy",
+                "easy"
+            },
+            {
+                "1",
+                "2",
+                "3",
+                "4"
+            })
+        if Skillbar then
+            result = true
+        else
+            result = false
+        end
+    elseif Config.System.skillCheck == "gta" then
+        loadTextureDict("timerbars")
+        local successes = 0
+        local barsRequired = 3
+
+        for bar = 1, barsRequired do
+            debugPrint("^6Bridge^7: ^2Starting Bar ^3"..bar.."^7/^3"..barsRequired.."^7")
+            activeSkillCheck = true
+            local width, height = 0.2, 0.01
+            local x, y = 0.5, 0.8
+
+            -- Random highlighted zone
+            local highlightSize = math.random(10, 20) / 100
+            local highlightStart = math.random(10, 50) / 100
+            local highlightEnd = highlightStart + highlightSize
+            local highlightAlpha = 0
+            local cursorPos = 0.0
+            local cursorSpeed = 0.025
+            local movingRight = true
+
+            while activeSkillCheck do
+                Wait(0)
+                makeInstructionalButtons({
+                    { keys = { 177 }, text = "Exit" },
+                    { keys = { 38 }, text = "Confirm" },
+                })
+
+                createScaleBars(x, y, width, height)
+
+                local pulse = (math.sin(GetGameTimer() / 250) + 1) / 2 -- Creates a pulsing effect
+                highlightAlpha = math.floor(150 + (pulse * 105)) -- Pulsing between 150 and 255 alpha
+
+                -- Draw highlighted zone (success area) with pulsing effect
+                DrawRect(x - width / 2 + (highlightStart + highlightSize / 2) * width, y, highlightSize * width, height+0.001, 93, 182, 229, highlightAlpha )
+                -- Draw moving cursor
+                DrawRect(x - width / 2 + cursorPos * width, y, 0.002, height + 0.01, 255, 255, 255, 255)
+
+                -- Move cursor
+                if movingRight then
+                    cursorPos += cursorSpeed
+                    if cursorPos >= 1.0 then movingRight = false end
+                else
+                    cursorPos -= cursorSpeed
+                    if cursorPos <= 0.0 then movingRight = true end
+                end
+
+                if IsControlJustPressed(0, 177) then        -- Backspace to cancel
+                    local displayTime = GetGameTimer() + 2000
+                    PlaySoundFrontend(-1, 'Highlight_Cancel', 'DLC_HEIST_PLANNING_BOARD_SOUNDS', 1)
+                    while GetGameTimer() < displayTime do
+                        Wait(0)
+
+                        createScaleBars(x, y, width, height)
+
+                        DrawRect(x - width / 2 + (highlightStart + highlightSize / 2) * width, y, highlightSize * width, height+0.001, 228, 52, 52, 255)
+                        DrawRect(x - width / 2 + cursorPos * width, y, 0.002, height + 0.01, 255, 255, 255, 255)
+
+                        drawSuccessText(x, y, "Failed", 228, 52, 52)
+                    end
+                    return false
+                end
+
+                -- Check for keypress (E)
+                if IsControlJustPressed(0, 38) then
+                    activeSkillCheck = false
+                    result = cursorPos >= highlightStart and cursorPos <= highlightEnd
+                    if result then
+                        PlaySoundFrontend(-1, "YES", "HUD_FRONTEND_DEFAULT_SOUNDSET", true)
+                    else
+                        PlaySoundFrontend(-1, 'Highlight_Cancel', 'DLC_HEIST_PLANNING_BOARD_SOUNDS', 1)
+                    end
+                    local displayTime = GetGameTimer() + 2000
+                    while GetGameTimer() < displayTime do
+                        Wait(0)
+
+                        createScaleBars(x, y, width, height)
+
+                        -- Draw highlighted zone
+                        DrawRect(x - width / 2 + (highlightStart + highlightSize / 2) * width, y, highlightSize * width, height+0.001, result and 93 or 228, result and 182 or 52, result and 229 or 52, 180)
+
+                        -- Draw stationary cursor at result position
+                        DrawRect(x - width / 2 + cursorPos * width, y, 0.002, height + 0.01, 255, 255, 255, 255)
+                        -- Display result text
+                        drawSuccessText(x, y, result and "Success" or "Failed", result and 114 or 228, result and 204 or 52, result and 144 or 52)
+                    end
+                    if result then
+                        successes += 1
+                    else
+                        return false
+                    end
+                end
+            end
+        end
+        activeSkillCheck = false
+        debugPrint("^6Bridge^7: ^2Skill Check Result^7: ^3" .. successes .. "^7/^3" .. barsRequired.."^7")
+        return successes == barsRequired
+    else
+        result = true
+    end
+    return result
+end
+
+function drawSuccessText(x, y, text, r, g, b)
+    SetTextFont(8)
+    SetTextScale(0.45, 0.45)
+    SetTextColour(r, g, b, 255)
+    SetTextDropshadow(0, 0, 0, 0, 255)
+    SetTextEdge(2, 0, 0, 0, 150)
+    SetTextDropShadow()
+    SetTextOutline()
+    SetTextCentre(true)
+    SetTextEntry("STRING")
+    SetTextCentre(true)
+    SetTextEntry("STRING")
+    AddTextComponentString(text)
+    DrawText(x, y + 0.03)
+end
+
+function createScaleBars(x, y, width, height)
+    -- Draw background box
+    DrawSprite("timerbars", "all_black_bg", x - (width / 4) - 0.006, y, (width / 2) + 0.08, height + 0.04, 0.0, 255, 255, 255, 255)
+    DrawSprite("timerbars", "all_black_bg", x + (width / 4) + 0.006, y, (width / 2) + 0.08, height + 0.04, 180.0, 255, 255, 255, 255)
+    -- Draw full bar (dark background)
+    DrawRect(x, y, width, height, 100, 100, 100, 255)
+end

shared/societybank.lua

@@ -0,0 +1,180 @@
+--[[
+    Society Banking Module
+    ------------------------
+    This module provides functions to interact with society bank accounts across
+    different banking systems. Supported systems include:
+      • qb-banking
+      • esx_society *testing*
+      • Renewed-Banking
+      • fd_banking
+      • okokBanking
+]]
+
+--- Retrieves the current balance of a society's bank account.
+--- @param society string The identifier of the society.
+--- @return number number The current account balance.
+--- @usage
+--- ```lua
+--- local balance = getSocietyAccount("police")
+--- print("Police account balance: $"..balance)
+--- ```
+function getSocietyAccount(society)
+    local bankScript, amount = "", 0
+    if society == nil or society == "none" then return amount end
+
+    if isStarted("qb-banking") then
+        bankScript = "qb-banking"
+        if not exports["qb-banking"]:GetAccount(society) then
+            if Jobs[society] then
+                print("^6Bridge^7: ^2Making new bank account in ^7'^3qb-banking^7' ^2for ^7'^3"..society.."^7'")
+                exports["qb-banking"]:CreateJobAccount(society, 0)
+                Wait(150)
+            elseif Gangs[society] then
+                print("^6Bridge^7: ^2Making new bank account in ^7'^3qb-banking^7' ^2for ^7'^3"..society.."^7'")
+                exports["qb-banking"]:CreateGangAccount(society, 0)
+                Wait(150)
+            end
+        end
+        amount = exports["qb-banking"]:GetAccountBalance(society)
+
+    --elseif isStarted("esx_society") then
+    --    bankScript = "esx_society"
+    --    -- Since esx_society does not have a native client export for retrieving money,
+    --    -- we use a server callback to get the final amount.
+    --    amount = triggerCallback(getScript()..":getESXSocietyAccount", society) or 0
+
+    elseif isStarted("Renewed-Banking") then
+        bankScript = "Renewed-Banking"
+        amount = exports["Renewed-Banking"]:getAccountMoney(society)
+
+    elseif isStarted("fd_banking") then
+        bankScript = "fd_banking"
+        amount = exports["fd_banking"]:GetAccount(society)
+
+    elseif isStarted("okokBanking") then
+        bankScript = "okokBanking"
+        amount = exports['okokBanking']:GetAccount(society)
+    end
+
+    if bankScript == "" then
+        print("^1Error^7: ^3GetSocietyAccount^7: ^2No supported banking script found")
+    else
+        debugPrint("^6Bridge^7: ^3"..bankScript.."^7: ^2Retrieved account ^7'^6"..society.."^7' ($"..amount..")")
+    end
+
+    return amount
+end
+
+--- Deducts funds from a society's bank account.
+--- @param society string The identifier of the society.
+--- @param amount number The amount of money to remove.
+--- @usage
+--- ```lua
+--- chargeSociety("police", 1000)
+--- ```
+function chargeSociety(society, amount)
+    local bankScript, newAmount = "", 0
+
+    if isStarted("qb-banking") then
+        bankScript = "qb-banking"
+		if not exports["qb-banking"]:GetAccount(society) then
+            if Jobs[society] then
+                print("^6Bridge^7: ^2Making new bank account in ^7'^3qb-banking^7' ^2for ^7'^3"..society.."^7'")
+                exports["qb-banking"]:CreateJobAccount(society, 0) Wait(150) -- make new account if return "null"
+            elseif Gangs[society] then
+                print("^6Bridge^7: ^2Making new bank account in ^7'^3qb-banking^7' ^2for ^7'^3"..society.."^7'")
+                exports["qb-banking"]:CreateGangAccount(society, 0) Wait(150) -- make new account if return "null"
+            end
+		end
+        exports["qb-banking"]:RemoveMoney(society, amount)
+    --elseif isStarted("esx_society") then
+    --    bankScript = "esx_society"
+    --    TriggerEvent("esx_society:withdrawMoney", society, amount)
+
+    elseif isStarted("Renewed-Banking") then
+        bankScript = "Renewed-Banking"
+        exports['Renewed-Banking']:removeAccountMoney(society, amount)
+
+    elseif isStarted("fd_banking") then
+        bankScript = "fd_banking"
+        exports["fd_banking"]:RemoveMoney(society, amount)
+
+
+    elseif isStarted("okokBanking") then
+        bankScript = "okokBanking"
+        exports['okokBanking']:RemoveMoney(society, amount)
+
+    end
+
+    if bankScript == "" then
+        print("^1Error^7: ^3ChargeSociety^7: ^2No supported banking script found")
+    else
+        newAmount = getSocietyAccount(society)
+        debugPrint("^6Bridge^7: ^3"..bankScript.."^7: ^2Removing $"..amount.." from account '^6"..society.."^7' ($"..newAmount..")")
+    end
+end
+
+--- Adds funds to a society's bank account.
+--- @param society string The identifier of the society.
+--- @param amount number The amount of money to add.
+--- @usage
+--- ```lua
+--- fundSociety("police", 500)
+--- ```
+function fundSociety(society, amount)
+    local bankScript, newAmount = "", 0
+
+
+    if isStarted("qb-banking") then
+        bankScript = "qb-banking"
+        if not exports["qb-banking"]:GetAccount(society) then
+            if Jobs[society] then
+                print("^6Bridge^7: ^2Making new bank account in ^7'^3qb-banking^7' ^2for ^7'^3"..society.."^7'")
+                exports["qb-banking"]:CreateJobAccount(society, 0)
+                Wait(150)
+            elseif Gangs[society] then
+                print("^6Bridge^7: ^2Making new bank account in ^7'^3qb-banking^7' ^2for ^7'^3"..society.."^7'")
+                exports["qb-banking"]:CreateGangAccount(society, 0)
+                Wait(150)
+            end
+        end
+        exports["qb-banking"]:AddMoney(society, amount)
+
+    --elseif isStarted("esx_society") then
+    --    bankScript = "esx_society"
+    --    -- Use the esx_society event to deposit money.
+    --    TriggerServerEvent('esx_society:depositMoney', society, amount)
+    --    -- Use callback to return the updated balance.
+    --    newAmount = triggerCallback(getScript()..":getESXSocietyAccount", society) or 0
+
+    elseif isStarted("Renewed-Banking") then
+            bankScript = "Renewed-Banking"
+            exports['Renewed-Banking']:addAccountMoney(society, amount)
+            newAmount = exports["Renewed-Banking"]:getAccountMoney(society)
+    elseif isStarted("fd_banking") then
+        bankScript = "fd_banking"
+        exports["fd_banking"]:AddMoney(society, amount)
+
+    elseif isStarted("okokBanking") then
+        bankScript = "okokBanking"
+        exports['okokBanking']:AddMoney(society, amount)
+
+    end
+
+    if bankScript == "" then
+        print("^1Error^7: ^3FundSociety^7: ^2No supported banking script found")
+    else
+        newAmount = getSocietyAccount(society)
+        debugPrint("^6Bridge^7: ^3"..bankScript.."^7: ^2Adding ^7$"..amount.." ^2to account ^7'^6"..society.."^7' ($"..newAmount..")")
+    end
+end
+
+
+-- other
+if isStarted("esx_society") then
+    createCallback(getScript()..":getESXSocietyAccount", function(source, society)
+        -- Example query – adjust table/field names to match your esx_society implementation.
+        local result = MySQL.scalar.await('SELECT money FROM society_money WHERE society = ?', { society })
+        return result or 0
+    end)
+end

shared/stashcontrol.lua

@@ -1,271 +1,591 @@
-if isServer() then
+--[[
-    createCallback(getScript()..':server:GetStashItems', function(source, stashName) local stash = getStash(stashName) return stash end)
+    Stash Management Module
-end
+    -------------------------
-
+    This module handles stash-related operations including:
-local stashCache ={}
+      • Retrieving stash items (from server or local cache).
-function GetStashTimeout(stashName, stop)
+      • Checking for required items in stashes.
-    if stop then stashCache = {} return end
+      • Opening stashes using different inventory systems.
-    local stash = stashCache[stashName]
+      • Removing items from stashes.
-    if not stash then
+      • Checking if a stash has specific items.
-        stashCache[stashName] = { items = {}, timeout = 0 }
+]]
-        stash = stashCache[stashName]
+
-    end
+-- Global variable to hold the current stash (used in callbacks).
-    if #stash.items > 0 then return true end
+local stash
-    if stash.timeout <= 0 then
+
-        stash.items = triggerCallback(getScript()..':server:GetStashItems', stashName)
+-- If running on the server, create a callback to retrieve stash items.
-        stash.timeout = 10000
+if isServer() then
-        CreateThread(function()
+    createCallback(getScript()..':server:GetStashItems', function(source, stashName)
-            while stash.timeout > 0 do stash.timeout -= 1000 Wait(1000) end
+        stash = getStash(stashName)
-            stashCache[stashName] = nil
+        return stash
-        end)
+    end)
-    end
+end
-
+
-    return false
+-- Local cache for stashes.
-end
+local stashCache = {}
-
+
-function checkHasItem(stashes, itemTable)
+--- Retrieves (or updates) a local stash cache entry with a timeout.
-    if not stashes then return hasItem(itemTable), nil end
+--- When the cache is empty or expired, it triggers a server callback to update the items.
-    if type(stashes) == "table" then
+---
-        local succeses = 0
+--- @param stashName string The name of the stash.
-        local itemCount = 0
+--- @param stop boolean (Optional) If true, clears the entire stash cache.
-        for _, item in pairs(itemTable) do itemCount += 1 end
+--- @return boolean True if items exist in cache (and recheck is skipped), false otherwise.
-        for _, name in pairs(stashes) do
+---
-            GetStashTimeout(name)
+--- @usage
-            for item, amount in pairs(itemTable) do
+--- ```lua
-                debugPrint("^6Bridge^7: ^2Checking"..(name and " ^7'^6"..name.."^7'" or "").." ^2ingredients^7 - ^6"..item.."^7")
+--- local cached = GetStashTimeout("playerStash")
-                if stashhasItem(stashCache[name].items, item, amount) then
+--- ```
-                    succeses += 1
+function GetStashTimeout(stashName, stop)
-                    if succeses == itemCount then return true, name end
+    if stop then
-                end
+        stashCache = {}
-            end
+        return
-        end
+    end
-    else
+
-        debugPrint("^6Bridge^7: ^2Checking"..(stashes and " ^7'^6"..stashes.."^7'" or "").." ^2ingredients^7 - ^6"..k.."^7")
+    -- Retrieve cache for this stash, or initialize if not present.
-        GetStashTimeout(stashes)
+    stash = stashCache[stashName]
-        return stashhasItem(stashCache[stashes].items, itemTable), stashes
+    if not stash then
-    end
+        debugPrint("^6Bridge^7: ^2Local Stash ^7'^3"..stashName.."^7'^2 cache ^1not ^2found^7, ^2need to grab from server^7")
-
+        stashCache[stashName] = { items = {}, timeout = 0 }
-    return false, nil
+        stash = stashCache[stashName]
-end
+    else
-
+        debugPrint("^6Bridge^7: ^2Local Stash for ^7'^3"..stashName.."^7'^2 cache found^7")
-
+    end
--- Stash Items
+
-function openStash(data)
+    -- If there are already items in cache, skip recheck.
-	if (data.job or data.gang) and not jobCheck(data.job or data.gang) then return end
+    if countTable(stashCache[stashName].items) > 0 then
-    if isStarted(OXInv) then
+        debugPrint("^6Bridge^7: '^3"..stashName.."^7' ^2Items found in local cache, skipping server recheck")
-        exports[OXInv]:openInventory('stash', data.stash)
+        return true
-    elseif isStarted(CodeMInv) then
+    end
-        exports[CodeMInv]:OpenStash(data.stash, StashWeight, 100)
+
-    elseif isStarted(QBInv) then
+    -- If timeout has expired, update the stash items from the server.
-        if QBInvNew then
+    if stashCache[stashName].timeout <= 0 then
-            TriggerServerEvent(getScript()..':server:OpenStashQB', { stashName = data.stash, label = data.label, maxweight = data.maxWeight or 600000, slots = data.slots or 40 })
+        stashCache[stashName].items = triggerCallback(getScript()..':server:GetStashItems', stashName)
-        else
+        stashCache[stashName].timeout = 10000  -- Timeout in milliseconds.
-            TriggerEvent("inventory:client:SetCurrentStash", data.stash)
+        CreateThread(function()
-            TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, data.stashOptions)
+            while stashCache[stashName] and stashCache[stashName].timeout > 0 do
-        end
+                stashCache[stashName].timeout -= 1000
-    else
+                Wait(1000)
-        TriggerEvent("inventory:client:SetCurrentStash", data.stash)
+            end
-        TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, data.stashOptions)
+            debugPrint("^6Bridge^7: ^2Local Stash ^7'^3"..stashName.."^7'^2 cache timed out^7, ^3Clearing^7")
-	end
+            stashCache[stashName] = nil
-    lookEnt(data.coords)
+        end)
-end
+    end
-
+    return false
-RegisterNetEvent(getScript()..':server:OpenStashQB', function(data)
+end
-    exports[QBInv]:OpenInventory(source, data.stashName, data)
+
-end)
+--- Checks if the specified stashes have the required items.
-
+---
-function getStash(stashName) local stashResource = ""
+--- If multiple stashes are provided (as a table), it iterates over each until all required items are found.
-    if type(stashName) ~= "string" then return print("Stash name was not a string %s(%s)", stashName, type(stashName)) end
+---
-    local stashItems, items = {}, {}
+--- @param stashes string|table Either a single stash name or a table of stash names.
-    if isStarted(OXInv) then stashResource = OXInv
+--- @param itemTable table A table where keys are item names and values are the required amounts.
-        stashItems = exports[OXInv]:Inventory(stashName).items
+--- @return boolean, string|nil `boolean, string` true and the stash name if found, otherwise false and nil.
-
+---
-    elseif isStarted(QSInv) then stashResource = QSInv
+--- @usage
-        stashItems = exports[QSInv]:GetStashItems(stashName)
+--- ```lua
-
+--- local found, stashName = checkStashItem({"playerStash", "storageStash"}, { iron = 2, wood = 5 })
-    elseif isStarted(CoreInv) then stashResource = CoreInv
+--- ```
-        stashItems = exports[CoreInv]:getInventory(stashName)
+function checkStashItem(stashes, itemTable)
-
+    if not stashes then
-    elseif isStarted(CodeMInv) then stashResource = CodeMInv
+        return hasItem(itemTable), nil
-        stashItems = exports[CodeMInv]:GetInventoryItems('Stash', stashName)
+    end
-
+
-    elseif isStarted(OrigenInv) then stashResource = OrigenInv
+    if type(stashes) == "table" then
-        stashItems = exports[OrigenInv]:GetStashItems(stashName)
+        debugPrint("^6Bridge^7: ^2Checking multiple stashes for ingredients^7")
-
+        -- Iterate over each provided stash name.
-    elseif isStarted(PSInv) then stashResource = PSInv
+        for _, name in pairs(stashes) do
-        local result = MySQL.scalar.await('SELECT items FROM stashitems WHERE stash = ?', { stashName })
+            GetStashTimeout(name)
-		if result then stashItems = json.decode(result) end
+            if stashhasItem(stashCache[name].items, itemTable, nil) then
-    elseif isStarted(QBInv) then stashResource = QBInv
+                return true, name
-        local result = MySQL.scalar.await("SELECT items FROM "..(QBInvNew and "inventories" or "stashitem").." WHERE identifier = ?", { stashName })
+            end
-        if result then stashItems = json.decode(result) end
+        end
-    end
+    else
-
+        debugPrint("^6Bridge^7: ^2Checking "..(stashes and " '^3"..stashes.."^7'" or "").." ingredients")
-    debugPrint("^6Bridge^7: ^2Retrieving ^3Stash^2 with ^7"..stashResource)
+        GetStashTimeout(stashes)
-    if stashItems then
+        return stashhasItem(stashCache[stashes].items, itemTable), stashes
-        for _, item in pairs(stashItems) do
+    end
-            local itemInfo = Items[item.name:lower()]
+
-            if itemInfo then
+    return false, nil
-                local indexNum = #items+1 -- Added to help recreate missing slot numbers
+end
-                items[(item.slot and item.slot) or indexNum] = {
+
-                    name = itemInfo.name or nil,
+-------------------------------------------------------------
-                    amount = tonumber(item.amount) or tonumber(item.count),
+-- Stash Opening Functions
-                    info = item.info or "",
+-------------------------------------------------------------
-                    label = itemInfo.label or nil,
+
-                    description = itemInfo.description or "",
+--- Opens a stash using the active inventory system.
-                    weight = itemInfo.weight or nil,
+---
-                    type = itemInfo.type or nil,
+--- Checks for job or gang restrictions before opening the stash.
-                    unique = itemInfo.unique or nil,
+---
-                    useable = itemInfo.useable or nil,
+--- @param data table A table containing stash data:
-                    image = itemInfo.image or nil,
+---        - stash (string): The stash identifier.
-                    slot = (item.slot and item.slot) or indexNum,
+---        - label (string): Display label.
-                    metadata = (item.metadata and item.metadata) or nil,
+---        - maxWeight (number|nil): Maximum weight (default 600000).
-                }
+---        - slots (number|nil): Number of slots (default 40).
-            end
+---        - stashOptions (table|nil): Additional options for the stash.
-        end
+---        - job/gang (string|nil): Restriction for access.
-        debugPrint("^6Bridge^7: ^3GetStashItems^7: ^2Stash information for ^7'^6"..stashName.."^7' ^2retrieved^7")
+---        - coords (vector3): Coordinates to "look" at.
-    end
+---
-    return items
+--- @usage
-end
+--- ```lua
-
+--- openStash({ stash = "playerStash", label = "Player Stash", coords = vector3(100, 200, 30) })
-function stashRemoveItem(stashItems, stashName, items) local amount = amount and amount or 1
+--- ```
-    -- print("stashItems: "..json.encode(stashItems, { indent = true}))
+function openStash(data)
-    -- print("stashName: "..json.encode(stashName, { indent = true}))
+    if (data.job or data.gang) and not jobCheck(data.job or data.gang) then return end
-    -- print("items: "..json.encode(items, { indent = true}))
+
-    if isStarted(OXInv) then
+    if isStarted(OXInv) then
-        for k, v in pairs(items) do
+        exports[OXInv]:openInventory('stash', data.stash)
-            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..OXInv, k, v)
+
-            if type(stashName) == "table" then
+    elseif isStarted(CoreInv) then
-                for _, name in pairs(stashName) do
+        TriggerServerEvent('core_inventory:server:openInventory', data.stash, 'stash')
-                    local success = exports[OXInv]:RemoveItem(name, k, v)
+
-                    if success then
+    elseif isStarted(CodeMInv) then
-                        debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..OXInv, k, v)
+        TriggerServerEvent('codem-inventory:server:openstash', data.stash, data.slots, data.maxWeight, data.label)
-                        break
+
-                    end
+    elseif isStarted(OrigenInv) then
-                end
+        exports[OrigenInv]:openInventory('stash', data.stash, { label = data.label })
-            else
+
-                exports[OXInv]:RemoveItem(stashName, k, v)
+    elseif isStarted(TgiannInv) then
-            end
+        TriggerServerEvent(getScript()..':server:openServerStash', {
-        end
+            stashName = data.stash,
-
+            label = data.label,
-    elseif isStarted(QSInv) then
+            maxweight = data.maxWeight or 600000,
-            for k, v in pairs(items) do
+            slots = data.slots or 40
-                for l in pairs(stashItems) do
+        })
-                    if stashItems[l].name == k then
+
-                        if (stashItems[l].amount - v) <= 0 then
+    elseif isStarted(QBInv) then
-                            debugPrint("^6Bridge^7: ^2None of this item left in stash ^3Stash^7", k, v)
+        if QBInvNew then
-                            stashItems[l] = nil
+            TriggerServerEvent(getScript()..':server:openServerStash', {
-                        else
+                stashName = data.stash,
-                            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..QBInv, k, v)
+                label = data.label,
-                            exports[QSInv]:RemoveItemIntoStash(stashName, k, v, l)
+                maxweight = data.maxWeight or 600000,
-                        end
+                slots = data.slots or 40
-                    end
+            })
-                end
+        else
-            end
+            TriggerEvent("inventory:client:SetCurrentStash", data.stash)
-
+            TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, {
-    elseif isStarted(CoreInv) then
+                slots = data.slots or 50,
-        for k, v in pairs(items) do
+                maxWeight = data.maxWeight or 600000
-            exports[CoreInv]:removeItemExact(stashName, k, v)
+            })
-            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..CoreInv, k, v)
+        end
-        end
+
-
+    elseif isStarted(PSInv) then
-    elseif isStarted(CodeMInv) then
+        if QBInvNew then
-        for k, v in pairs(items) do
+            TriggerServerEvent(getScript()..':server:openServerStash', {
-            for l in pairs(stashItems) do
+                stashName = data.stash,
-                if stashItems[l].name == k then
+                label = data.label,
-                    if (stashItems[l].amount - v) <= 0 then
+                maxweight = data.maxWeight or 600000,
-                        debugPrint("^6Bridge^7: ^2None of this item left in stash ^3Stash^7", k, v)
+                slots = data.slots or 40
-                        stashItems[l] = nil
+            })
-                    else
+        else
-                        debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..CodeMInv, k, v)
+            TriggerEvent("inventory:client:SetCurrentStash", data.stash)
-                        stashItems[l].amount -= v
+            TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, {
-                    end
+                slots = data.slots or 50,
-                end
+                maxWeight = data.maxWeight or 600000
-            end
+            })
-        end
+        end
-        debugPrint("^6Bridge^7: ^3saveStash^7: ^2Saving ^3QB^2 stash ^7'^6"..stashName.."^7'")
+
-
+    elseif isStarted(RSGInv) then
-    elseif isStarted(OrigenInv) then
+        TriggerServerEvent(getScript()..':server:openServerStash', {
-        for k, v in pairs(items) do
+            stashName = data.stash,
-            exports[OrigenInv]:RemoveFromStash(stashName, k, v)
+            label = data.label,
-            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..OrigenInv, k, v)
+            maxweight = data.maxWeight or 600000,
-        end
+            slots = data.slots or 40
-
+        })
-    elseif isStarted(PSInv) then
+
-        for k, v in pairs(items) do
+    else
-            for l in pairs(stashItems) do
+        --Fallback to these commands
-                if stashItems[l].name == k then
+        TriggerEvent("inventory:client:SetCurrentStash", data.stash)
-                    if (stashItems[l].amount - v) <= 0 then
+            TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, {
-                        debugPrint("^6Bridge^7: ^2None of this item left in stash ^3Stash^7", k, v)
+                slots = data.slots or 50,
-                        stashItems[l] = nil
+                maxWeight = data.maxWeight or 600000
-                    else
+            })
-                        debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..QBInv, k, v)
+    end
-                        stashItems[l].amount -= v
+
-                    end
+    lookEnt(data.coords)
-                end
+end
-            end
+
-        end
+
-        debugPrint("^6Bridge^7: ^3saveStash^7: ^2Saving ^3QB^2 stash ^7'^6"..stashName.."^7'")
+-- Wrapper function for opening stash from the server.
-        MySQL.Async.insert('INSERT INTO stashitems (stash, items) VALUES (:stash, :items) ON DUPLICATE KEY UPDATE items = :items', { ['stash'] = stashName, ['items'] = json.encode(stashItems) })
+-- Messy but not much else I can do about it.
-    elseif isStarted(QBInv) then
+RegisterNetEvent(getScript()..":server:openServerStash", function(data)
-        if QBInvNew then
+    local src = source
-            for k, v in pairs(items) do
+    if isStarted(TgiannInv) then
-                exports[QBInv]:RemoveItem(stashName[1], k, v, false, 'crafting')
+        exports[TgiannInv]:OpenInventory(source, 'stash', data.stashName, data)
-                debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..QBInv, k, v)
+    end
-            end
+    if isStarted(QBInv) then
-            debugPrint("^6Bridge^7: ^3saveStash^7: ^2Saving ^3QB^2 stash ^7'^6"..stashName[1].."^7'")
+        exports[QBInv]:OpenInventory(source, data.stashName, data)
-            MySQL.Async.insert('INSERT INTO inventories (identifier, items) VALUES (:stash, :items) ON DUPLICATE KEY UPDATE items = :items', { ['stash'] = stashName[1], ['items'] = json.encode(stashItems) })
+    end
-        else
+    if isStarted(PSInv) then
-            for k, v in pairs(items) do
+        exports[PSInv]:OpenInventory(source, data.stashName, data)
-                for l in pairs(stashItems) do
+    end
-                    if stashItems[l].name == k then
+    if isStarted(RSGInv) then
-                        if (stashItems[l].amount - v) <= 0 then
+        exports[RSGInv]:OpenInventory(source, data.stashName, data)
-                            if Config.System.Debug then
+    end
-                                print("^6Bridge^7: ^2None of this item left in stash ^3Stash^7", k, v)
+end)
-                            end
+
-                            stashItems[l] = nil
+
-                        else
+-------------------------------------------------------------
-                            if Config.System.Debug then
+-- Stash Retrieval Function
-                                print("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..QBInv, k, v)
+-------------------------------------------------------------
-                            end
+
-                            stashItems[l].amount -= v
+--- Retrieves stash items from the active inventory system.
-                        end
+---
-                    end
+--- This function converts the raw stash items into a standardized table using the global Items lookup.
-                end
+---
-            end
+--- @param stashName string The identifier for the stash.
-            debugPrint("^6Bridge^7: ^3saveStash^7: ^2Saving ^3QB^2 stash ^7'^6"..stashName.."^7'")
+--- @return stashTable table A table of items from the stash.
-            MySQL.Async.insert('INSERT INTO stashitems (stash, items) VALUES (:stash, :items) ON DUPLICATE KEY UPDATE items = :items', { ['stash'] = stashName, ['items'] = json.encode(stashItems) })
+---
-        end
+--- @usage
-    else
+--- ```lua
-        print("^4ERROR^7: ^2No Inventory detected ^7- ^2Check ^3exports^1.^2lua^7")
+--- local items = getStash("playerStash")
-    end
+--- ```
-end
+function getStash(stashName)
-RegisterNetEvent(getScript()..":server:stashRemoveItem", stashRemoveItem)
+    local stashResource = ""
-
+    if type(stashName) ~= "string" then
-function stashhasItem(stashItems, items, amount)
+        print("^6Bridge^7: ^2Stash name was not a string ^3"..stashName.."^7(^3"..type(stashName).."^7)")
-    local invs = {OXInv, QSInv, CoreInv, CodeMInv, OrigenInv, QBInv, PSInv}
+        return {}
-    local foundInv = ""
+    end
-    for _, inv in ipairs(invs) do
+
-        if isStarted(inv) then
+    local stashItems, items = {}, {}
-            foundInv = inv:gsub("%-", "^7-^6"):gsub("%_", "^7_^6")
+    if isStarted(OXInv) then
-            break
+        stashResource = OXInv
-        end
+        local stash = exports[OXInv]:Inventory(stashName)
-    end
+        -- Add fallback if ox can't find the stash and returns a boolean
-
+        stashItems = type(stash) == "table" and stash.items or {}
-    if type(items) ~= "table" then items = { [items] = amount and amount or 1, } end
+
-    local hasTable = {}
+    elseif isStarted(QSInv) then
-    for item, amount in pairs(items) do
+        stashResource = QSInv
-        local count = 0
+        stashItems = exports[QSInv]:GetStashItems(stashName)
-        for _, itemData in pairs(stashItems) do
+
-            if itemData and (itemData.name == item) then
+    elseif isStarted(CoreInv) then
-                count += (itemData.amount or 1)
+        stashResource = CoreInv
-            end
+        stashItems = exports[CoreInv]:getInventory(stashName)
-        end
+
-
+    elseif isStarted(CodeMInv) then
-        local debugMsg = string.format("^6Bridge^7: ^3stashHasItem^7[^6%s^7]: %s '%s' ^3%d^7/^3%d^7", foundInv, (count >= amount and "^5FOUND^7" or "^1NOT FOUND^7"), item, count, amount)
+        stashResource = CodeMInv
-        debugPrint(debugMsg)
+        stashItems = exports[CodeMInv]:GetStashItems(stashName)
-
+
-        hasTable[item] = { hasItem = (count >= amount), count = count }
+    elseif isStarted(OrigenInv) then
-    end
+        stashResource = OrigenInv
-    for k, v in pairs(hasTable) do if v.hasItem == false then return false, hasTable end end
+        stashItems = exports[OrigenInv]:getInventory(stashName)
-    return true, hasTable
+
-end
+    elseif isStarted(TgiannInv) then
+        stashResource = TgiannInv
+        stashItems = exports[TgiannInv]:GetSecondaryInventoryItems("stash", stashName)
+
+    elseif isStarted(PSInv) then
+        stashResource = PSInv
+        local result = MySQL.scalar.await('SELECT items FROM stashitems WHERE stash = ?', { stashName })
+		if result then stashItems = json.decode(result) end
+
+    elseif isStarted(QBInv) then
+        stashResource = QBInv
+        if QBInvNew then
+            local result = exports[QBInv]:GetInventory(stashName) or {}
+            stashItems = result.items or {}
+        else
+            local result = MySQL.scalar.await("SELECT items FROM stashitems WHERE stash = ?", { stashName })
+            if result then stashItems = json.decode(result) end
+        end
+
+    elseif isStarted(RSGInv) then
+        stashResource = RSGInv
+        stashItems = exports[RSGInv]:GetInventory(stashName)
+
+    end
+
+    debugPrint("^6Bridge^7: ^2Retrieving ^3Stash^2 with ^7"..stashResource)
+    if stashItems then
+        for _, item in pairs(stashItems) do
+            local itemInfo = Items[item.name:lower()]
+            if itemInfo then
+                local indexNum = #items + 1  -- Fallback index if slot is missing.
+                items[(item.slot or indexNum)] = {
+                    name = itemInfo.name or nil,
+                    amount = tonumber(item.amount) or tonumber(item.count),
+                    info = item.info or "",
+                    label = itemInfo.label or nil,
+                    description = itemInfo.description or "",
+                    weight = itemInfo.weight or nil,
+                    type = itemInfo.type or nil,
+                    unique = itemInfo.unique or nil,
+                    useable = itemInfo.useable or nil,
+                    image = itemInfo.image or nil,
+                    slot = (item.slot and item.slot) or indexNum,
+                    metadata = (item.metadata and item.metadata) or nil,
+                }
+            end
+        end
+        debugPrint("^6Bridge^7: ^3GetStashItems^7: ^2Stash information for '^6"..stashName.."^7' retrieved")
+    end
+    jsonPrint(items)
+    return items
+end
+
+-------------------------------------------------------------
+-- Stash Item Removal Function
+-------------------------------------------------------------
+
+--- Removes items from a stash using the active inventory system.
+---
+--- Iterates over the provided items and adjusts the stash contents accordingly.
+---
+--- @param stashItems table The current stash items.
+--- @param stashName string|table The stash identifier (or table of identifiers).
+--- @param items table A table of items to remove (keys are item names, values are amounts).
+---
+--- @usage
+--- ```lua
+--- stashRemoveItem(currentItems, "playerStash", { iron = 2, wood = 5 })
+--- ```
+function stashRemoveItem(stashItems, stashName, items)
+    if type(stashName) ~= "table" then
+        stashName = { stashName }
+    end
+
+    if isStarted(OXInv) then
+        for k, v in pairs(items) do
+            for _, name in pairs(stashName) do
+                local success = exports[OXInv]:RemoveItem(name, k, v)
+                if success then
+                    debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..OXInv, k, v)
+                    break
+                end
+            end
+        end
+
+    elseif isStarted(QSInv) then
+        for k, v in pairs(items) do
+            exports[QSInv]:RemoveItemIntoStash(stashName[1], k, v)
+            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..QSInv, k, v)
+        end
+
+    elseif isStarted(CoreInv) then
+        for k, v in pairs(items) do
+            exports[CoreInv]:removeItemExact(stashName[1], k, v)
+            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..CoreInv, k, v)
+        end
+
+    elseif isStarted(CodeMInv) then
+        for k, v in pairs(items) do
+            for l in pairs(stashItems) do
+                if stashItems[l].name == k then
+                    if (stashItems[l].amount - v) <= 0 then
+                        debugPrint("^6Bridge^7: ^2None of this item left in stash ^3Stash^7", k, v)
+                        stashItems[l] = nil
+                    else
+                        debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..CodeMInv, k, v)
+                        stashItems[l].amount -= v
+                    end
+                end
+            end
+        end
+        exports[CodeMInv]:UpdateStash(stashName[1], stashItems)
+        debugPrint("^6Bridge^7: ^3saveStash^7: ^2Saving ^3CodeM^2 stash ^7'^6"..stashName.."^7'")
+
+    elseif isStarted(OrigenInv) then
+        for k, v in pairs(items) do
+            exports[OrigenInv]:RemoveFromStash(stashName[1], k, v)
+            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..OrigenInv, k, v)
+        end
+
+    elseif isStarted(TgiannInv) then
+        for k, v in pairs(items) do
+            local itemData = exports[TgiannInv]:GetItemByNameFromSecondaryInventory("stash", stashName[1], k)
+            exports[TgiannInv]:RemoveItemFromSecondaryInventory("stash", stashName[1], k, v, itemData.slot, nil)
+            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..TgiannInv, k, v)
+        end
+
+    elseif isStarted(QBInv) then
+        if QBInvNew then
+            for k, v in pairs(items) do
+                exports[QBInv]:RemoveItem(stashName[1], k, v, false, 'crafting')
+                debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..QBInv, k, v)
+            end
+        else
+            for k, v in pairs(items) do
+                for l in pairs(stashItems) do
+                    if stashItems[l].name == k then
+                        if (stashItems[l].amount - v) <= 0 then
+                            debugPrint("^6Bridge^7: ^2None of this item left in stash ^3Stash^7", k, v)
+                            stashItems[l] = nil
+                        else
+                            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with "..QBInv, k, v)
+                            stashItems[l].amount -= v
+                        end
+                    end
+                end
+            end
+            debugPrint("^6Bridge^7: ^3saveStash^7: ^2Saving ^3QB^2 stash '^6"..stashName[1].."^7'")
+            MySQL.Async.insert('INSERT INTO stashitems (stash, items) VALUES (:stash, :items) ON DUPLICATE KEY UPDATE items = :items', {
+                ['stash'] = stashName[1],
+                ['items'] = json.encode(stashItems)
+            })
+        end
+
+    elseif isStarted(PSInv) then
+        for k, v in pairs(items) do
+            for l in pairs(stashItems) do
+                if stashItems[l].name == k then
+                    if (stashItems[l].amount - v) <= 0 then
+                        debugPrint("^6Bridge^7: ^2None of this item left in stash ^3Stash^7", k, v)
+                        stashItems[l] = nil
+                    else
+                        debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..PSInv, k, v)
+                        stashItems[l].amount -= v
+                    end
+                end
+            end
+        end
+        debugPrint("^6Bridge^7: ^3saveStash^7: ^2Saving ^3PS^2 stash ^7'^6"..stashName[1].."^7'")
+        MySQL.Async.insert('INSERT INTO stashitems (stash, items) VALUES (:stash, :items) ON DUPLICATE KEY UPDATE items = :items', {
+            ['stash'] = stashName[1],
+            ['items'] = json.encode(stashItems)
+        })
+
+    elseif isStarted(RSGInv) then
+        for k, v in pairs(items) do
+            exports[RSGInv]:RemoveItem(stashName[1], k, v, false, 'crafting')
+            debugPrint("^6Bridge^7: ^2Removing item from ^3Stash^2 with ^7"..RSGInv, k, v)
+        end
+    else
+        print("^4ERROR^7: ^2No Inventory detected ^7- ^2Check ^3starter^1.^2lua^7")
+    end
+end
+RegisterNetEvent(getScript()..":server:stashRemoveItem", stashRemoveItem)
+
+-------------------------------------------------------------
+-- Stash Item Availability Check
+-------------------------------------------------------------
+
+--- Checks whether a stash has the required amount of specific items.
+---
+--- It iterates through the provided items and tallies available quantities.
+---
+--- @param stashItems table The items available in the stash.
+--- @param items string|table The item name or table of required items (key: item, value: amount).
+--- @param amount number (Optional) The required amount (if a single item is provided).
+--- @return boolean, table (`boolean, string`) Returns true (and a table with counts) if all items are available; false otherwise.
+---
+--- @usage
+--- ```lua
+--- local hasAll, details = stashhasItem(currentStashItems, { iron = 2, wood = 5 })
+--- ```
+function stashhasItem(stashItems, items, amount)
+    local invs = { OXInv, QSInv, CoreInv, CodeMInv, OrigenInv, TgiannInv, QBInv, PSInv, RSGInv }
+    local foundInv = ""
+    for _, inv in ipairs(invs) do
+        if isStarted(inv) then
+            foundInv = inv:gsub("%-", "^7-^6"):gsub("%_", "^7_^6")
+            break
+        end
+    end
+
+    -- Ensure items is a table.
+    if type(items) ~= "table" then items = { [items] = amount and amount or 1, } end
+
+    local hasTable = {}
+    for item, requiredAmount in pairs(items) do
+        local count = 0
+        for _, itemData in pairs(stashItems) do
+            if itemData and (itemData.name == item) then
+                count += (itemData.amount or 1)
+            end
+        end
+
+        local debugMsg = string.format("^6Bridge^7: ^3stashHasItem^7[^6%s^7]: %s '%s' ^3%d^7/^3%d^7", foundInv, (count >= requiredAmount and "^5FOUND^7" or "^1NOT FOUND^7"), item, count, requiredAmount)
+        debugPrint(debugMsg)
+
+        hasTable[item] = { hasItem = (count >= requiredAmount), count = count }
+    end
+
+    for k, v in pairs(hasTable) do if v.hasItem == false then return false, hasTable end end
+
+    return true, hasTable
+end
+
+
+--- Registers a stash with the active inventory system.
+--- Supports either OXInv or QSInv.
+---
+--- @param name string Unique stash identifier.
+--- @param label string Display name for the stash.
+--- @param slots number|nil (Optional) Number of slots (default 50).
+--- @param weight number|nil (Optional) Maximum weight (default 4000000).
+--- @param owner string|nil (Optional) Owner identifier for personal stashes.
+--- @param coords table|nil (Optional) Coordinates for the stash location.
+--- @usage
+--- ```lua
+--- registerStash(
+---     "playerStash",
+---     "Player Stash",
+---     100,
+---     8000000,
+---     "player123",
+---     { x = 100.0, y = 200.0, z = 30.0 }
+--- )
+--- ```
+function registerStash(name, label, slots, weight, owner, coords)
+    if isStarted(OXInv) then
+        debugPrint("^6Bridge^7: ^2Registering ^3OX ^2Stash^7:", name, label, owner or nil)
+        exports[OXInv]:RegisterStash(name, label, slots or 50, weight or 4000000, owner or nil)
+
+    elseif isStarted(QSInv) then
+        debugPrint("^6Bridge^7: ^2Registering ^3QS ^2Stash^7:", name, label)
+        exports[QSInv]:RegisterStash(name, label, slots or 50, weight or 4000000)
+
+    --elseif isStarted(CoreInv) then
+    --    debugPrint("^6Bridge^7: ^2Registering ^3CoreInv ^2Stash^7:", name, label)
+    --    exports[CoreInv]:openHolder(nil, name, 'stash', nil, nil, false, nil)
+
+    elseif isStarted(OrigenInv) then
+        debugPrint("^6Bridge^7: ^2Registering ^3OrigenInv ^2Stash^7:", name, label)
+        exports["origen_inventory"]:registerStash(name, label, slots or 50, weight or 4000000)
+
+    elseif isStarted(TgiannInv) then
+        debugPrint("^6Bridge^7: ^2Registering ^3TgiannInv ^2Stash^7:", name, label)
+        exports[TgiannInv]:RegisterStash(name, label, slots or 50, weight or 4000000)
+
+    end
+end
+
+if isServer() then
+    --- Registers an event to create an OX stash from the server.
+    --- When triggered, it calls registerStash with the provided parameters.
+    ---
+    --- @event server:makeOXStash
+    --- @param name string Unique stash identifier.
+    --- @param label string Display name for the stash.
+    --- @param slots number|nil (Optional) Number of slots.
+    --- @param weight number|nil (Optional) Maximum weight.
+    --- @param owner string|nil (Optional) Owner identifier.
+    --- @param coords table|nil (Optional) Stash coordinates.
+    --- @usage
+    --- ```lua
+    --- TriggerEvent(getScript()..":server:makeOXStash", name, label, slots, weight, owner, coords, token)
+    --- ```
+    RegisterNetEvent(getScript()..":server:makeOXStash", function(name, label, slots, weight, owner, coords, token)
+        local src = source or nil
+        if src then
+            if not checkToken(src, token, "stash", name) then
+                return
+            end
+        end
+
+        registerStash(name, label, slots, weight, owner, coords)
+    end)
+end
+
+RegisterNetEvent(getScript()..":openGrabBox", function(data)
+	if isStarted(OXInv) then
+		return
+	end
+	local id = ""
+	if data.metadata then
+		id = data.metadata.id
+	elseif data.info then
+		id = data.info.id
+	end
+	openStash({
+		stash = id,
+	})
+end)

shared/vehicles.lua

@@ -1,250 +1,301 @@
--- Get Vehicle Info --
+--[[
-local lastCar = nil
+    Vehicle Info & Properties Module
-local carInfo = {}
+    ----------------------------------
-
+    This module provides utilities for:
---- Searches the 'Vehicles' table for a specific vehicle's 'name', 'price', and 'class'.
+      - Retrieving vehicle information from a Vehicles table.
----
+      - Getting and setting vehicle properties using the active framework.
---- This function checks if the provided vehicle is different from the last searched vehicle.
+      - Comparing vehicle property differences.
---- If it's a new vehicle, it retrieves its model and searches the 'Vehicles' table for matching entries.
+      - Synchronizing vehicle properties across clients.
---- It populates the `carInfo` table with the vehicle's name, price, and class.
+      - Managing network control of vehicles.
---- If the vehicle is not found in the table, it defaults to using the vehicle's display name and sets the price to 0.
+      - Finding the closest vehicle to a given position.
----
+]]
----@param vehicle number The entity ID of the vehicle to search for.
+
----
+-- Cached vehicle info to avoid unnecessary re-searches.
----@return table|nil table containing the vehicle's `name`, `price`, and `class`, or `nil` if the vehicle is invalid.
+local lastCar, carInfo = nil, {}
----
+
----@usage
+--- Searches the 'Vehicles' table for a specific vehicle's details.
---- ```lua
+--- If the vehicle differs from the last searched, it retrieves its model and updates the carInfo table.
---- local info = searchCar(vehicleEntity)
+--- The table includes the vehicle's name, price, and class information.
---- print(info.name, info.price, info.class)
+---
---- ```
+--- @param vehicle number The entity ID of the vehicle to search for.
-function searchCar(vehicle)
+--- @return table|nil table A table containing the vehicle's details or nil if the vehicle is invalid.
-    if lastCar ~= vehicle then -- If same car, use previous info
+---
-        lastCar = vehicle
+--- @usage
-        carInfo = {}
+--- ```lua
-        local model = GetEntityModel(vehicle)
+--- local info = searchCar(vehicleEntity)
-        local classlist = {
+--- print(info.name, info.price, info.class.name, info.class.index)
-            "Compacts",          --1
+--- ```
-            "Sedans",            --2
+function searchCar(vehicle)
-            "SUVs",              --3
+    if lastCar ~= vehicle then -- If same car, use previous info
-            "Coupes",            --4
+        lastCar = vehicle
-            "Muscle",            --5
+        carInfo = {}
-            "Sports Classics",   --6
+        local model = GetEntityModel(vehicle)
-            "Sports",            --7
+        local classlist = {
-            "Super",             --8
+            "Compacts",          --1
-            "Motorcycles",       --9
+            "Sedans",            --2
-            "Off-road",          --10
+            "SUVs",              --3
-            "Industrial",        --11
+            "Coupes",            --4
-            "Utility",           --12
+            "Muscle",            --5
-            "Vans",              --13
+            "Sports Classics",   --6
-            "Cycles",            --14
+            "Sports",            --7
-            "Boats",             --15
+            "Super",             --8
-            "Helicopters",       --16
+            "Motorcycles",       --9
-            "Planes",            --17
+            "Off-road",          --10
-            "Service",           --18
+            "Industrial",        --11
-            "Emergency",         --19
+            "Utility",           --12
-            "Military",          --20
+            "Vans",              --13
-            "Commercial",        --21
+            "Cycles",            --14
-            "Trains",            --22
+            "Boats",             --15
-        }
+            "Helicopters",       --16
-        if Vehicles then
+            "Planes",            --17
-            for k, v in pairs(Vehicles) do
+            "Service",           --18
-                if tonumber(v.hash) == model or GetHashKey(v.hash) == model or GetHashKey(v.model) == model then
+            "Emergency",         --19
-                    debugPrint("^6Bridge^7: ^2Vehicle info found in^7 ^4Vehicles^7 ^2table^7: ^6"..(v.hash and v.hash or v.model).. " ^7(^6"..Vehicles[k].name.."^7)")
+            "Military",          --20
-                    carInfo.name = Vehicles[k].name.." "..Vehicles[k].brand
+            "Commercial",        --21
-                    carInfo.price = Vehicles[k].price
+            "Trains",            --22
-                    carInfo.class = classlist[GetVehicleClass(vehicle) + 1], GetVehicleClass(vehicle)
+        }
-                    break
+        if Vehicles then
-                end
+            for k, v in pairs(Vehicles) do
-            end
+                if tonumber(v.hash) == model or GetHashKey(v.hash) == model or GetHashKey(v.model) == model then
-
+                    debugPrint("^6Bridge^7: ^2Vehicle info found in^7 ^4Vehicles^7 ^2table^7: ^6"..(v.hash and v.hash or v.model).. " ^7(^6"..Vehicles[k].name.."^7)")
-            if not carInfo.name then
+                    carInfo.name = Vehicles[k].name.." "..Vehicles[k].brand
-                debugPrint("^6Bridge^7: ^2Vehicle ^1not ^2found in ^4vehicles^7 ^2table^7: ^6"..model.." ^7(^6"..GetDisplayNameFromVehicleModel(model):lower().."^7)")
+                    carInfo.price = Vehicles[k].price
-                carInfo.name = string.upper(GetMakeNameFromVehicleModel(model).." "..GetDisplayNameFromVehicleModel(model))
+                    carInfo.class = classlist[GetVehicleClass(vehicle) + 1], GetVehicleClass(vehicle)
-                carInfo.price = 0
+                    break
-                carInfo.class = classlist[GetVehicleClass(vehicle) + 1], GetVehicleClass(vehicle)
+                end
-            end
+            end
-            return carInfo
+
-        else
+            if not carInfo.name then
-            if not carInfo.name then
+                debugPrint("^6Bridge^7: ^2Vehicle ^1not ^2found in ^4vehicles^7 ^2table^7: ^6"..model.." ^7(^6"..GetDisplayNameFromVehicleModel(model):lower().."^7)")
-                debugPrint("^6Bridge^7: ^2Vehicle ^1not ^2found in ^4vehicles^7 ^2table^7: ^6"..model.." ^7(^6"..GetDisplayNameFromVehicleModel(model):lower().."^7)")
+                carInfo.name = string.upper(GetMakeNameFromVehicleModel(model).." "..GetDisplayNameFromVehicleModel(model))
-                carInfo.name = string.upper(GetMakeNameFromVehicleModel(model).." "..GetDisplayNameFromVehicleModel(model))
+                carInfo.price = 0
-                carInfo.price = 0
+                carInfo.class = classlist[GetVehicleClass(vehicle) + 1], GetVehicleClass(vehicle)
-                carInfo.class = classlist[GetVehicleClass(vehicle) + 1], GetVehicleClass(vehicle)
+            end
-            end
+            return carInfo
-        end
+        else
-    else
+            if not carInfo.name then
-        return carInfo
+                debugPrint("^6Bridge^7: ^2Vehicle ^1not ^2found in ^4vehicles^7 ^2table^7: ^6"..model.." ^7(^6"..GetDisplayNameFromVehicleModel(model):lower().."^7)")
-    end
+                carInfo.name = string.upper(GetMakeNameFromVehicleModel(model).." "..GetDisplayNameFromVehicleModel(model))
-end
+                carInfo.price = 0
-
+                carInfo.class = classlist[GetVehicleClass(vehicle) + 1], GetVehicleClass(vehicle)
--- Vehicle Properties --
+            end
-
+        end
---- Retrieves the properties of a given vehicle.
+    else
----
+        return carInfo
---- This function fetches the vehicle's properties based on the active framework (QBCore or ox).
+    end
---- It utilizes the framework's native functions or events to obtain the vehicle's mod list and other details.
+end
----
+
---- @param vehicle number The entity ID of the vehicle.
+-------------------------------------------------------------
----
+-- Vehicle Properties Functions
---- @return table|nil table containing the vehicle's properties, or `nil` if the vehicle is invalid or the framework is not detected.
+-------------------------------------------------------------
----
+
---- @usage
+--- Retrieves the properties of a given vehicle using the active framework.
---- ```lua
+---
---- local props = getVehicleProperties(vehicleEntity)
+--- @param vehicle number The entity ID of the vehicle.
---- if props then
+--- @return table|nil table A table containing the vehicle's properties or nil if invalid.
----     -- Manipulate vehicle properties
+---
---- end
+--- @usage
---- ```
+--- ```lua
-function getVehicleProperties(vehicle)
+--- local props = getVehicleProperties(vehicleEntity)
-    local properties = {}
+--- if props then
-    if vehicle == nil then return nil end
+---     -- Use vehicle properties
-    if isStarted(QBExport) and not isStarted(QBXExport) then
+--- end
-        properties = Core.Functions.GetVehicleProperties(vehicle)
+--- ```
-        debugPrint("^6Bridge^7: ^2Getting Vehicle Properties ^7[^6"..QBExport.."^7] - [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..properties.model.."^7] - [^3"..properties.plate.."^7]")
+function getVehicleProperties(vehicle)
-    elseif isStarted(OXLibExport) then
+    if not vehicle then return nil end
-        properties = lib.getVehicleProperties(vehicle)
+
-        debugPrint("^6Bridge^7: ^2Getting Vehicle Properties ^7[^6"..OXLibExport.."^7] - [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..properties.model.."^7] - [^3"..properties.plate.."^7]")
+    local properties = {}
-    end
+    if isStarted(QBExport) and not isStarted(QBXExport) then
-    return properties
+        properties = Core.Functions.GetVehicleProperties(vehicle)
-end
+        debugPrint("^6Bridge^7: ^2Getting Vehicle Properties ^7[^6"..QBExport.."^7] - [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..properties.model.."^7] - [^3"..properties.plate.."^7]")
-
+
---- Sets the properties of a given vehicle.
+    elseif isStarted(OXLibExport) then
----
+        properties = lib.getVehicleProperties(vehicle)
---- This function applies the provided properties to the vehicle using the active framework's functions or events.
+        debugPrint("^6Bridge^7: ^2Getting Vehicle Properties ^7[^6"..OXLibExport.."^7] - [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..properties.model.."^7] - [^3"..properties.plate.."^7]")
---- It first retrieves the current properties and checks for differences before applying the new ones.
+    end
----
+    return properties
----@param vehicle number The entity ID of the vehicle.
+end
----@param props table The properties to set on the vehicle.
+
----
+--- Sets the properties of a given vehicle if changes are detected.
----@usage
+--- It compares the current properties with the new ones and applies the update using the active framework.
---- ```lua
+---
---- setVehicleProperties(vehicleEntity, newProperties)
+--- @param vehicle number The entity ID of the vehicle.
---- ```
+--- @param props table The new properties to apply.
-function setVehicleProperties(vehicle, props)
+---
-    local oldProps = getVehicleProperties(vehicle)
+--- @usage
-    if checkDifferences(vehicle, props) then
+--- ```lua
-        --if debugMode then debugDifferences(vehicle, props) end
+--- setVehicleProperties(vehicleEntity, newProperties)
-        if not DoesEntityExist(vehicle) then
+--- ```
-            print(("Unable to set vehicle properties for '%s' (entity does not exist)"):format(vehicle))
+function setVehicleProperties(vehicle, props)
-        end
+    if checkDifferences(vehicle, props) then
-        if isStarted(QBExport) and not isStarted(QBXExport) then
+        if not DoesEntityExist(vehicle) then
-            Core.Functions.SetVehicleProperties(vehicle, props)
+            print("Unable to set vehicle properties for '"..vehicle.."' (^1entity does not exist^7)")
-            debugPrint("^6Bridge^7: ^2Setting Vehicle Properties ^7[^6"..QBExport.."^7] - [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..props.model.."^7] - [^3"..props.plate.."^7]")
+        end
-        else
+
-            TriggerServerEvent(getScript()..":ox:setVehicleProperties", VehToNet(vehicle), props)
+        if isStarted(QBExport) and not isStarted(QBXExport) then
-        end
+            Core.Functions.SetVehicleProperties(vehicle, props)
-    else
+            debugPrint("^6Bridge^7: ^2Setting Vehicle Properties ^7[^6"..QBExport.."^7] - [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..props.model.."^7] - [^3"..props.plate.."^7]")
-        debugPrint("^6Bridge^7: ^2No Changes Found ^7 [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..props.model.."^7] - [^3"..props.plate.."^7]")
+
-    end
+        elseif isStarted(OXLibExport) then
-end
+            lib.setVehicleProperties(vehicle, props, false)
-
+            debugPrint("^6Bridge^7: ^2Setting Vehicle Properties ^7[^6"..OXLibExport.."^7] - [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..props.model.."^7] - [^3"..props.plate.."^7]")
---- Checks for differences between the current and new vehicle properties.
+        end
----
+    else
---- This function compares each property of the vehicle to determine if any changes have been made.
+        debugPrint("^6Bridge^7: ^2No Changes Found ^7 [^3"..vehicle.."^7] - [^3"..GetEntityModel(vehicle).."^7/^3"..props.model.."^7] - [^3"..props.plate.."^7]")
---- It logs the differences for debugging purposes.
+    end
----
+end
----@param vehicle number The entity ID of the vehicle.
+
----@param newProps table The new properties to compare against the current ones.
+--- Checks for differences between the current and new vehicle properties.
----
+--- Compares properties using JSON encoding for deep comparison and logs differences.
----@return boolean `true` if differences are found, `false` otherwise.
+---
----
+--- @param vehicle number The entity ID of the vehicle.
----@usage
+--- @param newProps table The new properties to compare.
---- ```lua
+--- @return boolean `true` if differences are found; `false` otherwise.
---- if checkDifferences(vehicleEntity, newProperties) then
+---
----     setVehicleProperties(vehicleEntity, newProperties)
+--- @usage
---- end
+--- ```lua
---- ```
+--- if checkDifferences(vehicleEntity, newProperties) then
-function checkDifferences(vehicle, newProps)
+---     setVehicleProperties(vehicleEntity, newProperties)
-    local oldProps = getVehicleProperties(vehicle)
+--- end
-    debugPrint("^6Bridge^7: ^2Finding differences in ^3Vehicle Properties^7")
+--- ```
-    local allow = false
+function checkDifferences(vehicle, newProps)
-    for k in pairs(oldProps) do
+    local oldProps = getVehicleProperties(vehicle)
-        if json.encode(oldProps[k]) ~= json.encode(newProps[k]) then
+    debugPrint("^6Bridge^7: ^2Finding differences in ^3Vehicle Properties^7")
-            allow = true
+    local differencesFound = true
-            debugPrint("^6Bridge^7: ^5Old ^7[^3"..k.."^7] - "..json.encode(oldProps[k], { indent = true }))
+
-            debugPrint("^6Bridge^7: ^5New ^7[^3"..k.."^7] - "..json.encode(newProps[k], { indent = true }))
+    for k in pairs(oldProps) do
-        end
+        if json.encode(oldProps[k]) ~= json.encode(newProps[k]) then
-    end
+            differencesFound = true
-    return allow
+            debugPrint("^6Bridge^7: ^5Old ^7[^3"..k.."^7] - "..json.encode(oldProps[k], { indent = true }))
-end
+            debugPrint("^6Bridge^7: ^5New ^7[^3"..k.."^7] - "..json.encode(newProps[k], { indent = true }))
-
+        end
---- Handles setting vehicle properties received from the server.
+    end
----
+
---- This event listens for the `ox:setVehicleProperties` event and applies the received properties to the vehicle.
+    return differencesFound
----
+end
----@event
+
----@param netId number The network ID of the vehicle.
+-------------------------------------------------------------
----@param props table The properties to set on the vehicle.
+-- Vehicle Properties Synchronization
----
+-------------------------------------------------------------
----@usage
+
---- -- Server-side: TriggerClientEvent(getScript()..":ox:setVehicleProperties", netId, properties)
+--- Event handler for setting vehicle properties received from the server.
-RegisterNetEvent(getScript()..":ox:setVehicleProperties", function(netId, props)
+--- Listens for the `ox:setVehicleProperties` event and applies the properties.
-    local vehicle = NetworkGetEntityFromNetworkId(netId)
+---
-    local value = props
+--- @event `getScript()..ox:setVehicleProperties`
-    Entity(vehicle).state[getScript()..':setVehicleProperties'] = value
+--- @param netId number The network ID of the vehicle.
-end)
+--- @param props table The new vehicle properties.
-
+RegisterNetEvent(getScript()..":ox:setVehicleProperties", function(netId, props)
---- Handles state bag changes for setting vehicle properties.
+    local vehicle = NetworkGetEntityFromNetworkId(netId)
----
+    local value = props
---- This handler listens for changes to the vehicle's state bag and applies the new properties accordingly.
+    Entity(vehicle).state[getScript()..':setVehicleProperties'] = value
----
+end)
----@param bagName string The name of the state bag.
+
----@param key string The key that changed.
+--- Handles state bag changes for updating vehicle properties.
----@param value table The new value of the state.
+--- When the state bag changes, the new properties are applied to the vehicle.
----
+---
----@usage
+--- @param bagName string The state bag's name.
---- -- Automatically handled when the state bag changes
+--- @param key string The key that changed.
-AddStateBagChangeHandler(getScript()..':setVehicleProperties', '', function(bagName, _, value)
+--- @param value table The new state value.
-    if not value or not GetEntityFromStateBagName then return end
+AddStateBagChangeHandler(getScript()..':setVehicleProperties', '', function(bagName, _, value)
-    local entity = GetEntityFromStateBagName(bagName)
+    if not value or not GetEntityFromStateBagName then return end
-    local networked = not bagName:find('localEntity')
+    local entity = GetEntityFromStateBagName(bagName)
-    debugPrint("^6Bridge^7: ^2Setting Vehicle Properties ^7[^6"..OXLibExport.."^7] - [^3"..entity.."^7] - [^3"..GetEntityModel(entity).."^7] - [^3"..value.plate.."^7]")
+    local networked = not bagName:find('localEntity')
-
+    debugPrint("^6Bridge^7: ^2Setting Vehicle Properties ^7[^6"..OXLibExport.."^7] - [^3"..entity.."^7] - [^3"..GetEntityModel(entity).."^7] - [^3"..value.plate.."^7]")
-    if networked and NetworkGetEntityOwner(entity) ~= cache.playerId then return end
+
-
+    if networked then return end
-    if lib.setVehicleProperties(entity, value) then
+
-        Entity(entity).state:set('setVehicleProperties', nil, true)
+    if lib.setVehicleProperties(entity, value) then
-    end
+        Entity(entity).state:set('setVehicleProperties', nil, true)
-end)
+    end
-
+end)
---- Pushes a vehicle to other players by syncing it.
+
----
+-------------------------------------------------------------
---- This function ensures that the vehicle is controlled by the current player and is set as a mission entity.
+-- Vehicle Control Functions
---- It requests network control and sets the vehicle accordingly to synchronize changes across clients.
+-------------------------------------------------------------
----
+
----@param entity number The entity ID of the vehicle to push.
+--- This function ensures that the vehicle is controlled by the current player and is set as a mission entity.
----
+--- It requests network control and sets the vehicle accordingly to synchronize changes across clients.
----@usage
+---
---- ```lua
+---@param entity number The entity ID of the vehicle to push.
---- pushVehicle(vehicleEntity)
+---
---- ```
+---@usage
-function pushVehicle(entity)
+--- ```lua
-    SetVehicleModKit(entity, 0)
+--- pushVehicle(vehicleEntity)
-    if entity ~= 0 and DoesEntityExist(entity) then
+--- ```
-        if not NetworkHasControlOfEntity(entity) then
+function pushVehicle(entity)
-            debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Requesting network control of vehicle^7.")
+    SetVehicleModKit(entity, 0)
-            NetworkRequestControlOfEntity(entity)
+    if entity ~= 0 and DoesEntityExist(entity) then
-            local timeout = 2000
+        -- Request network control if not already controlled.
-            while timeout > 0 and not NetworkHasControlOfEntity(entity) do
+        if not NetworkHasControlOfEntity(entity) then
-                Wait(100)
+            debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Requesting network control of vehicle^7.")
-                timeout = timeout - 100
+            NetworkRequestControlOfEntity(entity)
-            end
+            local timeout = 2000
-            if NetworkHasControlOfEntity(entity) then
+            while timeout > 0 and not NetworkHasControlOfEntity(entity) do
-                debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Network has control of entity^7.")
+                Wait(100)
-            end
+                timeout = timeout - 100
-        end
+            end
-        if not IsEntityAMissionEntity(entity) then
+            if NetworkHasControlOfEntity(entity) then
-            debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Setting vehicle as a ^7'^2mission^7' &2entity^7.")
+                debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Network now has control of the entity^7.")
-            SetEntityAsMissionEntity(entity, true, true)
+            end
-            local timeout = 2000
+        end
-            while timeout > 0 and not IsEntityAMissionEntity(entity) do
+
-                Wait(100)
+        -- Set as mission entity if not already set.
-                timeout = timeout - 100
+        if not IsEntityAMissionEntity(entity) then
-            end
+            debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Setting vehicle as a ^7'^2mission^7' ^2entity^7.")
-            if IsEntityAMissionEntity(entity) then
+            SetEntityAsMissionEntity(entity, true, true)
-                debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Vehicle is a ^7'^2mission^7'^2 entity^7.")
+            local timeout = 2000
-            end
+            while timeout > 0 and not IsEntityAMissionEntity(entity) do
-        end
+                Wait(100)
-    end
+                timeout = timeout - 100
-end
+            end
+            if IsEntityAMissionEntity(entity) then
+                debugPrint("^6Bridge^7: ^3pushVehicle^7: ^2Vehicle is a ^7'^2mission^7'^2 entity^7.")
+            end
+        end
+    end
+end
+
+--- Finds the closest vehicle to the specified coordinates.
+--- The function uses different APIs based on whether a source is provided.
+---
+--- @param coords table|vector3 (Optional) The reference coordinates. If nil, uses the player's position.
+--- @param src boolean (Optional) If true, uses GetPlayerPed(source) and GetAllVehicles.
+--- @return number|number closestVehicle|closestDistance The closest vehicle entity and its distance.
+---
+--- @usage
+--- ```lua
+--- local closestVeh, distance = getClosestVehicle({ x = 100, y = 200, z = 30 }, src)
+--- ```
+function getClosestVehicle(coords, src)
+    local ped, vehicles, closestDistance, closestVehicle
+
+    if src then
+        ped = GetPlayerPed(src)
+        vehicles = GetAllVehicles()
+    else
+        ped = PlayerPedId()
+        vehicles = GetGamePool('CVehicle')
+    end
+
+    local closestDistance, closestVehicle = -1, -1
+
+    if coords then
+        if type(coords) == 'table' then
+            coords = vec3(coords.x, coords.y, coords.z)
+        end
+    else
+        coords = GetEntityCoords(ped)
+    end
+
+    for i = 1, #vehicles, 1 do
+        local vehicleCoords = GetEntityCoords(vehicles[i])
+        local distance = #(vehicleCoords - coords)
+
+        if closestDistance == -1 or distance < closestDistance then
+            closestDistance = distance
+            closestVehicle = vehicles[i]
+        end
+    end
+
+    return closestVehicle, closestDistance
+end

shared/versioncheck.lua

@@ -1,47 +0,0 @@
--- Version check for jim_bridge --
-function CheckBridgeVersion()
-	if isServer() then
-        local currentVersion = "^3"..GetResourceMetadata("jim_bridge", 'version'):gsub("%.", "^7.^3").."^7"
-        PerformHttpRequest('https://raw.githubusercontent.com/jimathy/jim_bridge/master/version.txt', function(err, newestVersion, headers)
-            if not newestVersion then print("^1Currently unable to run a version check for ^7'^3jim_bridge^7' ("..currentVersion.."^7)") return end
-            newestVersion = "^3"..newestVersion:sub(1, -2):gsub("%.", "^7.^3"):gsub("%\r", "").."^7"
-            print(newestVersion == currentVersion and "^7'^3jim_bridge^7' - ^6You are running the latest version.^7 ("..currentVersion..")" or "^7'^3jim_bridge^7' - ^1You are currently running an outdated version^7, ^1please update^7!")
-		end)
-	end
-end
---CheckBridgeVersion()
-
--- Print Script names
-function capitalize(str)
-    return (str:gsub("^%l", string.upper):gsub("%-%l", function(letter) return "-" .. string.upper(letter:sub(2)) end))
-end
-
-local scriptName = ("^2"..capitalize(getScript()):gsub("%-", "^7-^2"):gsub("%_", "^7_^2")) or ""
-local scriptVersion = ("^5"..GetResourceMetadata(getScript(), 'version', nil):gsub("%.", "^7.^5")) or ""
-local scriptDescription = ("^2"..GetResourceMetadata(getScript(), 'description', nil)) or ""
-local scriptAuthor = ("^2by ^4"..GetResourceMetadata(getScript(), 'author', nil):gsub("%and", "^7and^4")) or ""
-
-print(scriptName.." ^7v"..scriptVersion.."^7 - "..scriptDescription.." "..scriptAuthor.."^7")
-
--- Loaded script Version Check, requires CheckVersion() to be placed in a server file
-function CheckVersion()
-	if isServer() then
-		local currentVersion = "^3"..GetResourceMetadata(getScript(), 'version'):gsub("%.", "^7.^3").."^7"
-		PerformHttpRequest('https://raw.githubusercontent.com/jimathy/UpdateVersions/master/'..getScript()..'.txt', function(err, newestVersion, headers)
-			if not newestVersion then
-				PerformHttpRequest('https://raw.githubusercontent.com/jimathy/'..getScript()..'/master/version.txt', function(err, freeVersion, headers)
-					if not freeVersion then print("^1Currently unable to run a version check for ^7'^3"..getScript().."^7' ("..currentVersion.."^7)") return end
-					local currentVersion = "^3"..GetResourceMetadata(getScript(), 'version'):gsub("%.", "^7.^3").."^7"
-					freeVersion = "^3"..freeVersion:sub(1, -2):gsub("%.", "^7.^3"):gsub("%\r", "").."^7"
-					print("^6Version Check^7: ^2Running^7: "..currentVersion.." ^2Latest^7: "..freeVersion)
-					print(freeVersion == currentVersion and "^7'^3"..getScript().."^7' - ^6You are running the latest version.^7 ("..currentVersion..")" or "^7'^3"..getScript().."^7' - ^1You are currently running an outdated version^7, ^1please update^7!")
-				end)
-			else
-				newestVersion = "^3"..newestVersion:sub(1, -2):gsub("%.", "^7.^3"):gsub("%\r", "").."^7"
-				print("^6Version Check^7: ^2Running^7: "..currentVersion.." ^2Latest^7: "..newestVersion)
-				print(newestVersion == currentVersion and '^6You are running the latest version.^7 ('..currentVersion..')' or "^1You are currently running an outdated version^7, ^1please update^7!")
-			end
-		end)
-	end
-end
---CheckVersion()

shared/wrapperfunctions.lua

@@ -1,260 +1,44 @@
--- Phone Mails
+
-
+--- Registers a command with the active command system.
---- Sends a phone mail using the detected phone system.
+--- This function supports multiple command systems (OXLib, qb-core, ESX Legacy).
----
+---
---- This function detects the active phone resource (e.g., gksphone, yflip-phone, qb-phone, etc.)
+--- @param command string The name of the command to register.
---- and sends a mail using the appropriate method for that phone system.
+--- @param options table A table containing command options.
----
+---     - help (`string`): The help description for the command.
---- @param data table A table containing the mail data.
+---     - params (`table`): A table of parameters for the command.
---- - **subject** (`string`): The subject of the email.
+---     - callback (`function`): The function to execute when the command is called.
---- - **sender** (`string`): The sender of the email.
+---     - autocomplete (`function|nil`): (Optional) A function for autocompletion.
---- - **message** (`string`): The body content of the email.
+---     - restrictedGroup (`string|nil`): (Optional) The user group required to execute the command.
---- - **actions** (`table|nil`): (Optional) Action buttons associated with the email.
+---
----
+--- @usage
---- @usage
+--- ```lua
---- ```lua
+--- registerCommand("greet", {
---- sendPhoneMail({
+---     "Greets the player",
----     subject = "Welcome!",
+---     { name = "name", help = "Name of the player to greet" },
----     sender = "Admin",
+---     function(source, args) print("Hello, "..args[1].."!") end,
----     message = "Thank you for joining our server.",
+---     nil,
----     actions = {
+---     "admin"
----         { label = "Reply", action = replyFunction }
+--- })
----     }
+--- ```
---- })
+function registerCommand(command, options)
---- ```
+
-function sendPhoneMail(data) local phoneResource = ""
+    if isStarted(OXLibExport) then
-    if isStarted("gksphone") then phoneResource = "gksphone"
+        debugPrint("^6Bridge^7: ^2Registering ^3Command^2 with ^7"..OXLibExport, command)
-        exports["gksphone"]:SendNewMail(data)
+        lib.addCommand(command, { help = options[1], restricted = options[5] and "group."..options[5] or nil }, options[4])
-
+
-    elseif isStarted("yflip-phone") then phoneResource = "yflip-phone"
+    elseif isStarted(QBExport) and not isStarted(QBXExport) then
-        TriggerServerEvent(getScript()..":yflip:SendMail", data)
+        debugPrint("^6Bridge^7: ^2Registering ^3Command^2 with ^7"..QBExport, command)
-
+        Core.Commands.Add(command, options[1], options[2], options[3], options[4], options[5] or nil)
-    elseif isStarted("qs-smartphone") then phoneResource = "qs-smartphone"
+
-        TriggerServerEvent('qs-smartphone:server:sendNewMail', data)
+    elseif isStarted(RSGExport) then
-
+        debugPrint("^6Bridge^7: ^2Registering ^3Command^2 with ^7"..RSGExport, command)
-    elseif isStarted("qs-smartphone-pro") then phoneResource = "qs-smartphone-pro"
+        Core.Commands.Add(command, options[1], options[2], options[3], options[4], options[5] or nil)
-        TriggerServerEvent('phone:sendNewMail', data)
+
-
+    elseif isStarted(ESXExport) then
-    elseif isStarted("roadphone") then phoneResource = "roadphone"
+        debugPrint("^6Bridge^7: ^2Registering ^3Command^2 with ^7ESX Legacy", command)
-        data.message = data.message:gsub("%<br>", "\n")
+        ESX.RegisterCommand(command, options[5] or 'admin', function(xPlayer, args, showError)
-        exports['roadphone']:sendMail(data)
+            options[4](xPlayer.source, args, showError)
-
+        end, false, { help = options[1] })
-    elseif isStarted("lb-phone") then phoneResource = "lb-phone"
+
-        data.message = data.message:gsub("%<br>", "\n")
+    end
-        TriggerServerEvent(getScript()..":lbphone:SendMail", data)
-
-    elseif isStarted("qb-phone") then phoneResource = "qb-phone"
-        TriggerServerEvent('qb-phone:server:sendNewMail', data)
-
-    elseif isStarted("jpr-phonesystem") then phoneResource = "jpr-phonesystem"
-        TriggerServerEvent(getScript()..":jpr:SendMail", data)
-    end
-
-    if phoneResource ~= "" then debugPrint("^6Bridge^7[^3"..phoneResource.."^7]: ^2Sending mail to player")
-    else print("^6Bridge^7: ^1ERROR ^2Sending mail to player ^7 - ^2No supported phone found") end
-end
-
---- Handles sending mail for lb-phone.
----
---- This event listens for the `lbphone:SendMail` event and sends an email using lb-phone's API.
----
---- @event
---- @param data table The mail data.
---- - **subject** (`string`): The subject of the email.
---- - **message** (`string`): The body content of the email.
---- - **buttons** (`table|nil`): (Optional) Action buttons associated with the email.
----
---- @usage
---- ```
---- -- Server-side:
---- TriggerClientEvent(getScript()..":lbphone:SendMail", data)
---- ```
-RegisterNetEvent(getScript()..":lbphone:SendMail", function(data)
-    local src = source
-    local phoneNumber = exports["lb-phone"]:GetEquippedPhoneNumber(src)
-    local emailAddress = exports["lb-phone"]:GetEmailAddress(phoneNumber)
-    if data.actions then data.buttons = data.actions end
-    exports["lb-phone"]:SendMail({
-        to = emailAddress,
-        subject = data.subject,
-        message = data.message,
-        actions = data.buttons,
-    })
-end)
-
---- Handles sending mail for yflip-phone.
----
---- This event listens for the `yflip:SendMail` event and sends an email using yflip-phone's API.
----
---- @event
---- @param data table The mail data.
---- - **subject** (`string`): The subject of the email.
---- - **sender** (`string`): The sender of the email.
---- - **message** (`string`): The body content of the email.
---- - **buttons** (`table|nil`): (Optional) Action buttons associated with the email.
----
---- @usage
---- ```lua
---- -- Server-side:
---- TriggerClientEvent(getScript()..":yflip:SendMail", data)
---- ```
-RegisterNetEvent(getScript()..":yflip:SendMail", function(data)
-    local src = source
-    exports["yflip-phone"]:SendMail({
-        title = data.subject,
-        sender = data.sender,
-        senderDisplayName = data.sender,
-        content = data.message,
-        actions = data.buttons,
-    }, 'source', src)
-end)
-
---- Handles sending mail for jpr-phonesystem.
----
---- This event listens for the `jpr:SendMail` event and sends an email using jpr-phonesystem's API.
----
---- @event
---- @param data table The mail data.
---- - **subject** (`string`): The subject of the email.
---- - **sender** (`string`): The sender of the email.
---- - **message** (`string`): The body content of the email.
---- - **buttons** (`table|nil`): (Optional) Action buttons associated with the email.
----
---- @return void
----
---- @usage
---- ```lua
---- -- Server-side:
---- TriggerClientEvent(getScript()..":jpr:SendMail", data)
---- ```
-RegisterNetEvent(getScript()..":jpr:SendMail", function(data)
-    local src = source
-    local Player = Core.Functions.GetPlayer(src)
-    TriggerEvent('jpr-phonesystem:server:sendEmail', {
-        Assunto = data.subject, -- Subject
-        Conteudo = data.message, -- Content
-        Enviado = data.sender, -- Submitted by
-        Destinatario = Player.PlayerData.citizenid, -- Target
-        Event = {}, -- Optional
-    })
-end)
-
--- Server-Side Functions for Registering Commands, Stashes, and Shops
-
---- Registers a command with the active command system.
----
---- This function detects whether the server is using OXLib or qb-core for command registration
---- and registers the command accordingly.
----
---- @param command string The name of the command to register.
---- @param options table A table containing command options.
---- - **help** (`string`): The help description for the command.
---- - **params** (`table`): A table of parameters for the command.
---- - **callback** (`function`): The function to execute when the command is called.
---- - **autocomplete** (`function|nil`): (Optional) A function for autocompletion.
---- - **restrictedGroup** (`string|nil`): (Optional) The user group required to execute the command.
----
---- @usage
---- ````lua
---- -- Server Side:
---- registerCommand("greet", {
----     "Greets the player",
----     { name = "name", help = "Name of the player to greet" },
----     function(source, args) print("Hello, " .. args[1] .. "!") end,
----     nil,
----     "admin"
---- })
---- ```
-function registerCommand(command, options)
-    if isStarted(OXLibExport) then
-        debugPrint("^6Bridge^7: ^2Registering ^3Command^2 with ^7"..OXLibExport, command)
-        lib.addCommand(command, { help = options[1], restricted = options[5] and "group."..options[5] or nil }, options[4])
-    elseif isStarted(QBExport) and not isStarted(QBXExport) then
-        debugPrint("^6Bridge^7: ^2Registering ^3Command^2 with ^7 "..QBExport, command)
-        Core.Commands.Add(command, options[1], options[2], options[3], options[4], options[5] and options[5] or nil)
-    end
-end
-
---- Registers a stash with the active inventory system.
----
---- This function detects whether the server is using OXInv or QSInv and registers the stash accordingly.
----
---- @param name string The unique identifier for the stash.
---- @param label string The display name for the stash.
---- @param slots number|nil (Optional) The number of slots in the stash. Defaults to 50.
---- @param weight number|nil (Optional) The maximum weight the stash can hold. Defaults to 4,000,000.
---- @param owner string|nil (Optional) The owner identifier for personal stashes.
---- @param coords table|nil (Optional) The coordinates for the stash location.
----
---- @usage
---- ```lua
---- registerStash("playerStash", "Player Stash", 100, 8000000, "player123", { x = 100.0, y = 200.0, z = 30.0 })
---- ```
-function registerStash(name, label, slots, weight, owner, coords)
-    if isStarted(OXInv) then
-        debugPrint("^6Bridge^7: ^2Registering ^3OX ^2Stash^7:", name, label, owner or nil)
-        exports[OXInv]:RegisterStash(name, label, slots or 50, weight or 4000000, owner or nil)
-    elseif isStarted(QSInv) then
-        debugPrint("^6Bridge^7: ^2Registering ^3QS ^2Stash^7:", name, label)
-        exports[QSInv]:RegisterStash(name, slots or 50, weight or 4000000)
-    end
-end
-
---- Registers a shop with the active inventory system.
----
---- This function detects whether the server is using OXInv or QBInv and registers the shop accordingly.
----
---- @param name string The unique identifier for the shop.
---- @param label string The display name for the shop.
---- @param items table The list of items available in the shop.
---- @param society string|nil (Optional) The society identifier for shared shops.
----
---- @usage
---- ```lua
---- registerShop("weaponShop", "Weapon Shop", weaponItems, "society_weapons")
---- ```
-function registerShop(name, label, items, society)
-    if isStarted(OXInv) then
-        debugPrint("^6Bridge^7: ^2Registering ^3OX ^2Store^7:", name, label)
-        exports[OXInv]:RegisterShop(
-            name, {
-                name = label,
-                inventory = items,
-                society = society,
-            }
-        )
-    elseif isStarted(QBInv) and QBInvNew then
-        debugPrint("^6Bridge^7: ^2Registering ^3QB ^2Store^7:", name, label)
-        print(json.encode(items, {indent = true}))
-        exports[QBInv]:CreateShop({
-            name = name,
-            label = label,
-            slots = #items,
-            items = items,
-            society = society,
-        })
-    end
-end
-
--- Server-Side Event Registration
-
-if isServer() then
-    --- Registers an event to create an OX stash from the server.
-    ---
-    --- @event
-    --- @param name string The unique identifier for the stash.
-    --- @param label string The display name for the stash.
-    --- @param slots number|nil (Optional) The number of slots in the stash.
-    --- @param weight number|nil (Optional) The maximum weight the stash can hold.
-    --- @param owner string|nil (Optional) The owner identifier for personal stashes.
-    --- @param coords table|nil (Optional) The coordinates for the stash location.
-    ---
-    --- @usage
-    --- ```lua
-    --- -- Server-side:
-    --- TriggerEvent(getScript()..":server:makeOXStash", name, label, slots, weight, owner, coords)
-    --- ```
-    RegisterNetEvent(getScript()..":server:makeOXStash", function(name, label, slots, weight, owner, coords)
-        registerStash(name, label, slots, weight, owner, coords)
-    end)
 end

starter.lua

@@ -1,89 +1,184 @@
-Exports = {
+gameName = not IsDuplicityVersion() and GetCurrentGameName()
-    QBExport = "qb-core",
+
-    QBXExport = "qbx_core",
+Exports = {
-    ESXExport = "es_extended",
+    QBExport = "qb-core",
-    OXCoreExport = "ox_core",
+    QBXExport = "qbx_core",
-
+    ESXExport = "es_extended",
-    OXInv = "ox_inventory",
+    OXCoreExport = "ox_core",
-    QBInv = "qb-inventory",
+
-    PSInv = "ps-inventory",
+    OXInv = "ox_inventory",
-    QSInv = "qs-inventory",
+    QBInv = "qb-inventory",
-    CoreInv = "core_inventory",
+    PSInv = "ps-inventory",
-    CodeMInv = "codem-inventory",
+    QSInv = "qs-inventory",
-    OrigenInv = "origen_inventory",
+    CoreInv = "core_inventory",
-
+    CodeMInv = "codem-inventory",
-    OXLibExport = "ox_lib",
+    OrigenInv = "origen_inventory",
-
+    TgiannInv = "tgiann-inventory",
-    QBMenuExport = "qb-menu",
+
-
+    OXLibExport = "ox_lib",
-    QBTargetExport = "qb-target",
+
-    OXTargetExport = "ox_target"
+    QBMenuExport = "qb-menu",
-}
+
-
+    QBTargetExport = "qb-target",
--- Required variables
+    OXTargetExport = "ox_target",
-debugMode = Config.System.Debug
+
-
+    -- REDM
-QBInvNew = true
+    RSGExport = "rsg-core",
-
+    RSGInv = "rsg-inventory"
-InventoryWeight = 120000
+}
-
+
--- Load files here into the invoking script
+-- Required variables
-for _, v in pairs({ -- This is a specific load order
+debugMode = Config.System.Debug
-    'helpers.lua',  -- needs to be first
+
-    '_loaders.lua',
+QBInvNew = true
-
+
-    '_eventDebug.lua',
+InventoryWeight = 120000
-    'coreloader.lua',   -- needs to be second to load all core related stuff before everything else
+
-    'callback.lua',
+-- [[ Server.Cfg Convar Check ]]--
-
+-- Check server convars for hard set defaults, otherwise it uses per script configurations
-    'duifunctions.lua',
+if Config and Config.System then
-
+    if Config.System.Debug then
-    -- Native Scaleforms
+        if GetConvar("jim_DisableDebug", "false") == "true" then
-    'scaleforms/bigMessageInstance.lua',
+            debugMode = false
-    'scaleforms/countDownHandler.lua',
+        end
-    'scaleforms/debugScaleform.lua',
+        if GetConvar("jim_DisableEventDebug", "false") == "true" then
-    'scaleforms/instructionalButtons.lua',
+            Config.System.EventDebug = false
-    'scaleforms/timerBars.lua',
+        end
-
+    end
-    -- Required functions
+
-    'make/loaders.lua',
+    Config.System.Menu = GetConvar("jim_menuScript", Config.System.Menu)
-    'make/makeBlip.lua',
+    Config.System.Notify = GetConvar("jim_notifyScript", Config.System.Notify or "gta")
-    'make/makePed.lua',
+    Config.System.ProgressBar = GetConvar("jim_progressBarScript", Config.System.ProgressBar or "gta")
-    'make/makeProp.lua',
+    Config.System.drawText = GetConvar("jim_drawTextScript", Config.System.drawText or "gta")
-    'make/makeVeh.lua',
+    Config.System.skillCheck = GetConvar("jim_skillCheckScript", Config.System.skillCheck or "gta")
-    'make/cameras.lua',
+
-    'make/progressBars.lua',
+    if GetConvar("jim_dontUseTarget", "false") == "true" then
-
+        Config.System.DontUseTarget = true
-    'wrapperfunctions.lua',
+    end
-    'polyZone.lua',
+end
-    'itemcontrol.lua',
+
-    'playerfunctions.lua',
+-- Load the core files here instead of in fxmanifests
-    'jobfunctions.lua',
+-- Forcefully loads the files and quietly, compared to fxmanifest complaining if they don't exist when you don't need them all
-
+local filesToLoad = {
-    -- Interactions
+    Shared = {
-    'targets.lua',
+        [Exports.OXLibExport] = { "init.lua" },
-    'contextmenus.lua',
+        [Exports.OXCoreExport] = { "lib/init.lua" },
-    'input.lua',
+        [Exports.ESXExport] = { "imports.lua" },
-    'notify.lua',
+        [Exports.QBXExport] = { "modules/playerdata.lua" },
-    'drawText.lua',
+    },
-
+    Client = {
-    -- Crafting / Shops / Stashes
+        ["PolyZone"] = { "client.lua", "BoxZone.lua", "EntityZone.lua", "CircleZone.lua", "ComboZone.lua" },
-    'crafting.lua',
+        ["warmenu"] = { "warmenu.lua", },
-    'stashcontrol.lua',
+    },
-
+}
-    -- Kind of "other"
+
-    'isAnimal.lua',
+-- Shared framework file loader
-    'scaleEntity.lua',
+for Type, ScriptTable in pairs(filesToLoad) do
-    'vehicles.lua',
+    if Type == "Client" and IsDuplicityVersion() then
-    'effects.lua',
+        goto continue
-    'versioncheck.lua'
+    else
-}) do
+        for scriptName, files in pairs(ScriptTable) do
-    if debugMode then
+            local state = GetResourceState(scriptName)
-        print("^5Loading^7: 'jim_bridge/shared/"..v.."' ^2into ^7'"..GetCurrentResourceName().."' ...")
+            -- if the resource is started, load the file
-    end
+            if state == "started" then
-    local fileLoader = assert(load(LoadResourceFile('jim_bridge', ('shared/'..v)), ('@@jim_bridge/shared/'..v)))
+                -- Force items into a table if they are not
-    fileLoader()
+                if type(files) == "string" then
-    if debugMode then
+                    files = { files }
-        print("^5Success^7: ^2loaded file^7: 'jim_bridge/shared/"..v.."'!")
+                end
-    end
+                for _, file in pairs(files) do
+                    --print("^5CoreLoader^7: '"..scriptName.."/"..file.."' ^2into ^7'"..GetCurrentResourceName().."' ...")
+                    local fileLoader = assert(load(LoadResourceFile(scriptName, (file)), ('@@'..scriptName..'/'..file)))
+                    fileLoader()
+                    if debugMode then
+                        print("^5CoreLoader^7: ^2loaded ^1Core ^2file^7: ^3"..scriptName.."^7/^3"..(file):gsub("/", "^7/^3"):gsub("%.lua", "^7.lua").." ^2into ^7'"..GetCurrentResourceName().."'")
+                    end
+                end
+            end
+
+            -- if script is in server, but not started warn the user
+            if state == "uninitialized" or state == "stopped" then
+                print("^5CoreLoader^7: ^3"..scriptName.." ^1 found but it wasn't started^7.")
+                print("^1Check your ^3server^7.^3cfg ^1load order^7")
+            end
+
+            -- debugging only, if the script is missing, warn the user
+            if state == "missing" then
+                if debugMode then
+                    print("^5CoreLoader^7: ^3"..scriptName.." ^2not found^7, ^2skipping")
+                end
+            end
+        end
+    end
+    ::continue::
+end
+
+-- Load files here into the invoking script
+for _, v in pairs({ -- This is a specific load order
+
+    'helpers.lua',  -- needs to be first
+    '_loaders.lua',
+
+    '_eventDebug.lua',
+    'callback.lua',
+    'coreloader.lua',
+
+    'duifunctions.lua',
+
+    -- Native Scaleforms
+    'scaleforms/scaleform_basic.lua',
+    'scaleforms/bigMessageInstance.lua',
+    'scaleforms/countDownHandler.lua',
+    'scaleforms/debugScaleform.lua',
+    'scaleforms/instructionalButtons.lua',
+    'scaleforms/timerBars.lua',
+
+    -- Required functions
+    'make/loaders.lua',
+    'make/makeBlip.lua',
+    'make/makePed.lua',
+    'make/makeProp.lua',
+    'make/makeVeh.lua',
+    'make/cameras.lua',
+    'make/progressBars.lua',
+
+    'wrapperfunctions.lua',
+    'polyZone.lua',
+    'inventories.lua',
+    'itemcontrol.lua',
+    'playerfunctions.lua',
+    'metaHandlers.lua',
+    'jobfunctions.lua',
+    'societybank.lua',
+    'phones.lua',
+
+    -- Interactions
+    'targets.lua',
+    'contextmenus.lua',
+    'input.lua',
+    'notify.lua',
+    'drawText.lua',
+    'skillcheck.lua',
+
+    -- Crafting / Shops / Stashes
+    'crafting.lua',
+    'shops.lua',
+    'stashcontrol.lua',
+
+    -- Kind of "other"
+    'isAnimal.lua',
+    'scaleEntity.lua',
+    'vehicles.lua',
+    'effects.lua',
+
+    -- Do version check last
+    '_scriptversioncheck.lua'
+}) do
+    if debugMode then
+        --print("^5Loading^7: 'jim_bridge/shared/"..v.."' ^2into ^7'"..GetCurrentResourceName().."' ...")
+    end
+    local fileLoader = assert(load(LoadResourceFile('jim_bridge', ('shared/'..v)), ('@@jim_bridge/shared/'..v)))
+    fileLoader()
+    if debugMode then
+        print("^5Success^7: ^2loaded file^7: ^3"..(v):gsub("/", "^7/^3"):gsub("%.lua", "^7.lua").."^7")
+    end
 end

version.txt

@@ -1 +1 @@
-1.2
+2.0.12