Files
Elite-Gaming-FiveM/resources/ox_lib/imports/requestScaleformMovie/client.lua
T
2023-11-16 20:26:05 -08:00

20 lines
810 B
Lua

---Load a scaleform movie. When called from a thread, it will yield until it has loaded.
---@param scaleformName string
---@param timeout number? Number of ticks to wait for the scaleform movie to load. Default is 500.
---@return number? scaleform
function lib.requestScaleformMovie(scaleformName, timeout)
if type(scaleformName) ~= 'string' then
error(("expected scaleformName to have type 'string' (received %s)"):format(type(scaleformName)))
end
local scaleform = RequestScaleformMovie(scaleformName)
if not coroutine.isyieldable() then return scaleform end
return lib.waitFor(function()
if HasScaleformMovieLoaded(scaleform) then return scaleform end
end, ("failed to load scaleform '%s'"):format(scaleform), timeout or 500)
end
return lib.requestScaleformMovie