ParticleSystem

Description

class ParticleSystem

Constructor

new ParticleSystem(name, capacity, scene, customEffect, _isAnimationSheetEnabled, epsilon)

Parameters

	Name	Type	Description
	name	string
	capacity	number
	scene	Scene
optional	customEffect	Nullable<Effect>
optional	_isAnimationSheetEnabled	boolean

Members

name : string

static BLENDMODE_ONEONE : number

static BLENDMODE_STANDARD : number

animations : Animation[]

id : string

renderingGroupId : number

emitter : Nullable<AbstractMesh>

href="/classes/3.1/Vector3">Vector3 : undefined

emitRate : number

manualEmitCount : number

updateSpeed : number

targetStopDuration : number

disposeOnStop : boolean

minEmitPower : number

maxEmitPower : number

minLifeTime : number

maxLifeTime : number

minSize : number

maxSize : number

minAngularSpeed : number

maxAngularSpeed : number

particleTexture : Nullable<Texture>

layerMask : number

customShader : any

preventAutoStart : boolean

onDisposeObservable : Observable<ParticleSystem>

An event triggered when the system is disposed.

@type {BABYLON.Observable}

onDispose : () => void

updateFunction : (particles: Particle[]) => void

Parameters

	Name	Type	Description
	particles	Particle[]

onAnimationEnd : Nullable<() => void>

blendMode : number

forceDepthWrite : boolean

gravity : Vector3

direction1 : Vector3

direction2 : Vector3

minEmitBox : Vector3

maxEmitBox : Vector3

color1 : Color4

color2 : Color4

colorDead : Color4

textureMask : Color4

startDirectionFunction : (emitPower: number, worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void

Parameters

	Name	Type	Description
	emitPower	number
	worldMatrix	Matrix
	directionToUpdate	Vector3

startPositionFunction : (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void

Parameters

	Name	Type	Description
	worldMatrix	Matrix
	positionToUpdate	Vector3
	particle	Particle

startSpriteCellID : number

endSpriteCellID : number

spriteCellLoop : boolean

spriteCellChangeSpeed : number

spriteCellWidth : number

spriteCellHeight : number

isAnimationSheetEnabled : Boolean

appendParticleVertexes : Nullable<(offset: number, particle: Particle) => void>

Methods

recycleParticle(particle) → void

Parameters

	Name	Type	Description
	particle	Particle

getCapacity() → number

isAlive() → boolean

isStarted() → boolean

start() → void

stop() → void

animate() → void

rebuild() → void

render() → number

dispose() → void

clone(name, newEmitter) → ParticleSystem

Parameters

	Name	Type	Description
	name	string
	newEmitter	any

serialize() → any

static Parse(parsedParticleSystem, scene, rootUrl) → ParticleSystem

Parameters

	Name	Type	Description
	parsedParticleSystem	any
	scene	Scene
	rootUrl	string