EmitterObject:start()

Type Function
Object EmitterObject
Library display.*
Return value none
Revision Release 2024.3703
Keywords EmitterObject, start
See also display.newEmitter()
EmitterObject:stop()
EmitterObject:pause()

Overview

Starts the emission of particles from an EmitterObject if the emitter is stopped, or resumes the emission of particles if the emitter is paused.

Important

  • Emitters begin in the “playing” state and do not need to be “started” by default.

  • If you start an emitter from a “stopped” state, and there are existing particles from the emitter on screen (from a previously-started emission), all existing particles will instantly be removed.

Syntax

EmitterObject:start()