mirror of
https://github.com/CommunityOx/ox_lib.git
synced 2026-08-16 22:46:03 +01:00
fb2225e373
Some people accidentally, mistakenly, and without any malicious intent forget to attribute code from this resource to its source. This change will hopefully assist people, so that they do not make that mistake again.
26 lines
980 B
Lua
26 lines
980 B
Lua
--[[
|
|
https://github.com/overextended/ox_lib
|
|
|
|
This file is licensed under LGPL-3.0 or higher <https://www.gnu.org/licenses/lgpl-3.0.en.html>
|
|
|
|
Copyright (c) 2025 Linden <https://github.com/thelindat/fivem>
|
|
]]
|
|
|
|
---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
|
|
end, ("failed to load scaleformMovie '%s'"):format(scaleformName), timeout)
|
|
end
|
|
|
|
return lib.requestScaleformMovie
|