Class: ParticleEmitter

Constructor

new ParticleEmitter(position, 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
`position`	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>	(1,1,1,1)	Color at start of life 1, randomized between start colors
`colorStartB`	Color	<optional>	(1,1,1,1)	Color at start of life 2, randomized between start colors
`colorEndA`	Color	<optional>	(1,1,1,0)	Color at end of life 1, randomized between end colors
`colorEndB`	Color	<optional>	(1,1,1,0)	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: engineParticles.js, line 24

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),   rgb(0,0,0),   // colorStartA, colorStartB
    rgb(1,1,1,0), rgb(0,0,0,0), // colorEndA, colorEndB
    2, .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: engineParticles.js, line 136

additiveColor

Properties

Type	Description
Color	Additive color to apply when rendered

Overrides: EngineObject#additiveColor
Source: engineObject.js, line 61

angle

Properties

Type	Description
Number	Angle to rotate the object

Overrides: EngineObject#angle
Source: engineObject.js, line 57

angleDamping

Properties

Type	Description
Number	How much to dampen particle angular speed

Overrides: EngineObject#angleDamping
Source: engineParticles.js, line 124

angleSpeed

Properties

Type	Description
Number	How fast are particles rotating

Source: engineParticles.js, line 120

angleVelocity

Properties

Type	Description
Number	Angular velocity of the object

Overrides: EngineObject#angleVelocity
Source: engineObject.js, line 83

children

Properties

Type	Description
Array	List of children of this object

Overrides: EngineObject#children
Source: engineObject.js, line 87

clampSpeedLinear

Properties

Type	Description
Boolean	Limit object speed using linear or circular math

Overrides: EngineObject#clampSpeedLinear
Source: engineObject.js, line 89

collideRaycast

Properties

Type	Description
Boolean	Object collides with raycasts

Overrides: EngineObject#collideRaycast
Source: engineObject.js, line 107

collideSolidObjects

Properties

Type	Description
Boolean	Object collides with solid objects

Overrides: EngineObject#collideSolidObjects
Source: engineObject.js, line 103

collideTiles

Properties

Type	Description
Boolean	Do particles collide against tiles

Overrides: EngineObject#collideTiles
Source: engineParticles.js, line 134

color

Properties

Type	Description
Color	Color to apply when rendered

Overrides: EngineObject#color
Source: engineObject.js, line 59

colorEndA

Properties

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

Source: engineParticles.js, line 104

colorEndB

Properties

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

Source: engineParticles.js, line 106

colorStartA

Properties

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

Source: engineParticles.js, line 100

colorStartB

Properties

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

Source: engineParticles.js, line 102

damping

Properties

Type	Description
Number	How much to dampen particle speed

Overrides: EngineObject#damping
Source: engineParticles.js, line 122

drawSize

Properties

Type	Description
Vector2	Size of object used for drawing, uses size if not set

Overrides: EngineObject#drawSize
Source: engineObject.js, line 53

elasticity

Properties

Name	Type	Attributes	Default	Description
`elasticity`	Number	<optional>	objectDefaultElasticity	How bouncy the object is when colliding (0-1)

Overrides: EngineObject#elasticity
Source: engineObject.js, line 73

emitConeAngle

Properties

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

Source: engineParticles.js, line 96

emitRate

Properties

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

Source: engineParticles.js, line 94

emitSize

Properties

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

Source: engineParticles.js, line 90

emitTime

Properties

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

Source: engineParticles.js, line 92

emitTimeBuffer

Properties

Type	Description
Number	Track particle emit time

Source: engineParticles.js, line 146

fadeRate

Properties

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

Source: engineParticles.js, line 130

friction

Properties

Name	Type	Attributes	Default	Description
`friction`	Number	<optional>	objectDefaultFriction	How much friction to apply when sliding (0-1)

Overrides: EngineObject#friction
Source: engineObject.js, line 75

gravityScale

Properties

Type	Description
Number	How much does gravity effect particles

Overrides: EngineObject#gravityScale
Source: engineParticles.js, line 126

isSolid

Properties

Type	Description
Boolean	Object collides with and blocks other objects

Overrides: EngineObject#isSolid
Source: engineObject.js, line 105

localAngle

Properties

Type	Description
Number	Local angle if child

Overrides: EngineObject#localAngle
Source: engineObject.js, line 97

localPos

Properties

Type	Description
Vector2	Local position if child

Overrides: EngineObject#localPos
Source: engineObject.js, line 95

localSpace

Properties

Type	Description
Boolean	Should it be in local space of emitter

Source: engineParticles.js, line 138

mass

Properties

Name	Type	Attributes	Default	Description
`mass`	Number	<optional>	objectDefaultMass	How heavy the object is, static if 0

Overrides: EngineObject#mass
Source: engineObject.js, line 67

mirror

Properties

Type	Description
Boolean	Should it flip along y axis when rendered

Overrides: EngineObject#mirror
Source: engineObject.js, line 63

parent

Properties

Type	Description
EngineObject	Parent of object if in local space

Overrides: EngineObject#parent
Source: engineObject.js, line 93

particleConeAngle

Properties

Type	Description
Number	Cone for start particle angle

Source: engineParticles.js, line 128

particleCreateCallback

Properties

Type	Description
function	Callback when particle is created

Source: engineParticles.js, line 144

particleDestroyCallback

Properties

Type	Description
function	Callback when particle is destroyed

Source: engineParticles.js, line 142

particleTime

Properties

Type	Description
Number	How long particles live

Source: engineParticles.js, line 112

pos

Properties

Type	Description
Vector2	World space position of the object

Overrides: EngineObject#pos
Source: engineObject.js, line 49

randomColorLinear

Properties

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

Source: engineParticles.js, line 108

randomness

Properties

Type	Description
Number	Apply extra randomness percent

Source: engineParticles.js, line 132

renderOrder

Properties

Type	Description
Number	Objects are sorted by render order

Overrides: EngineObject#renderOrder
Source: engineObject.js, line 79

size

Properties

Type	Description
Vector2	World space width and height of the object

Overrides: EngineObject#size
Source: engineObject.js, line 51

sizeEnd

Properties

Type	Description
Number	How big are particles at end

Source: engineParticles.js, line 116

sizeStart

Properties

Type	Description
Number	How big are particles at start

Source: engineParticles.js, line 114

spawnTime

Properties

Type	Description
Number	Track when object was created

Overrides: EngineObject#spawnTime
Source: engineObject.js, line 85

speed

Properties

Type	Description
Number	How fast are particles when spawned

Source: engineParticles.js, line 118

tileInfo

Properties

Type	Description
TileInfo	Tile info to render object (undefined is untextured)

Overrides: EngineObject#tileInfo
Source: engineObject.js, line 55

trailScale

Properties

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

Source: engineParticles.js, line 140

velocity

Properties

Type	Description
Vector2	Velocity of the object

Overrides: EngineObject#velocity
Source: engineObject.js, line 81

Methods

addChild(child, localPosopt, localAngleopt)

Attaches a child to this with a given local transform

Parameters:

Name	Type	Attributes	Default
`child`	EngineObject
`localPos`	Vector2	<optional>	(0,0)
`localAngle`	Number	<optional>	0

Overrides: EngineObject#addChild
Source: engineObject.js, line 387

applyAcceleration(acceleration)

Apply acceleration to this object (adjust velocity, not affected by mass)

Parameters:

Name	Type	Description
`acceleration`	Vector2

Overrides: EngineObject#applyAcceleration
Source: engineObject.js, line 373

applyForce(force)

Apply force to this object (adjust velocity, affected by mass)

Parameters:

Name	Type	Description
`force`	Vector2

Overrides: EngineObject#applyForce
Source: engineObject.js, line 377

collideWithObject(object) → {Boolean}

Called to check if a object collision should be resolved

Parameters:

Name	Type	Description
`object`	EngineObject	the object to test against

Overrides: EngineObject#collideWithObject
Source: engineObject.js, line 365

Returns:

true if the collision should be resolved

Type:: Boolean

collideWithTile(tileData, pos) → {Boolean}

Called to check if a tile collision should be resolved

Parameters:

Name	Type	Description
`tileData`	Number	the value of the tile at the position
`pos`	Vector2	tile where the collision occurred

Overrides: EngineObject#collideWithTile
Source: engineObject.js, line 359

Returns:

true if the collision should be resolved

Type:: Boolean

destroy()

Destroy this object, destroy it's children, detach it's parent, and mark it for removal

Overrides: EngineObject#destroy
Source: engineObject.js, line 327

emitParticle() → {Particle}

Spawn one particle

Source: engineParticles.js, line 174

Returns:

Type:: Particle

getAliveTime() → {Number}

How long since the object was created

Overrides: EngineObject#getAliveTime
Source: engineObject.js, line 369

Returns:

Type:: Number

getMirrorSign() → {Number}

Get the direction of the mirror

Overrides: EngineObject#getMirrorSign
Source: engineObject.js, line 381

Returns:

-1 if this.mirror is true, or 1 if not mirrored

Type:: Number

localToWorld(pos)

Convert from local space to world space

Parameters:

Name	Type	Description
`pos`	Vector2	local space point

Overrides: EngineObject#localToWorld
Source: engineObject.js, line 341

localToWorldVector(vec)

Convert from local space to world space for a vector (rotation only)

Parameters:

Name	Type	Description
`vec`	Vector2	local space vector

Overrides: EngineObject#localToWorldVector
Source: engineObject.js, line 349

removeChild(child)

Removes a child from this one

Parameters:

Name	Type	Description
`child`	EngineObject

Overrides: EngineObject#removeChild
Source: engineObject.js, line 398

render()

Render the object, draws a tile by default, automatically called each frame, sorted by renderOrder

Overrides: EngineObject#render
Source: engineObject.js, line 320

renderDebugInfo()

Render debug info for this object

Overrides: EngineObject#renderDebugInfo
Source: engineObject.js, line 442

setCollision(collideSolidObjectsopt, isSolidopt, collideTilesopt, collideRaycastopt)

Set how this object collides

Parameters:

Name	Type	Attributes	Default	Description
`collideSolidObjects`	Boolean	<optional>	true	Does it collide with solid objects?
`isSolid`	Boolean	<optional>	true	Does it collide with and block other objects? (expensive in large numbers)
`collideTiles`	Boolean	<optional>	true	Does it collide with the tile collision?
`collideRaycast`	Boolean	<optional>	true	Does it collide with raycasts?