Class: ParticleEmitter

Constructor

new ParticleEmitter(pos, angleopt, emitSizeopt, emitTimeopt, emitRateopt, emitConeAngleopt, tileInfoopt, colorStartAopt, colorStartBopt, colorEndAopt, colorEndBopt, particleTimeopt, sizeStartopt, sizeEndopt, speedopt, angleSpeedopt, dampingopt, angleDampingopt, gravityScaleopt, particleConeAngleopt, fadeRateopt, randomnessopt, collideTilesopt, additiveopt, randomColorLinearopt, renderOrderopt, localSpaceopt)

Create a particle system with the given settings

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2			World space position of the emitter
`angle`	number	<optional>		Angle to emit the particles
`emitSize`	number \| Vector2	<optional>	0	World space size of the emitter (float for circle diameter, vec2 for rect)
`emitTime`	number	<optional>	0	How long to stay alive (0 is forever)
`emitRate`	number	<optional>	100	How many particles per second to spawn, does not emit if 0
`emitConeAngle`	number	<optional>	PI	Local angle to apply velocity to particles from emitter
`tileInfo`	TileInfo	<optional>		Tile info to render particles (undefined is untextured)
`colorStartA`	Color	<optional>	WHITE	Color at start of life 1, randomized between start colors
`colorStartB`	Color	<optional>	WHITE	Color at start of life 2, randomized between start colors
`colorEndA`	Color	<optional>	CLEAR_WHITE	Color at end of life 1, randomized between end colors
`colorEndB`	Color	<optional>	CLEAR_WHITE	Color at end of life 2, randomized between end colors
`particleTime`	number	<optional>	0.5	How long particles live
`sizeStart`	number	<optional>	0.1	How big are particles at start
`sizeEnd`	number	<optional>	1	How big are particles at end
`speed`	number	<optional>	0.1	How fast are particles when spawned
`angleSpeed`	number	<optional>	0.05	How fast are particles rotating
`damping`	number	<optional>	1	How much to dampen particle speed
`angleDamping`	number	<optional>	1	How much to dampen particle angular speed
`gravityScale`	number	<optional>	0	How much gravity effect particles
`particleConeAngle`	number	<optional>		Cone for start particle angle
`fadeRate`	number	<optional>	0.1	How quick to fade particles at start/end in percent of life
`randomness`	number	<optional>	0.2	Apply extra randomness percent
`collideTiles`	boolean	<optional>	false	Do particles collide against tiles
`additive`	boolean	<optional>	false	Should particles use additive blend
`randomColorLinear`	boolean	<optional>	true	Should color be randomized linearly or across each component
`renderOrder`	number	<optional>		Render order for particles (additive is above other stuff by default)
`localSpace`	boolean	<optional>	false	Should it be in local space of emitter (world space is default)

Source: src/engineParticles.js, line 48

Example

// create a particle emitter
let pos = vec2(2,3);
let particleEmitter = new ParticleEmitter
(
    pos, 0, 1, 0, 500, PI,      // pos, angle, emitSize, emitTime, emitRate, emitCone
    tile(0, 16),                // tileInfo
    rgb(1,1,1,1), rgb(0,0,0,1), // colorStartA, colorStartB
    rgb(1,1,1,0), rgb(0,0,0,0), // colorEndA, colorEndB
    1, .2, .2, .1, .05,  // particleTime, sizeStart, sizeEnd, particleSpeed, particleAngleSpeed
    .99, 1, 1, PI, .05,  // damping, angleDamping, gravityScale, particleCone, fadeRate,
    .5, 1                // randomness, collide, additive, randomColorLinear, renderOrder
);

Extends

EngineObject

Members

additive

Properties

Type	Description
boolean	Should particles use additive blend

Source: src/engineParticles.js, line 162

angleDamping

Properties

Type	Description
number	How much to dampen particle angular speed

Source: src/engineParticles.js, line 150

angleSpeed

Properties

Type	Description
number	How fast are particles rotating

Source: src/engineParticles.js, line 146

collideTiles

Properties

Type	Description
boolean	Do particles collide against tiles

Source: src/engineParticles.js, line 160

colorEndA

Properties

Type	Description
Color	Color at end of life 1, randomized between end colors

Source: src/engineParticles.js, line 130

colorEndB

Properties

Type	Description
Color	Color at end of life 2, randomized between end colors

Source: src/engineParticles.js, line 132

colorStartA

Properties

Type	Description
Color	Color at start of life 1, randomized between start colors

Source: src/engineParticles.js, line 126

colorStartB

Properties

Type	Description
Color	Color at start of life 2, randomized between start colors

Source: src/engineParticles.js, line 128

damping

Properties

Type	Description
number	How much to dampen particle speed

Source: src/engineParticles.js, line 148

emitCircle

Properties

Type	Description
boolean	Should particles be emitted in a circle

Source: src/engineParticles.js, line 114

emitConeAngle

Properties

Type	Description
number	Local angle to apply velocity to particles from emitter

Source: src/engineParticles.js, line 122

emitRate

Properties

Type	Description
number	How many particles per second to spawn, does not emit if 0

Source: src/engineParticles.js, line 120

emitSize

Properties

Type	Description
number \| Vector2	World space size of the emitter (float for circle diameter, vec2 for rect)

Source: src/engineParticles.js, line 116

emitTime

Properties

Type	Description
number	How long to stay alive (0 is forever)

Source: src/engineParticles.js, line 118

emitTimeBuffer

Properties

Type	Description
number	Track particle emit time

Source: src/engineParticles.js, line 176

fadeRate

Properties

Type	Description
number	How quick to fade in particles at start/end in percent of life

Source: src/engineParticles.js, line 156

gravityScale

Properties

Type	Description
number	How much gravity affects particles

Source: src/engineParticles.js, line 152

localSpace

Properties

Type	Description
boolean	Should it be in local space of emitter

Source: src/engineParticles.js, line 164

particleCollideCallback

Properties

Type	Description
ParticleCollideCallback	Callback when particle collides

Source: src/engineParticles.js, line 172

particleConeAngle

Properties

Type	Description
number	Cone for start particle angle

Source: src/engineParticles.js, line 154

particleCreateCallback

Properties

Type	Description
ParticleCallback	Callback when particle is created

Source: src/engineParticles.js, line 168

particleDestroyCallback

Properties

Type	Description
ParticleCallback	Callback when particle is destroyed

Source: src/engineParticles.js, line 170

particleTime

Properties

Type	Description
number	How long particles live

Source: src/engineParticles.js, line 138

particles

Properties

Type	Description
Array.<Particle>	Array of particles for this emitter

Source: src/engineParticles.js, line 178

randomColorLinear

Properties

Type	Description
boolean	Should color be randomized linearly or across each component

Source: src/engineParticles.js, line 134

randomness

Properties

Type	Description
number	Apply extra randomness percent

Source: src/engineParticles.js, line 158

sizeEnd

Properties

Type	Description
number	How big are particles at end

Source: src/engineParticles.js, line 142

sizeStart

Properties

Type	Description
number	How big are particles at start

Source: src/engineParticles.js, line 140

speed

Properties

Type	Description
number	How fast are particles when spawned

Source: src/engineParticles.js, line 144

trailScale

Properties

Type	Description
number	If non zero the particle is drawn as a trail, stretched in the direction of velocity

Source: src/engineParticles.js, line 166

velocityInheritance

Properties

Type	Description
number	Percentage of velocity to pass to particles (0-1)

Source: src/engineParticles.js, line 174

Methods

destroy(immediateopt)

Destroy the particle emitter

Parameters:

Name	Type	Attributes	Default	Description
`immediate`	boolean	<optional>	false	should particle emitters and other attached effects be allowed to die off

Source: src/engineParticles.js, line 303

emitParticle() → {Particle}

Spawn one particle

Source: src/engineParticles.js, line 237

Returns:

Type:: Particle

isActive()

is emitter actively spawning

Source: src/engineParticles.js, line 299

render()

Render all particles for this emitter

Source: src/engineParticles.js, line 291

update()

Update the emitter to spawn particles, called automatically by engine once each frame

Source: src/engineParticles.js, line 186

updatePhysics()

Particle emitters do not have physics

Source: src/engineParticles.js, line 288