Files
ox_lib/imports/requestNamedPtfxAsset/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

16 lines
671 B
Lua

---Load a named particle effect. When called from a thread, it will yield until it has loaded.
---@param ptFxName string
---@param timeout number? Approximate milliseconds to wait for the particle effect to load. Default is 1000.
---@return string ptFxName
function lib.requestNamedPtfxAsset(ptFxName, timeout)
if HasNamedPtfxAssetLoaded(ptFxName) then return ptFxName end
if type(ptFxName) ~= 'string' then
error(("expected ptFxName to have type 'string' (received %s)"):format(type(ptFxName)))
end
return lib.streamingRequest(RequestNamedPtfxAsset, HasNamedPtfxAssetLoaded, 'ptFxName', ptFxName, timeout)
end
return lib.requestNamedPtfxAsset