refactor: rename addHunger to setHunger (#99)

* feat: debug thrist and hunger commands refactor: rename addHunger, addThirst to setHunger, setThirst, remove redundant code fix: hotfix qbx_core #457 * refactor: remove debug codes * fix: remove debug commands * feat: server use of the event * feat: exports for serwer side functions refactor: fix to own function chore: thirst and hunger summaries fix * revisions for `ox_inventory` QB bridge compatibility * feat: restore server side events trigger and hotfix --------- Co-authored-by: xHorntail <[email protected]>
Qbox-project · May 15, 2024 · 8943b42 · 8943b42
1 parent 05ef67c
commit 8943b42
Show file tree

Hide file tree

Showing 3 changed files with 108 additions and 36 deletions.
diff --git a/qbx_consumables/server.lua b/qbx_consumables/server.lua
@@ -1,19 +1,58 @@
 local config = require 'qbx_consumables.config'
 
-local function addHunger(amount)
+---hotfix: remove when qbx_core issue #470 fixed https://github.com/Qbox-project/qbx_core/issues/470
+---Enforces synchronization of player's hunger or thirst metadata with value from statebag
+---@param source number
+---@param amount number inverted, lower == more
+---@param type string
+local function metadataSyncHotfix(source, amount, type)
+    local player = exports.qbx_core:GetPlayer(source)
+    if not player then return end
+
+    player.Functions.SetMetaData(type, amount)
+end
+---hotfix
+
+---Set player's hunger state to 'amount'
+---@param source number
+---@param amount number inverted, lower == more hungry
+local function setHunger(source, amount)
     amount = lib.math.clamp(amount, 0, 100)
-    local playerState = Player(source).state
-    playerState:set('hunger', amount, true)
-    TriggerClientEvent('hud:client:UpdateNeeds', source, amount, playerState.thirst)
+    Player(source).state.hunger = amount
+
+    metadataSyncHotfix(source, amount, 'hunger')
 end
 
-local function addThirst(amount)
+---Increment player's hunger state by 'amount'
+---@param source number
+---@param amount number inverted, lower == more hungry
+local function addHunger(source, amount)
+    local hunger = Player(source).state.hunger or 0
+    setHunger(source, hunger + amount)
+end
+
+---Set player's thirst state to 'amount'
+---@param source number
+---@param amount number inverted, lower == more thirsty
+local function setThirst(source, amount)
     amount = lib.math.clamp(amount, 0, 100)
-    local playerState = Player(source).state
-    playerState:set('thirst', amount, true)
-    TriggerClientEvent('hud:client:UpdateNeeds', source, playerState.hunger, amount)
+    Player(source).state.thirst = amount
+
+    metadataSyncHotfix(source, amount, 'thirst')
 end
 
+---Increment player's thirst state by 'amount'
+---@param source number
+---@param amount number inverted, lower == more thirsty
+local function addThirst(source, amount)
+    local thirst = Player(source).state.thirst or 0
+    setThirst(source, thirst + amount)
+end
+
+---Relieve a random amount of stress from the player's state
+---@param source number
+---@param min number lower limit for random generation
+---@param max number upper limit for rancom generation
 local function relieveStress(source, min, max)
     local playerState = Player(source).state
     local verifiedMin = (type(min) == "number" and min) or config.defaultStressRelief.min
@@ -24,57 +63,48 @@ local function relieveStress(source, min, max)
 
     playerState:set("stress", newStress, true)
     if amount < 0 then
-        exports.qbx_core:Notify(source, locale('error.stress_gain'), 'inform', 2500, nil, nil, {'#141517', '#ffffff'}, 'brain', '#C53030')
+        exports.qbx_core:Notify(source, locale('error.stress_gain'), 'inform', 2500, nil, nil, { '#141517', '#ffffff' }, 'brain', '#C53030')
     else
-        exports.qbx_core:Notify(source, locale('success.stress_relief'), 'inform', 2500, nil, nil, {'#141517', '#ffffff'}, 'brain', '#0F52BA')
+        exports.qbx_core:Notify(source, locale('success.stress_relief'), 'inform', 2500, nil, nil, { '#141517', '#ffffff' }, 'brain', '#0F52BA')
     end
 end
 
 for alcohol, params in pairs(config.consumables.alcohol) do
     exports.qbx_core:CreateUseableItem(alcohol, function(source, item)
-        local player = exports.qbx_core:GetPlayer(source)
-        if not player then return end
-
         local drank = lib.callback.await('consumables:client:DrinkAlcohol', source, params.alcoholLevel, params.anim, params.prop)
         if not drank then return end
         if not exports.ox_inventory:RemoveItem(source, item.name, 1, nil, item.slot) then return end
-        local playerState = Player(source).state
 
-        local sustenance = (playerState.thirst or 0) + math.random(params.min, params.max)
+        local sustenance = math.random(params.min, params.max)
         relieveStress(source, params.stressRelief.min, params.stressRelief.max)
-        addThirst(sustenance)
+
+        addThirst(source, sustenance)
     end)
 end
 
 for drink, params in pairs(config.consumables.drink) do
     exports.qbx_core:CreateUseableItem(drink, function(source, item)
-        local player = exports.qbx_core:GetPlayer(source)
-        if not player then return end
-
         local drank = lib.callback.await('consumables:client:Drink', source, params.anim, params.prop)
         if not drank then return end
         if not exports.ox_inventory:RemoveItem(source, item.name, 1, nil, item.slot) then return end
-        local playerState = Player(source).state
 
-        local sustenance = (playerState.thirst or 0) + math.random(params.min, params.max)
+        local sustenance = math.random(params.min, params.max)
         relieveStress(source, params.stressRelief.min, params.stressRelief.max)
-        addThirst(sustenance)
+
+        addThirst(source, sustenance)
     end)
 end
 
 for food, params in pairs(config.consumables.food) do
     exports.qbx_core:CreateUseableItem(food, function(source, item)
-        local player = exports.qbx_core:GetPlayer(source)
-        if not player then return end
-
         local ate = lib.callback.await('consumables:client:Eat', source, params.anim, params.prop)
         if not ate then return end
         if not exports.ox_inventory:RemoveItem(source, item.name, 1, nil, item.slot) then return end
-        local playerState = Player(source).state
 
-        local sustenance = (playerState.hunger or 0) + math.random(params.min, params.max)
+        local sustenance = math.random(params.min, params.max)
         relieveStress(source, params.stressRelief.min, params.stressRelief.max)
-        addHunger(sustenance)
+
+        addHunger(source, sustenance)
     end)
 end
 
@@ -119,7 +149,49 @@ lib.callback.register('consumables:server:usedItem', function(source, item)
     return exports.ox_inventory:RemoveItem(source, item, 1)
 end)
 
--- Added for ox_inv until I make a proper qbx bridge
-RegisterNetEvent('consumables:server:addThirst', addThirst)
+---Set player's hunger state to 'amount'
+---@param amount number
+RegisterNetEvent('consumables:server:setHunger', function(amount)
+    --Make sure this can only be triggered from the client
+    if not GetInvokingResource() then setHunger(source, amount) end
+end)
+
+---Increment player's hunger state by 'amount'
+---@param amount number new hunger level
+RegisterNetEvent('consumables:server:addHunger', function(amount)
+    local resource = GetInvokingResource()
+    --handles calls from ox_inventory's QB bridge, using improper QB nomenclature
+    --todo remove upon merger of a proper qbx bridge to ox_inventory
+    if resource == 'ox_inventory' then
+        setHunger(source, amount)
+    --Make sure this can only be triggered from the client
+    elseif not resource then
+        addHunger(source, amount)
+    end
+end)
+
+---Set player's thirst state to 'amount'
+---@param amount number
+RegisterNetEvent('consumables:server:setThirst', function(amount)
+    --Make sure this can only be triggered from the client
+    if not GetInvokingResource() then setThirst(source, amount) end
+end)
+
+---Increment player's thirst state by 'amount'
+---@param amount number new thirst level
+RegisterNetEvent('consumables:server:addThirst', function(amount)
+    local resource = GetInvokingResource()
+    --handles calls from ox_inventory's QB bridge, using improper QB nomenclature
+    --todo remove upon merger of a proper qbx bridge to ox_inventory
+    if resource == 'ox_inventory' then
+        setThirst(source, amount)
+    --Make sure this can only be triggered from the client
+    elseif not resource then
+        addThirst(source, amount)
+    end
+end)
 
-RegisterNetEvent('consumables:server:addHunger', addHunger)
+exports('setHunger', setHunger)
+exports('addHunger', addHunger)
+exports('setThirst', setThirst)
+exports('addThirst', addThirst)
diff --git a/qbx_flipvehicle/client.lua b/qbx_flipvehicle/client.lua
@@ -1,7 +1,7 @@
 local config = lib.loadJson('qbx_flipvehicle.config')
 
---- @param vehicle number? id of the vehicle, default closes vehicle
---- @param flipTest boolean? costom fliping task
+---@param vehicle number? id of the vehicle, default closes vehicle
+---@param flipTest boolean? costom fliping task
 local function flipVehicle(vehicle, flipTest)
     if cache.vehicle then return end
     if not vehicle then vehicle = lib.getClosestVehicle(GetEntityCoords(cache.ped), config.maxDistance, false) end

diff --git a/qbx_noshuff/client.lua b/qbx_noshuff/client.lua
@@ -1,5 +1,5 @@
---- Disables auto seat switching
---- @param seatIndex number
+---Disables auto seat switching
+---@param seatIndex number
 local function disableAutoShuffle(seatIndex)
     SetPedConfigFlag(cache.ped, 184, true)
 
@@ -10,7 +10,7 @@ end
 
 lib.onCache('seat', disableAutoShuffle)
 
---- Makes the player ped shuffle to the next vehicle seat. 
+---Makes the player ped shuffle to the next vehicle seat. 
 local function shuffleSeat(self)
     self:disable(true)
     if cache.vehicle and cache.seat then