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

16 lines
672 B
Lua
Raw Normal View History

2024-12-29 20:02:43 +00:00
---Load a named particle effect. When called from a thread, it will yield until it has loaded.
---@param ptFxName string
2024-12-30 10:15:34 +00:00
---@param timeout number? Approximate milliseconds to wait for the particle effect to load. Default is 10000.
---@return string ptFxName
2024-12-29 20:02:43 +00:00
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
2024-12-30 10:15:34 +00:00
return lib.streamingRequest(RequestNamedPtfxAsset, HasNamedPtfxAssetLoaded, 'ptFxName', ptFxName, timeout)
2024-12-29 20:02:43 +00:00
end
return lib.requestNamedPtfxAsset