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

26 lines
930 B
Lua

---Load an animation dictionary. When called from a thread, it will yield until it has loaded.
---@param animDict string
---@param timeout number? Number of ticks to wait for the dictionary to load. Default is 500.
---@return string? animDict
function lib.requestAnimDict(animDict, timeout)
if HasAnimDictLoaded(animDict) then return animDict end
if type(animDict) ~= 'string' then
error(("expected animDict to have type 'string' (received %s)"):format(type(animDict)))
end
if not DoesAnimDictExist(animDict) then
return error(("attempted to load invalid animDict '%s'"):format(animDict))
end
RequestAnimDict(animDict)
if not coroutine.isyieldable() then return animDict end
return lib.waitFor(function()
if HasAnimDictLoaded(animDict) then return animDict end
end, ("failed to load animDict '%s'"):format(animDict), timeout or 500)
end
return lib.requestAnimDict