- Select ref document -

Particle effects API documentation

version 1.2.144

Functions for controlling particle effect component playback and shader constants.

Functions

particlefx.play

particlefx.play(url, [emitter_state_function])

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.

Parameters

url

string | hash | url the particle fx that should start playing.

[emitter_state_function]

function(self, id, emitter, state) optional callback function that will be called when an emitter attached to this particlefx changes state.

self
object The current object
id
hash The id of the particle fx component
emitter
hash The id of the emitter
state
constant the new state of the emitter:
  • particlefx.EMITTER_STATE_SLEEPING
  • particlefx.EMITTER_STATE_PRESPAWN
  • particlefx.EMITTER_STATE_SPAWNING
  • particlefx.EMITTER_STATE_POSTSPAWN
url

string | hash | url the particle fx that should start playing.

[emitter_state_function]

function(self, id, emitter, state) optional callback function that will be called when an emitter attached to this particlefx changes state.

self
object The current object
id
hash The id of the particle fx component
emitter
hash The id of the emitter
state
constant the new state of the emitter:
  • particlefx.EMITTER_STATE_SLEEPING
  • particlefx.EMITTER_STATE_PRESPAWN
  • particlefx.EMITTER_STATE_SPAWNING
  • particlefx.EMITTER_STATE_POSTSPAWN

Examples

How to play a particle fx when a game object is created. The callback receives the hash of the path to the particlefx, the hash of the id of the emitter, and the new state of the emitter as particlefx.EMITTER_STATE_.

local function emitter_state_change(self, id, emitter, state)
  if emitter == hash("exhaust") and state == particlefx.EMITTER_STATE_POSTSPAWN then
    -- exhaust is done spawning particles...
  end
end

function init(self)
    particlefx.play("#particlefx", emitter_state_change)
end

particlefx.reset_constant

particlefx.reset_constant(url, emitter, constant)

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.

Parameters

url

string | hash | url the particle FX that should have a constant reset

emitter

string | hash the id of the emitter

constant

string | hash the name of the constant

url

string | hash | url the particle FX that should have a constant reset

emitter

string | hash the id of the emitter

constant

string | hash the name of the constant

Examples

The following examples assumes that the particle FX has id "particlefx", it contains an emitter with the id "emitter" and that the default-material in builtins is used, which defines the constant "tint". If you assign a custom material to the sprite, you can reset the constants defined there in the same manner.

How to reset the tinting of particles from an emitter:

function init(self)
    particlefx.reset_constant("#particlefx", "emitter", "tint")
end

particlefx.set_constant

particlefx.set_constant(url, emitter, constant, value)

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.

Parameters

url

string | hash | url the particle FX that should have a constant set

emitter

string | hash the id of the emitter

constant

string | hash the name of the constant

value

vector4 the value of the constant

url

string | hash | url the particle FX that should have a constant set

emitter

string | hash the id of the emitter

constant

string | hash the name of the constant

value

vector4 the value of the constant

Examples

The following examples assumes that the particle FX has id "particlefx", it contains an emitter with the id "emitter" and that the default-material in builtins is used, which defines the constant "tint". If you assign a custom material to the sprite, you can reset the constants defined there in the same manner.

How to tint particles from an emitter red:

function init(self)
    particlefx.set_constant("#particlefx", "emitter", "tint", vmath.vector4(1, 0, 0, 1))
end

particlefx.stop

particlefx.stop(url)

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.

Parameters

url

string | hash | url the particle fx that should stop playing

url

string | hash | url the particle fx that should stop playing

Examples

How to stop a particle fx when a game object is deleted:

function final(self)
    particlefx.stop("#particlefx")
end

Constants

particlefx.EMITTER_STATE_POSTSPAWN

The emitter is not spawning any particles, but has particles that are still alive.

particlefx.EMITTER_STATE_PRESPAWN

The emitter will be in this state when it has been started but before spawning any particles. Normally the emitter is in this state for a short time, depending on if a start delay has been set for this emitter or not.

particlefx.EMITTER_STATE_SLEEPING

The emitter does not have any living particles and will not spawn any particles in this state.

particlefx.EMITTER_STATE_SPAWNING

The emitter is spawning particles.