Scripts/resources/[standalone]/ox_lib/imports/requestScaleformMovie/client.lua

18 lines
760 B
Lua
Raw Normal View History

2024-12-29 20:02:43 +00:00
---Load a scaleform movie. When called from a thread, it will yield until it has loaded.
---@param scaleformName string
---@param timeout number? Approximate milliseconds to wait for the scaleform movie to load. Default is 1000.
---@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)
return lib.waitFor(function()
if HasScaleformMovieLoaded(scaleform) then return scaleform end
2024-12-30 10:15:34 +00:00
end, ("failed to load scaleformMovie '%s'"):format(scaleformName), timeout)
2024-12-29 20:02:43 +00:00
end
return lib.requestScaleformMovie