Class BaseParticleSystem
Hierarchy
- BaseParticleSystem
Index
Constructors
Properties
- animations
- begin
Animation From - begin
Animation Loop - begin
Animation OnStart - begin
Animation To - blend
Mode - color1
- color2
- color
Dead - custom
Shader - dispose
OnStop - emit
Rate - emitter
- end
Sprite CellID - force
Depth Write - gravity
- id
- layer
Mask - limit
Velocity Damping - manual
Emit Count - max
Angular Speed - max
Emit Power - max
Initial Rotation - max
Life Time - max
ScaleX - max
ScaleY - max
Size - min
Angular Speed - min
Emit Power - min
Initial Rotation - min
Life Time - min
ScaleX - min
ScaleY - min
Size - name
- noise
Strength - on
Animation End - particle
Emitter Type - particle
Texture - pre
Warm Cycles - pre
Warm Step Offset - prevent
Auto Start - rendering
Group Id - snippet
Id - sprite
Cell Change Speed - sprite
Cell Height - sprite
Cell Loop - sprite
Cell Width - sprite
Random Start Cell - start
Delay - start
Sprite CellID - target
Stop Duration - texture
Mask - translation
Pivot - unique
Id - update
Speed - world
Offset - BLENDMODE_
ADD - BLENDMODE_
MULTIPLY - BLENDMODE_
MULTIPLYADD - BLENDMODE_
ONEONE - BLENDMODE_
STANDARD
Accessors
Methods
- create
Box Emitter - create
Cone Emitter - create
Cylinder Emitter - create
Directed Cylinder Emitter - create
Directed Sphere Emitter - create
Hemispheric Emitter - create
Point Emitter - create
Sphere Emitter - get
Alpha Remap Gradients - get
Angular Speed Gradients - get
Color Gradients - get
Color Remap Gradients - get
Drag Gradients - get
Emit Rate Gradients - get
Life Time Gradients - get
Limit Velocity Gradients - get
Scene - get
Size Gradients - get
Start Size Gradients - get
Velocity Gradients
Constructors
constructor
-
Instantiates a particle system. Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
Parameters
-
name: string
The name of the particle system
Returns BaseParticleSystem
-
Properties
animationsSearch playground for animations
List of animations used by the particle system.
begin
Gets or sets the frame to start the animation from when beginAnimationOnStart is true
begin
Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
begin
Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
begin
Gets or sets the frame to end the animation on when beginAnimationOnStart is true
blend
Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
color1Search playground for color1
Random color of each particle after it has been emitted, between color1 and color2 vectors
color2Search playground for color2
Random color of each particle after it has been emitted, between color1 and color2 vectors
color
Color the particle will have at the end of its lifetime
custom
This can help using your own shader to render the particle system. The according effect will be created
dispose
Specifies whether the particle system will be disposed once it reaches the end of the animation.
emit
The maximum number of particles to emit per frame
emitterSearch playground for emitter
The emitter represents the Mesh or position we are attaching the particle system to.
end
If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
force
Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls to override the particles.
gravitySearch playground for gravity
You can use gravity if you want to give an orientation to your particles.
idSearch playground for id
The id of the Particle system.
layer
The layer mask we are rendering the particles through.
limit
Gets or sets a value indicating the damping to apply if the limit velocity factor is reached
manual
If you want to launch only a few particles at once, that can be done, as well.
max
Maximum angular speed of emitting particles (Z-axis rotation for each particle).
max
Maximum power of emitting particles.
max
Gets or sets the maximal initial rotation in radians.
max
Maximum life time of emitting particles.
max
Maximum scale of emitting particles on X axis.
max
Maximum scale of emitting particles on Y axis.
max
Maximum Size of emitting particles.
min
Minimum angular speed of emitting particles (Z-axis rotation for each particle).
min
Minimum power of emitting particles.
min
Gets or sets the minimal initial rotation in radians.
min
Minimum life time of emitting particles.
min
Minimum scale of emitting particles on X axis.
min
Minimum scale of emitting particles on Y axis.
min
Minimum Size of emitting particles.
nameSearch playground for name
The friendly name of the Particle system.
noise
Gets or sets the strength to apply to the noise value (default is (10, 10, 10))
on
Callback triggered when the particle animation is ending.
particle
The particle emitter type defines the emitter used by the particle system. It can be for example box, sphere, or cone...
particle
The texture used to render each particle. (this can be a spritesheet)
pre
Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
pre
Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
prevent
By default particle system starts as soon as they are created. This prevents the automatic start to happen and let you decide when to start emitting particles.
rendering
The rendering group used by the Particle system to chose when to render.
snippet
Snippet ID if the particle system was created from the snippet server
sprite
If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
sprite
If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
sprite
If using a spritesheet (isAnimationSheetEnabled), defines wether the sprite animation is looping
sprite
If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
sprite
This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
start
Defines the delay in milliseconds before starting the system (0 by default)
start
If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
target
The amount of time the particle system is running (depends of the overall update speed).
texture
An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
translation
Gets or sets a Vector2 used to move the pivot (by default (0,0))
unique
Gets or sets the unique id of the particle system
update
The overall motion speed (0.01 is default update speed, faster updates = faster animation)
world
Gets or sets a world offset applied to all particles
Static BLENDMODE_
Add current color and particle color multiplied by particle’s alpha
Static BLENDMODE_
Multiply current color with particle color
Static BLENDMODE_
Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
Static BLENDMODE_
Source color is added to the destination color without alpha affecting the result
Static BLENDMODE_
Blend current color and particle color using particle’s alpha
Accessors
billboard
-
Gets or sets the billboard mode to use when isBillboardBased = true. Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
Returns number
-
Gets or sets the billboard mode to use when isBillboardBased = true. Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
Parameters
-
value: number
Returns any
-
direction1
-
Random direction of each particle after it has been emitted, between direction1 and direction2 vectors. This only works when particleEmitterTyps is a BoxParticleEmitter
Returns Vector3
-
Random direction of each particle after it has been emitted, between direction1 and direction2 vectors. This only works when particleEmitterTyps is a BoxParticleEmitter
Parameters
-
value: Vector3
Returns any
-
direction2
-
Random direction of each particle after it has been emitted, between direction1 and direction2 vectors. This only works when particleEmitterTyps is a BoxParticleEmitter
Returns Vector3
-
Random direction of each particle after it has been emitted, between direction1 and direction2 vectors. This only works when particleEmitterTyps is a BoxParticleEmitter
Parameters
-
value: Vector3
Returns any
-
image
-
Gets the image processing configuration used either in this material.
If sets to null, the scene one is in use.
Returns Nullable<ImageProcessingConfiguration>
-
Sets the Default image processing configuration used either in the this material.
If sets to null, the scene one is in use.
Parameters
-
value: Nullable<ImageProcessingConfiguration>
Returns any
-
is
-
Gets or sets whether an animation sprite sheet is enabled or not on the particle system
Returns boolean
-
Gets or sets whether an animation sprite sheet is enabled or not on the particle system
Parameters
-
value: boolean
Returns any
-
is
-
Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
Returns boolean
-
Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
Parameters
-
value: boolean
Returns any
-
max
-
Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so. This only works when particleEmitterTyps is a BoxParticleEmitter
Returns Vector3
-
Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so. This only works when particleEmitterTyps is a BoxParticleEmitter
Parameters
-
value: Vector3
Returns any
-
min
-
Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so. This only works when particleEmitterTyps is a BoxParticleEmitter
Returns Vector3
-
Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so. This only works when particleEmitterTyps is a BoxParticleEmitter
Parameters
-
value: Vector3
Returns any
-
noise
-
Gets or sets a texture used to add random noise to particle positions
Returns Nullable<ProceduralTexture>
-
Gets or sets a texture used to add random noise to particle positions
Parameters
-
value: Nullable<ProceduralTexture>
Returns any
-
Methods
create
-
Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
Parameters
-
direction1: Vector3
Particles are emitted between the direction1 and direction2 from within the box
-
direction2: Vector3
Particles are emitted between the direction1 and direction2 from within the box
-
minEmitBox: Vector3
Particles are emitted from the box between minEmitBox and maxEmitBox
-
maxEmitBox: Vector3
Particles are emitted from the box between minEmitBox and maxEmitBox
Returns BoxParticleEmitter
the emitter
-
create
-
Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
Parameters
-
Optional radius: number
The radius of the cone to emit from
-
Optional angle: number
The base angle of the cone
Returns ConeParticleEmitter
the emitter
-
create
-
Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
Parameters
-
Optional radius: number
The radius of the emission cylinder
-
Optional height: number
The height of the emission cylinder
-
Optional radiusRange: number
The range of emission [0-1] 0 Surface only, 1 Entire Radius
-
Optional directionRandomizer: number
How much to randomize the particle direction [0-1]
Returns CylinderParticleEmitter
the emitter
-
create
-
Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
Parameters
-
Optional radius: number
The radius of the cylinder to emit from
-
Optional height: number
The height of the emission cylinder
-
Optional radiusRange: number
the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
-
Optional direction1: Vector3
Particles are emitted between the direction1 and direction2 from within the cylinder
-
Optional direction2: Vector3
Particles are emitted between the direction1 and direction2 from within the cylinder
Returns CylinderDirectedParticleEmitter
the emitter
-
create
-
Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
Parameters
-
Optional radius: number
The radius of the sphere to emit from
-
Optional direction1: Vector3
Particles are emitted between the direction1 and direction2 from within the sphere
-
Optional direction2: Vector3
Particles are emitted between the direction1 and direction2 from within the sphere
Returns SphereDirectedParticleEmitter
the emitter
-
create
-
Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
Parameters
-
Optional radius: number
The radius of the hemisphere to emit from
-
Optional radiusRange: number
The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
Returns HemisphericParticleEmitter
the emitter
-
create
-
Creates a Point Emitter for the particle system (emits directly from the emitter position)
Parameters
-
direction1: Vector3
Particles are emitted between the direction1 and direction2 from within the box
-
direction2: Vector3
Particles are emitted between the direction1 and direction2 from within the box
Returns PointParticleEmitter
the emitter
-
create
-
Creates a Sphere Emitter for the particle system (emits along the sphere radius)
Parameters
-
Optional radius: number
The radius of the sphere to emit from
-
Optional radiusRange: number
The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
Returns SphereParticleEmitter
the emitter
-
get
-
Gets the current list of alpha remap gradients. You must use addAlphaRemapGradient and removeAlphaRemapGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of alpha remap gradients
get
-
Gets the current list of angular speed gradients. You must use addAngularSpeedGradient and removeAngularSpeedGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of angular speed gradients
get
-
Gets the current list of color gradients. You must use addColorGradient and removeColorGradient to update this list
Returns Nullable<Array<ColorGradient>>
the list of color gradients
get
-
Gets the current list of color remap gradients. You must use addColorRemapGradient and removeColorRemapGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of color remap gradients
get
-
Gets the current list of drag gradients. You must use addDragGradient and removeDragGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of drag gradients
get
-
Gets the current list of emit rate gradients. You must use addEmitRateGradient and removeEmitRateGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of emit rate gradients
get
-
Gets the current list of life time gradients. You must use addLifeTimeGradient and removeLifeTimeGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of life time gradients
get
-
Gets the current list of limit velocity gradients. You must use addLimitVelocityGradient and removeLimitVelocityGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of limit velocity gradients
get
get
-
Gets the current list of size gradients. You must use addSizeGradient and removeSizeGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of size gradients
get
-
Gets the current list of start size gradients. You must use addStartSizeGradient and removeStartSizeGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of start size gradients
get
-
Gets the current list of velocity gradients. You must use addVelocityGradient and removeVelocityGradient to update this list
Returns Nullable<Array<FactorGradient>>
the list of velocity gradients
This represents the base class for particle system in Babylon. Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust. Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
https://doc.babylonjs.com/babylon101/particles