module:Particles

Particles generator class
particles demo

Constructor

new module:Particles(positionDefinition, base, generatoropt, updateropt, optionsopt)

Particles constructor

Parameters:
NameTypeAttributesDescription
positionDefinitionPositionDefinition

Origin for all particles

baseComponent

Blueprint for each particle

generatorOptionsGenerator<optional>

Initialization function for all particles data

updaterParticlesCallback<optional>

Function called on each particle draw (should not be computation intensive)

optionsParticleOptions<optional>

Extends

Members

(static) defaultData :ParticleData

Type:
  • ParticleData

(static) defaultOptions :ParticleOptions

Type:
  • ParticleOptions

Methods

(static) from(definition) → {Particles}

Parameters:
NameTypeDescription
definitionObject

Particles definition

Returns:
Type: 
Particles

generate(number, …params) → {Particles}

Create new particles

Parameters:
NameTypeAttributesDescription
numberNumber

Number of particles to generate

params*<repeatable>

Additional parameters for the generator function

Returns:

Itself

Type: 
Particles

Type Definitions

OptionsGenerator(index)

Parameters:
NameTypeDescription
indexNumber

Index of the particle

Returns:

ParticleData

ParticleData

Type:
  • Object
Properties
NameTypeAttributesDefaultDescription
positionPosition<optional>
new Position()

Position of the particle

rotationNumber<optional>
0

Rotation applied to the particle

scaleNumber | Position<optional>
1

Scaling ratio or a pair of value for horizontal and vertical scaling

ttlNumber<optional>

Time to live, number of frames the particle is displayed. This number will be decremented and the data removed when it reach 0

ParticleOptions

Type:
  • Object
Properties
NameTypeAttributesDefaultDescription
frequencyNumber<optional>
1

Frequency of emission (randomized)

emitNumber | Array.<Number><optional>

Number or range of particles emitted

argsArray<optional>

Arguments passed to the generator function

ParticlesCallback(data, index, …params)

Parameters:
NameTypeAttributesDescription
dataParticleData

One particle data

indexNumber

Index of the particle

params*<repeatable>

Additional parameters