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

22 lines
772 B
Lua
Raw Normal View History

2024-12-29 20:02:43 +00:00
---Load an animation clipset. When called from a thread, it will yield until it has loaded.
---@param animSet string
---@param timeout number? Approximate milliseconds to wait for the clipset to load. Default is 1000.
---@return string? animSet
function lib.requestAnimSet(animSet, timeout)
if HasAnimSetLoaded(animSet) then return animSet end
if type(animSet) ~= 'string' then
error(("expected animSet to have type 'string' (received %s)"):format(type(animSet)))
end
RequestAnimSet(animSet)
if not coroutine.isyieldable() then return animSet end
return lib.waitFor(function()
if HasAnimSetLoaded(animSet) then return animSet end
end, ("failed to load animSet '%s'"):format(animSet), timeout)
end
return lib.requestAnimSet