Event

particle:emit

Client

Fired when a particle emitter starts an emission cycle

Signal

"particle:emit"

Arguments

TypeNameDescription
userdataemitterParticle emitter that started emitting

Fires once per emission cycle, not once per particle.

  • Triggered by self:emit (only if the emitter was not already emitting), self:burst and self:restart.
  • Also fires when emission is switched on by the engine itself, e.g. a freshly created emitter that emits by default.
  • Calling self:emit on an emitter that is already emitting does nothing and does not fire the signal.
  • Fires for every particle emitter type. Refer particle.gpu to create and configure an emitter that fires it.

Example

React when an emitter starts emitting
local function launch()
    local emitter = particle.gpu.create()
    emitter:burst()
end

util.event.on("particle:emit", function(emitter)
    core.engine.print("info", "particle:emit:", emitter:get_amount(), "particles")
end)

launch()

On this page