Update v2.4.10

Author: Musiker15

client/functions/main.lua

@@ -47,39 +47,32 @@ exports('AdvancedNotification', MSK.AdvancedNotification)
 RegisterNetEvent("msk_core:advancedNotification", MSK.AdvancedNotification)
 
 MSK.ScaleformAnnounce = function(header, text, typ, duration)
-    local scaleform = ''
-
-    local loadScaleform = function(sclform)
-        if not HasScaleformMovieLoaded(scaleform) then
-            scaleform = RequestScaleformMovie(sclform)
-            while not HasScaleformMovieLoaded(scaleform) do
-                Wait(1)
-            end
-        end
-    end
+    local scaleform = nil
 
     if typ == 1 then
-        loadScaleform("MP_BIG_MESSAGE_FREEMODE")
+        scaleform = MSK.Request.ScaleformMovie("MP_BIG_MESSAGE_FREEMODE")
         BeginScaleformMovieMethod(scaleform, "SHOW_SHARD_WASTED_MP_MESSAGE")
         ScaleformMovieMethodAddParamTextureNameString(header)
         ScaleformMovieMethodAddParamTextureNameString(text)
         EndScaleformMovieMethod()
     elseif typ == 2 then
-        loadScaleform("POPUP_WARNING")
+        scaleform = MSK.Request.ScaleformMovie("POPUP_WARNING")
         BeginScaleformMovieMethod(scaleform, "SHOW_POPUP_WARNING")
         ScaleformMovieMethodAddParamFloat(500.0)
         ScaleformMovieMethodAddParamTextureNameString(header)
         ScaleformMovieMethodAddParamTextureNameString(text)
         EndScaleformMovieMethod()
     end
 
+    if not scaleform then return end
+
     local draw = true
     while draw do
         local sleep = 1
 
         DrawScaleformMovieFullscreen(scaleform, 255, 255, 255, 255, 0)
 
-        MSK.SetTimeout(duration or 8000, function()
+        MSK.Timeout.Set(duration or 8000, function()
             draw = false
         end)
 
@@ -103,7 +96,7 @@ MSK.Spinner = function(text, typ, duration)
     AddTextComponentSubstringPlayerName(text)
     EndTextCommandBusyspinnerOn(typ or 4) -- 4 or 5, all others are useless // 4 = orange // 5 = white
 
-    MSK.SetTimeout(duration or 5000, function()
+    MSK.Timeout.Set(duration or 5000, function()
         BusyspinnerOff()
     end)
 end
@@ -200,32 +193,6 @@ MSK.GetPedMugshot = function(ped, transparent)
 end
 exports('GetPedMugshot', MSK.GetPedMugshot)
 
-MSK.LoadAnimDict = function(dict)
-    assert(dict and DoesAnimDictExist(dict), 'Parameter "dict" is nil or the AnimDict does not exist')
-
-    if not HasAnimDictLoaded(dict) then
-        RequestAnimDict(dict)
-
-        while not HasAnimDictLoaded(dict) do
-            Wait(1)
-        end
-    end
-end
-exports('LoadAnimDict', MSK.LoadAnimDict)
-
-MSK.LoadModel = function(modelHash)
-    assert(modelHash and IsModelValid(modelHash), 'Parameter "modelHash" is nil or the Model does not exist')
-
-    if not HasModelLoaded(modelHash) then
-        RequestModel(modelHash)
-    
-        while not HasModelLoaded(modelHash) do
-            Wait(1)
-        end
-    end
-end
-exports('LoadModel', MSK.LoadModel)
-
 MSK.GetClosestPlayer = function(coords)
     return GetClosestEntity(true, coords)
 end

client/functions/request.lua

@@ -0,0 +1,81 @@
+MSK.Request = {}
+
+MSK.Request.Streaming = function(request, hasLoaded, assetType, asset, timeout, ...)
+    if hasLoaded(asset) then return asset end
+    request(asset, ...)
+
+    MSK.Logging('info', ("Loading %s '%s' - remember to release it when done."):format(assetType, asset))
+
+    return MSK.Timeout.Await(timeout or 5000, function()
+        if hasLoaded(asset) then return asset end
+    end, ("failed to load %s '%s' - this is likely caused by unreleased assets"):format(assetType, asset))
+end
+exports('RequestStreaming', MSK.Request.Streaming)
+
+MSK.Request.ScaleformMovie = function(scaleformName, timeout)
+    assert(scaleformName and type(scaleformName) == 'string', ("Parameter 'scaleformName' has to be a 'string' (reveived %s)"):format(type(scaleformName)))
+
+    local scaleform = RequestScaleformMovie(scaleformName)
+
+    return MSK.Timeout.Await(timeout or 5000, function()
+        if HasScaleformMovieLoaded(asset) then return scaleform end
+    end, ("failed to load scaleformMovie '%s'"):format(scaleformName))
+end
+exports('RequestScaleformMovie', MSK.Request.ScaleformMovie)
+
+setmetatable(MSK.Request, {
+    __call = function(_, request, hasLoaded, assetType, asset, timeout, ...)
+        return MSK.Request.Streaming(request, hasLoaded, assetType, asset, timeout, ...)
+    end
+})
+
+MSK.Request.AnimDict = function(animDict)
+    assert(animDict and type(animDict) == 'string', ("Parameter 'animDict' has to be a 'string' (reveived %s)"):format(type(animDict)))
+    assert(DoesAnimDictExist(animDict), ("attempted to load invalid animDict '%s'"):format(animDict))
+
+    if HasAnimDictLoaded(animDict) then return animDict end
+
+    return MSK.Request(RequestAnimDict, HasAnimDictLoaded, 'animDict', animDict)
+end
+MSK.LoadAnimDict = MSK.Request.AnimDict -- Support for old Versions
+exports('LoadAnimDict', MSK.Request.AnimDict) -- Support for old Versions
+exports('RequestAnimDict', MSK.Request.AnimDict)
+
+MSK.Request.Model = function(model)
+    assert(model, 'Parameter "model" is nil')
+    if type(model) ~= 'number' then model = joaat(model) end
+    assert(IsModelValid(model) and IsModelInCdimage(model), ("attempted to load invalid model '%s'"):format(model))
+
+    if HasModelLoaded(model) then return model end
+
+    return MSK.Request(RequestModel, HasModelLoaded, 'model', model)
+end
+MSK.LoadModel = MSK.Request.Model -- Support for old Versions
+exports('LoadModel', MSK.Request.Model) -- Support for old Versions
+exports('RequestModel', MSK.Request.Model)
+
+MSK.Request.AnimSet = function(animSet)
+    assert(animSet and type(animSet) == 'string', ("Parameter 'animSet' has to be a 'string' (reveived %s)"):format(type(animSet)))
+    if HasAnimSetLoaded(animSet) then return animSet end
+
+    return MSK.Request(RequestAnimSet, HasAnimSetLoaded, 'animSet', animSet)
+end
+exports('RequestAnimSet', MSK.Request.AnimSet)
+
+MSK.Request.PtfxAsset = function(ptFxName)
+    assert(ptFxName and type(ptFxName) == 'string', ("Parameter 'ptFxName' has to be a 'string' (reveived %s)"):format(type(ptFxName)))
+
+    if HasNamedPtfxAssetLoaded(ptFxName) then return ptFxName end
+
+    return MSK.Request(RequestNamedPtfxAsset, HasNamedPtfxAssetLoaded, 'ptFxName', ptFxName)
+end
+exports('RequestPtfxAsset', MSK.Request.PtfxAsset)
+
+MSK.Request.TextureDict = function(textureDict)
+    assert(textureDict and type(textureDict) == 'string', ("Parameter 'textureDict' has to be a 'string' (reveived %s)"):format(type(textureDict)))
+
+    if HasStreamedTextureDictLoaded(textureDict) then return textureDict end
+
+    return MSK.Request(RequestStreamedTextureDict, HasStreamedTextureDictLoaded, 'textureDict', textureDict)
+end
+exports('RequestTextureDict', MSK.Request.TextureDict)

config.lua

@@ -37,7 +37,7 @@ Config.NotifyTypes = {
 
 Config.customNotification = function(title, message, typ, duration)
     -- Set Config.Notification = 'custom'
-    -- Add your own clientside Notification here    
+    -- Add your own clientside Notification here
 end
 ----------------------------------------------------------------
 Config.progressColor = "#5eb131" -- Default Color for ProgressBar

fxmanifest.lua

@@ -4,7 +4,7 @@ games { 'gta5' }
 author 'Musiker15 - MSK Scripts'
 name 'msk_core'
 description 'Functions for MSK Scripts'
-version '2.4.9'
+version '2.4.10'
 
 lua54 'yes'
 

shared/functions.lua

@@ -3,36 +3,6 @@ MSK.GetConfig = function()
 end
 exports('GetConfig', MSK.GetConfig)
 
-local Timeouts = {}
-local TimeoutId = 0
-MSK.SetTimeout = function(ms, cb, data)
-    assert(ms and tonumber(ms), 'Parameter "ms" has to be a number on function MSK.SetTimeout')
-    local requestId = TimeoutId + 1
-
-    SetTimeout(ms, function()
-        if Timeouts[requestId] then 
-            Timeouts[requestId] = nil 
-            return 
-        end
-
-        cb(data)
-    end)
-
-    TimeoutId = requestId
-
-    return requestId
-end
-MSK.AddTimeout = MSK.SetTimeout -- Support for old Versions
-exports('SetTimeout', MSK.SetTimeout)
-
-MSK.ClearTimeout = function(requestId)
-    assert(requestId, 'Parameter "requestId" is nil on function MSK.ClearTimeout')
-    Timeouts[requestId] = true
-end
-MSK.DelTimeout = MSK.ClearTimeout -- Support for old Versions
-exports('DelTimeout', MSK.ClearTimeout) -- Support for old Versions
-exports('ClearTimeout', MSK.ClearTimeout)
-
 MSK.Logging = function(code, ...)
     assert(code and type(code) == 'string', 'Parameter "code" has to be a string on function MSK.Logging')
     local script = ('[^2%s^0]'):format(GetInvokingResource() or 'msk_core')
@@ -42,6 +12,6 @@ MSK.logging = MSK.Logging -- Support for old Versions
 exports('Logging', MSK.Logging)
 
 logging = function(code, ...)
-    if not Config.Debug and code == 'debug' then return end
+    if not Config.Debug then return end
     MSK.Logging(code, ...)
 end

shared/timeout.lua

@@ -0,0 +1,69 @@
+MSK.Timeout = {}
+
+local Timeouts = {}
+local TimeoutId = 0
+
+MSK.Timeout.Set = function(ms, cb, data)
+    assert(ms and tonumber(ms), 'Parameter "ms" has to be a number on function MSK.Timeout.Set')
+    local requestId = TimeoutId + 1
+
+    SetTimeout(ms, function()
+        if Timeouts[requestId] then 
+            Timeouts[requestId] = nil 
+            return 
+        end
+
+        cb(data)
+    end)
+
+    TimeoutId = requestId
+
+    return requestId
+end
+MSK.SetTimeout = MSK.Timeout.Set -- Support for old Versions
+MSK.AddTimeout = MSK.Timeout.Set -- Support for old Versions
+exports('SetTimeout', MSK.SetTimeout)
+
+setmetatable(MSK.Timeout, {
+    __call = function(_, ms, cb, data)
+        return MSK.Timeout.Set(ms, cb, data)
+    end
+})
+
+MSK.Timeout.Clear = function(requestId)
+    assert(requestId, 'Parameter "requestId" is nil on function MSK.Timeout.Clear')
+    Timeouts[requestId] = true
+end
+MSK.ClearTimeout = MSK.Timeout.Clear -- Support for old Versions
+MSK.DelTimeout = MSK.Timeout.Clear -- Support for old Versions
+exports('DelTimeout', MSK.Timeout.Clear) -- Support for old Versions
+exports('ClearTimeout', MSK.Timeout.Clear)
+
+-- Thanks to ox_lib (https://overextended.dev/ox_lib/Modules/WaitFor/Shared)
+MSK.Timeout.Await = function(ms, cb, errMessage)
+    assert(ms and tonumber(ms), 'Parameter "ms" has to be a number on function MSK.Timeout.Await')
+    local value = cb()
+
+    if value ~= nil then return value end
+
+    if timeout or timeout == nil then
+        if type(timeout) ~= 'number' then timeout = 1000 end
+    end
+
+    local start = timeout and GetGameTimer()
+
+    while value == nil do
+        Wait(0)
+
+        local elapsed = timeout and GetGameTimer() - start
+
+        if elapsed and elapsed > timeout then
+            return error(('%s (waited %.1fms)'):format(errMessage or 'failed to resolve callback', elapsed), 2)
+        end
+
+        value = cb()
+    end
+
+    return value
+end
+exports('AwaitTimeout', MSK.Timeout.Await)