52 lines
2.7 KiB
Lua
52 lines
2.7 KiB
Lua
---Particle effects API documentation
|
|
---Functions for controlling particle effect component playback and
|
|
---shader constants.
|
|
---@class particlefx
|
|
particlefx = {}
|
|
---postspawn state
|
|
particlefx.EMITTER_STATE_POSTSPAWN = nil
|
|
---prespawn state
|
|
particlefx.EMITTER_STATE_PRESPAWN = nil
|
|
---sleeping state
|
|
particlefx.EMITTER_STATE_SLEEPING = nil
|
|
---spawning state
|
|
particlefx.EMITTER_STATE_SPAWNING = nil
|
|
---Starts playing a particle FX component.
|
|
---Particle FX started this way need to be manually stopped through particlefx.stop().
|
|
---Which particle FX to play is identified by the URL.
|
|
--- A particle FX will continue to emit particles even if the game object the particle FX component belonged to is deleted. You can call particlefx.stop() to stop it from emitting more particles.
|
|
---@param url string|hash|url # the particle fx that should start playing.
|
|
---@param emitter_state_function (fun(self: object, id: hash, emitter: hash, state: constant))? # optional callback function that will be called when an emitter attached to this particlefx changes state.
|
|
function particlefx.play(url, emitter_state_function) end
|
|
|
|
---Resets a shader constant for a particle FX component emitter.
|
|
---The constant must be defined in the material assigned to the emitter.
|
|
---Resetting a constant through this function implies that the value defined in the material will be used.
|
|
---Which particle FX to reset a constant for is identified by the URL.
|
|
---@param url string|hash|url # the particle FX that should have a constant reset
|
|
---@param emitter string|hash # the id of the emitter
|
|
---@param constant string|hash # the name of the constant
|
|
function particlefx.reset_constant(url, emitter, constant) end
|
|
|
|
---Sets a shader constant for a particle FX component emitter.
|
|
---The constant must be defined in the material assigned to the emitter.
|
|
---Setting a constant through this function will override the value set for that constant in the material.
|
|
---The value will be overridden until particlefx.reset_constant is called.
|
|
---Which particle FX to set a constant for is identified by the URL.
|
|
---@param url string|hash|url # the particle FX that should have a constant set
|
|
---@param emitter string|hash # the id of the emitter
|
|
---@param constant string|hash # the name of the constant
|
|
---@param value vector4 # the value of the constant
|
|
function particlefx.set_constant(url, emitter, constant, value) end
|
|
|
|
---Stops a particle FX component from playing.
|
|
---Stopping a particle FX does not remove already spawned particles.
|
|
---Which particle FX to stop is identified by the URL.
|
|
---@param url string|hash|url # the particle fx that should stop playing
|
|
---@param options table # Options when stopping the particle fx. Supported options:
|
|
function particlefx.stop(url, options) end
|
|
|
|
|
|
|
|
|
|
return particlefx |