22 lines
832 B
Lua
22 lines
832 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
|
||
|
|
|
||
|
|
RequestNamedPtfxAsset(ptFxName)
|
||
|
|
|
||
|
|
if not coroutine.isyieldable() then return ptFxName end
|
||
|
|
|
||
|
|
return lib.waitFor(function()
|
||
|
|
if HasNamedPtfxAssetLoaded(ptFxName) then return ptFxName end
|
||
|
|
end, ("failed to load ptFxName '%s'"):format(ptFxName), timeout)
|
||
|
|
end
|
||
|
|
|
||
|
|
return lib.requestNamedPtfxAsset
|