diff --git a/[core]/es_extended/client/compat.lua b/[core]/es_extended/client/compat.lua index 254148ac3..82ad12ab7 100644 --- a/[core]/es_extended/client/compat.lua +++ b/[core]/es_extended/client/compat.lua @@ -1 +1,8 @@ ---All client-side functions outsourced from the Core to the lib will be stored here for compatability, e.g: \ No newline at end of file +--All client-side functions outsourced from the Core to the lib will be stored here for compatability, e.g: + +ESX.Streaming.RequestModel = xLib.streaming.requestModel +ESX.Streaming.RequestStreamedTextureDict = xLib.streaming.requestStreamedTextureDict +ESX.Streaming.RequestNamedPtfxAsset = xLib.streaming.requestNamedPtfxAsset +ESX.Streaming.RequestAnimSet = xLib.streaming.requestAnimSet +ESX.Streaming.RequestAnimDict = xLib.streaming.requestAnimDict +ESX.Streaming.RequestWeaponAsset = xLib.streaming.requestWeaponAsset \ No newline at end of file diff --git a/[core]/es_extended/server/compat.lua b/[core]/es_extended/server/compat.lua index cc4e32713..8c638d6ee 100644 --- a/[core]/es_extended/server/compat.lua +++ b/[core]/es_extended/server/compat.lua @@ -1 +1,2 @@ ---All server-side functions outsourced from the Core to the lib will be stored here for compatability, e.g: \ No newline at end of file +--[[ All server-side functions outsourced from the Core to the lib will be stored here for compatability, e.g: +--]] \ No newline at end of file diff --git a/[core]/es_extended/shared/compat.lua b/[core]/es_extended/shared/compat.lua index 684923804..7a1fcf70b 100644 --- a/[core]/es_extended/shared/compat.lua +++ b/[core]/es_extended/shared/compat.lua @@ -1 +1,5 @@ ---All shared functions outsourced from the Core to the lib will be stored here for compatability, e.g: \ No newline at end of file +--All shared functions outsourced from the Core to the lib will be stored here for compatability, e.g: + +ESX.SetTimeout = xLib.timeout.setTimeout +ESX.ClearTimeout = xLib.timeout.clearTimeout +ESX.Await = xLib.waitFor \ No newline at end of file diff --git a/[core]/es_extended/shared/functions.lua b/[core]/es_extended/shared/functions.lua index e8fe8a760..71e1390e8 100644 --- a/[core]/es_extended/shared/functions.lua +++ b/[core]/es_extended/shared/functions.lua @@ -178,45 +178,6 @@ function ESX.IsFunctionReference(val) return typeVal == "function" or (typeVal == "table" and type(getmetatable(val)?.__call) == "function") end ----@param conditionFunc function A function that is repeatedly called until it returns a truthy value or the timeout is exceeded. ----@param errorMessage? string Optional. If set, an error will be thrown with this message if the condition is not met within the timeout. If not set, no error will be thrown. ----@param timeoutMs? number Optional. The maximum time to wait (in milliseconds) for the condition to be met. Defaults to 1000ms. ----@return boolean, any: Returns success status and the returned value of the condition function. -function ESX.Await(conditionFunc, errorMessage, timeoutMs) - timeoutMs = timeoutMs or 1000 - - if timeoutMs < 0 then - error("Timeout should be a positive number.") - end - - if not ESX.IsFunctionReference(conditionFunc) then - error("Condition Function should be a function reference.") - end - - -- since errorMessage is optional, we only validate it if the user provided it. - if errorMessage then - ESX.AssertType(errorMessage, "string", "errorMessage should be a string.") - end - - local invokingResource = GetInvokingResource() - local startTimeMs = GetGameTimer() - while GetGameTimer() - startTimeMs < timeoutMs do - local result = conditionFunc() - - if result then - return true, result - end - - Wait(0) - end - - if errorMessage then - error(("[%s] -> %s"):format(invokingResource, errorMessage)) - end - - return false -end - ---@param str string ---@param allowDigits boolean? Allow numbers if necessary ---@return boolean diff --git a/[core]/es_extended/client/modules/streaming.lua b/[core]/esx_lib/imports/streaming/client.lua similarity index 67% rename from [core]/es_extended/client/modules/streaming.lua rename to [core]/esx_lib/imports/streaming/client.lua index 8614c4fba..38f6479e4 100644 --- a/[core]/es_extended/client/modules/streaming.lua +++ b/[core]/esx_lib/imports/streaming/client.lua @@ -1,9 +1,9 @@ -ESX.Streaming = {} +xLib.streaming = {} ---@param modelHash number | string ---@param cb? function ---@return number | nil -function ESX.Streaming.RequestModel(modelHash, cb) +xLib.streaming.requestModel = function(modelHash, cb) modelHash = type(modelHash) == "number" and modelHash or joaat(modelHash) if not IsModelInCdimage(modelHash) then return end @@ -17,7 +17,7 @@ end ---@param textureDict string ---@param cb? function ---@return string | nil -function ESX.Streaming.RequestStreamedTextureDict(textureDict, cb) +xLib.streaming.requestStreamedTextureDict = function(textureDict, cb) RequestStreamedTextureDict(textureDict, false) while not HasStreamedTextureDictLoaded(textureDict) do Wait(500) end @@ -28,7 +28,7 @@ end ---@param assetName string ---@param cb? function ---@return string | nil -function ESX.Streaming.RequestNamedPtfxAsset(assetName, cb) +xLib.streaming.requestNamedPtfxAsset = function(assetName, cb) RequestNamedPtfxAsset(assetName) while not HasNamedPtfxAssetLoaded(assetName) do Wait(500) end @@ -39,7 +39,7 @@ end ---@param animSet string ---@param cb? function ---@return string | nil -function ESX.Streaming.RequestAnimSet(animSet, cb) +xLib.streaming.requestAnimSet = function(animSet, cb) RequestAnimSet(animSet) while not HasAnimSetLoaded(animSet) do Wait(500) end @@ -50,7 +50,7 @@ end ---@param animDict string ---@param cb? function ---@return string | nil -function ESX.Streaming.RequestAnimDict(animDict, cb) +xLib.streaming.requestAnimDict = function(animDict, cb) RequestAnimDict(animDict) while not HasAnimDictLoaded(animDict) do Wait(500) end @@ -61,10 +61,24 @@ end ---@param weaponHash number | string ---@param cb? function ---@return string | number | nil -function ESX.Streaming.RequestWeaponAsset(weaponHash, cb) +xLib.streaming.requestWeaponAsset = function(weaponHash, cb) RequestWeaponAsset(weaponHash, 31, 0) while not HasWeaponAssetLoaded(weaponHash) do Wait(500) end return cb and cb(weaponHash) or weaponHash end + +---@param bankName string +---@param cb? function +---@return string | nil +xLib.streaming.requestAudioBank = function(bankName, cb) + RequestAudioBank(bankName, false) + + while not RequestScriptAudioBank(bankName, false) do Wait(500) end + + return cb and cb(bankName) or bankName +end + + +return xLib.streaming \ No newline at end of file diff --git a/[core]/es_extended/shared/modules/timeout.lua b/[core]/esx_lib/imports/timeout/shared.lua similarity index 72% rename from [core]/es_extended/shared/modules/timeout.lua rename to [core]/esx_lib/imports/timeout/shared.lua index b0590d5a0..e684f3a45 100644 --- a/[core]/es_extended/shared/modules/timeout.lua +++ b/[core]/esx_lib/imports/timeout/shared.lua @@ -1,10 +1,14 @@ +xLib.timeout = {} + local TimeoutCount = 0 local CancelledTimeouts = {} ---@param msec number ---@param cb function ---@return number -ESX.SetTimeout = function(msec, cb) +xLib.timeout.setTimeout = function(msec, cb) + xLib.verify(cb, "function", true) + local id = TimeoutCount + 1 SetTimeout(msec, function() @@ -12,7 +16,6 @@ ESX.SetTimeout = function(msec, cb) CancelledTimeouts[id] = nil return end - cb() end) @@ -23,6 +26,8 @@ end ---@param id number ---@return nil -ESX.ClearTimeout = function(id) +xLib.timeout.clearTimeout = function(id) CancelledTimeouts[id] = true end + +return xLib.timeout diff --git a/[core]/esx_lib/imports/waitFor/shared.lua b/[core]/esx_lib/imports/waitFor/shared.lua new file mode 100644 index 000000000..8202a1c67 --- /dev/null +++ b/[core]/esx_lib/imports/waitFor/shared.lua @@ -0,0 +1,39 @@ + +---@param conditionFunc function A function that is repeatedly called until it returns a truthy value or the timeout is exceeded. +---@param errorMessage? string Optional. If set, an error will be thrown with this message if the condition is not met within the timeout. If not set, no error will be thrown. +---@param timeoutMs? number Optional. The maximum time to wait (in milliseconds) for the condition to be met. Defaults to 1000ms. +---@return boolean, any: Returns success status and the returned value of the condition function. +xLib.waitFor = function(conditionFunc, errorMessage, timeoutMs) + timeoutMs = timeoutMs or 1000 + + if timeoutMs < 0 then + error("Timeout should be a positive number.") + end + + xLib.verify(conditionFunc, "function", true) + + -- since errorMessage is optional, we only validate it if the user provided it. + if errorMessage then + xLib.verify(errorMessage, "string", true) + end + + local invokingResource = GetInvokingResource() + local startTimeMs = GetGameTimer() + while GetGameTimer() - startTimeMs < timeoutMs do + local result = conditionFunc() + + if result then + return true, result + end + + Wait(0) + end + + if errorMessage then + error(("[%s] -> %s"):format(invokingResource, errorMessage)) + end + + return false +end + +return xLib.waitFor \ No newline at end of file