chore: bump version to v3.32.2

* selector init

* fixes

* recalculate set weights on add/update

fxmanifest.lua

@@ -6,7 +6,7 @@ rdr3_warning 'I acknowledge that this is a prerelease build of RedM, and I am aw
 
 name 'ox_lib'
 author 'Overextended'
-version '3.31.4'
+version '3.32.2'
 license 'LGPL-3.0-or-later'
 repository 'https://github.com/communityox/ox_lib'
 description 'A library of shared functions to utilise in other resources.'

imports/logger/server.lua

@@ -128,17 +128,43 @@ if service == 'fivemanage' then
                 end)
             end
 
+            local metadata = {
+                hostname = hostname,
+                service = event,
+                source = source,
+            }
+
+            local playerTags = formatTags(source, nil)
+            if playerTags and type(playerTags) == 'string' then
+                local tempTable = { string.strsplit(',', playerTags) }
+                for _, v in pairs(tempTable) do
+                    local key, value = string.strsplit(':', v)
+                    if key and value then
+                        metadata[key] = value
+                    end
+                end
+            end
+
+            local args = { ... }
+            for _, arg in pairs(args) do
+                if type(arg) == 'table' then
+                    for k, v in pairs(arg) do
+                        metadata[k] = v
+                    end
+                elseif type(arg) == 'string' then
+                    local key, value = string.strsplit(':', arg)
+                    if key and value then
+                        metadata[key] = value
+                    end
+                end
+            end
+
             bufferSize += 1
             buffer[bufferSize] = {
                 level = "info",
                 message = message,
                 resource = cache.resource,
-                metadata = {
+                metadata = metadata,
-                    hostname = hostname,
-                    service = event,
-                    source = source,
-                    tags = formatTags(source, ... and string.strjoin(',', string.tostringall(...)) or nil),
-                }
             }
         end
     end

imports/selector/shared.lua

@@ -0,0 +1,175 @@
+---@alias OxSelectorItem {[1]: number, [2]: any}
+---@alias OxSelectorSet OxSelectorItem[]
+
+---@class OxSelector: OxClass
+---@field private sets OxSelectorSet | table<string, OxSelectorItem[]>
+---@field private totalWeights table<string, number>
+local OxSelector = lib.class("OxSelector")
+
+local DEFAULT_SET = 'default'
+local deepClone = lib.table.deepclone
+
+
+local function calculateTotalWeight(set)
+    local total = 0
+    for i = 1, #set do
+        local item = set[i]
+        assert(type(item) == "table", "Each OxSelectorItem must be a table")
+        local weight = item[1]
+        assert(type(weight) == "number" and weight >= 0, "weight must be 0 or more")
+        total += weight
+    end
+    return total
+end
+
+
+---@param sets OxSelectorSet | table<string, OxSelectorItem[]>
+function OxSelector:constructor(sets)
+    if type(sets) ~= "table" then
+        lib.print.error("Invalid sets provided to OxSelector constructor")
+    end
+
+    if lib.table.type(sets) == "array" then
+        sets = { [DEFAULT_SET] = sets }
+    end
+
+    self.private.totalWeights = {}
+    self.private.sets = {}
+
+    for setName, set in pairs(sets) do
+        assert(type(set) == "table" and lib.table.type(set) == "array", "Each set must be an array of OxSelectorItem")
+        assert(#set > 0, "Each set must contain at least one OxSelectorItem")
+
+        self.private.totalWeights[setName] = calculateTotalWeight(set)
+    end
+
+    self.private.sets = sets
+end
+
+--- Get a random non-weighted item from a specific set
+---@param setName? string
+---@return OxSelectorItem?
+function OxSelector:getRandom(setName)
+    local set = (setName and self.private.sets[setName]) or self.private.sets[DEFAULT_SET]
+    if not set then return nil end
+    local item = set[math.random(#set)][2]
+
+    return type(item) == "table" and deepClone(item) or item
+end
+
+--- Get a random weighted item from a specific set
+---@param setName? string
+---@return OxSelectorItem?
+function OxSelector:getRandomWeighted(setName)
+    local set = (setName and self.private.sets[setName]) or self.private.sets[DEFAULT_SET]
+    if not set then return nil end
+
+    local totalWeight = self.private.totalWeights[setName or DEFAULT_SET]
+    if totalWeight == 0 then return nil end
+
+    local randomWeight = math.random() * totalWeight
+    local cumulativeWeight = 0
+
+    for i = 1, #set do
+        cumulativeWeight = cumulativeWeight + set[i][1]
+        if randomWeight <= cumulativeWeight then
+            local item = set[i][2]
+            return type(item) == "table" and deepClone(item) or item
+        end
+    end
+
+    return nil
+end
+
+--- get multiple non-weighted random items from a specific set
+---@param setName? string
+---@param count number
+---@return OxSelectorItem[]
+function OxSelector:getRandomAmount(setName, count)
+    assert(type(count) == "number" and count > 0, "Count must be a positive number")
+    local items = {}
+    for _ = 1, count do
+        local item = self:getRandom(setName)
+        if item then
+            table.insert(items, item)
+        end
+    end
+    return items
+end
+
+--- get multiple weighted random items from a specific set
+---@param setName? string
+---@param count number
+---@return OxSelectorItem[]
+function OxSelector:getRandomWeightedAmount(setName, count)
+    assert(type(count) == "number" and count > 0, "Count must be a positive number")
+    local items = {}
+    for _ = 1, count do
+        local item = self:getRandomWeighted(setName)
+        if item then
+            table.insert(items, item)
+        end
+    end
+    return items
+end
+
+--- get all items from a specific set
+---@param setName? string
+---@return OxSelectorItem[]
+function OxSelector:getSet(setName)
+    return deepClone((setName and self.private.sets[setName]) or self.private.sets[DEFAULT_SET])
+end
+
+--- get all sets
+---@return table<string, OxSelectorItem[]>
+function OxSelector:getAllSets()
+    return deepClone(self.private.sets)
+end
+
+--- add a new set
+---@param setName string
+---@param items OxSelectorItem[]
+function OxSelector:addSet(setName, items)
+    assert(type(setName) == "string", "setName must be a string")
+
+    if self.private.sets[setName] then
+        lib.print.error("Selector set '" .. setName .. "' already exists.")
+        return
+    end
+
+    assert(type(items) == "table" and lib.table.type(items) == "array", "items must be an array")
+    assert(#items > 0, "set must contain at least one OxSelectorItem")
+
+    self.private.totalWeights[setName] = calculateTotalWeight(items)
+    self.private.sets[setName] = items
+end
+
+--- update an existing set
+---@param setName string
+---@param newItems OxSelectorItem[]
+function OxSelector:updateSet(setName, newItems)
+    assert(type(setName) == "string", "setName must be a string")
+
+    if not self.private.sets[setName] then
+        lib.print.error("Selector set '" .. setName .. "' does not exist.")
+        return
+    end
+
+    assert(type(newItems) == "table" and lib.table.type(newItems) == "array", "newItems must be an array")
+    assert(#newItems > 0, "set must contain at least one OxSelectorItem")
+
+    self.private.totalWeights[setName] = calculateTotalWeight(newItems)
+    self.private.sets[setName] = newItems
+end
+
+--- remove a set
+---@param setName string
+function OxSelector:removeSet(setName)
+    assert(type(setName) == "string", "setName must be a string")
+
+    self.private.totalWeights[setName] = nil
+    self.private.sets[setName] = nil
+end
+
+lib.selector = OxSelector
+return lib.selector

imports/table/shared.lua

@@ -47,13 +47,10 @@ end
 ---@return boolean
 ---Compares if two values are equal, iterating over tables and matching both keys and values.
 local function table_matches(t1, t2)
-    local tabletype1 = table.type(t1)
+	local type1, type2 = type(t1), type(t2)
 
-    if not tabletype1 then return t1 == t2 end
+	if type1 ~= type2 then return false end
-
+	if type1 ~= 'table' and type2 ~= 'table' then return t1 == t2 end
-    if tabletype1 ~= table.type(t2) or (tabletype1 == 'array' and #t1 ~= #t2) then
-        return false
-    end
 
     for k, v1 in pairs(t1) do
         local v2 = t2[k]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@communityox/ox_lib",
   "author": "Overextended",
-  "version": "3.31.4",
+  "version": "3.32.2",
   "description": "JS/TS wrapper for ox_lib exports",
   "main": "./shared/index.js",
   "types": "./shared/index.d.ts",

resource/interface/client/progress.lua

@@ -11,6 +11,7 @@ local DisableControlAction = DisableControlAction
 local DisablePlayerFiring = DisablePlayerFiring
 local playerState = LocalPlayer.state
 local createdProps = {}
+local maxProps = GetConvarInt('ox:progressPropLimit', 2)
 
 ---@class ProgressPropProps
 ---@field model string
@@ -34,13 +35,16 @@ local createdProps = {}
 ---@field disable? { move?: boolean, sprint?: boolean, car?: boolean, combat?: boolean, mouse?: boolean }
 
 local function createProp(ped, prop)
-    lib.requestModel(prop.model)
+    local ok, result = pcall(lib.requestModel, prop.model)
+
+    if not ok then return lib.print.error(result) end
+
     local coords = GetEntityCoords(ped)
-    local object = CreateObject(prop.model, coords.x, coords.y, coords.z, false, false, false)
+    local object = CreateObject(result, coords.x, coords.y, coords.z, false, false, false)
 
     AttachEntityToEntity(object, ped, GetPedBoneIndex(ped, prop.bone or 60309), prop.pos.x, prop.pos.y, prop.pos.z, prop.rot.x, prop.rot.y, prop.rot.z, true,
         true, false, true, prop.rotOrder or 0, true)
-    SetModelAsNoLongerNeeded(prop.model)
+    SetModelAsNoLongerNeeded(result)
 
     return object
 end
@@ -90,7 +94,7 @@ local function startProgress(data)
     end
 
     if data.prop then
-        playerState:set('lib:progressProps', data.prop, true)
+        TriggerServerEvent('ox_lib:progressProps', data.prop)
     end
 
     local disable = data.disable
@@ -137,7 +141,7 @@ local function startProgress(data)
     end
 
     if data.prop then
-        playerState:set('lib:progressProps', nil, true)
+        TriggerServerEvent('ox_lib:progressProps', nil)
     end
 
     if anim then
@@ -225,14 +229,18 @@ end
 
 local function deleteProgressProps(serverId)
     local playerProps = createdProps[serverId]
+
     if not playerProps then return end
+
+    createdProps[serverId] = nil
+
     for i = 1, #playerProps do
         local prop = playerProps[i]
+
         if DoesEntityExist(prop) then
             DeleteEntity(prop)
         end
     end
-    createdProps[serverId] = nil
 end
 
 RegisterNetEvent('onPlayerDropped', function(serverId)
@@ -248,22 +256,29 @@ AddStateBagChangeHandler('lib:progressProps', nil, function(bagName, key, value,
     local ped = GetPlayerPed(ply)
     local serverId = GetPlayerServerId(ply)
 
-    if not value then
+    if not value or createdProps[serverId] then
         return deleteProgressProps(serverId)
     end
 
-    createdProps[serverId] = {}
+    local playerProps = {}
-    local playerProps = createdProps[serverId]
 
     if value.model then
-        playerProps[#playerProps + 1] = createProp(ped, value)
+        local prop = createProp(ped, value)
-    else
-        for i = 1, #value do
-            local prop = value[i]
 
         if prop then
-                playerProps[#playerProps + 1] = createProp(ped, prop)
+            playerProps[#playerProps + 1] = prop
+        end
+    else
+        local propCount = math.min(maxProps, #value)
+
+        for i = 1, propCount do
+            local prop = createProp(ped, value[i])
+
+            if prop then
+                playerProps[#playerProps + 1] = prop
             end
         end
     end
+
+    createdProps[serverId] = playerProps
 end)

resource/interface/server/progress.lua

@@ -0,0 +1,12 @@
+local maxProps = GetConvarInt('ox:progressPropLimit', 2)
+
+---@param props ProgressPropProps | ProgressPropProps[] | nil
+RegisterNetEvent('ox_lib:progressProps', function(props)
+    if type(props) == 'table' then
+        props = #props > maxProps and { table.unpack(props, 1, maxProps) } or props
+    else
+        props = nil
+    end
+
+    Player(source).state:set('lib:progressProps', props, true)
+end)