Files
ox_lib/imports/requestAnimDict/client.lua
Linden 0f0c7a6591 refactor(streamingRequest): internal method for request functions
- TS package type inference for request functions.
- Type fix for Lua's waitFor callback.
- Lua request functions cannot return nil.
2024-03-31 16:15:44 +11:00

20 lines
765 B
Lua

---Load an animation dictionary. When called from a thread, it will yield until it has loaded.
---@param animDict string
---@param timeout number? Approximate milliseconds to wait for the dictionary to load. Default is 1000.
---@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
error(("attempted to load invalid animDict '%s'"):format(animDict))
end
return lib.streamingRequest(RequestAnimDict, HasAnimDictLoaded, 'animDict', animDict, timeout)
end
return lib.requestAnimDict