Skip to main content

Particle

Description:

  Represents a particle system node that emits and animates particles.

Class Object: Particle Class.

Inherits from: Node.

active

Type: Readonly Field.

Description:

  Whether the particle system is active.

Signature:

const active: boolean

start

Type: Function.

Description:

  Starts emitting particles.

Signature:

start: function(self: Particle)

stop

Type: Function.

Description:

  Stops emitting particles and wait for all active particles to end their lives.

Signature:

stop: function(self: Particle)

onFinished

Type: Function.

Description:

  Registers a callback function for when the particle system ends. Triggered after a Particle node started a stop action and then all the active particles end their lives.

Signature:

onFinished: function(self: Particle, callback: function())

Parameters:

ParameterTypeDescription
callbackfunctionThe callback function for when the particle system ends.