Skip to main content
Version: Phaser v3.88.2

Types.GameObjects.Particles

DeathZoneObject​

<static> DeathZoneObject​

Type: Phaser.GameObjects.Particles.Zones.DeathZone | Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig | Phaser.Types.GameObjects.Particles.DeathZoneSource

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/DeathZoneObject.js#L1
Since: 3.60.0

DeathZoneSource​

<static> DeathZoneSource​

nametypeoptionaldescription
containsPhaser.Types.GameObjects.Particles.DeathZoneSourceCallbackNoNo description provided

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/DeathZoneSource.js#L1
Since: 3.0.0

DeathZoneSourceCallback​

<static> DeathZoneSourceCallback​

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/DeathZoneSourceCallback.js#L1
Since: 3.0.0

EdgeZoneSource​

<static> EdgeZoneSource​

nametypeoptionaldescription
getPointsPhaser.Types.GameObjects.Particles.EdgeZoneSourceCallbackNoA function placing points on the sources edge or edges.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EdgeZoneSource.js#L1
Since: 3.0.0

EdgeZoneSourceCallback​

<static> EdgeZoneSourceCallback​

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EdgeZoneSourceCallback.js#L1
Since: 3.0.0

EmitZoneData​

<static> EmitZoneData​

Type: Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig | Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig | Phaser.GameObjects.Particles.Zones.EdgeZone | Phaser.GameObjects.Particles.Zones.RandomZone

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitZoneData.js#L1
Since: 3.60.0

EmitZoneObject​

<static> EmitZoneObject​

Type: Phaser.GameObjects.Particles.Zones.EdgeZone | Phaser.GameObjects.Particles.Zones.RandomZone

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitZoneObject.js#L1
Since: 3.60.0

EmitterOpCustomEmitConfig​

<static> EmitterOpCustomEmitConfig​

nametypeoptionaldescription
onEmitPhaser.Types.GameObjects.Particles.EmitterOpOnEmitCallbackNoA callback that is invoked each time the emitter emits a particle.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpCustomEmitConfig.js#L1
Since: 3.0.0

EmitterOpCustomUpdateConfig​

<static> EmitterOpCustomUpdateConfig​

nametypeoptionaldescription
onEmitPhaser.Types.GameObjects.Particles.EmitterOpOnEmitCallbackYesA callback that is invoked each time the emitter emits a particle.
onUpdatePhaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallbackNoA callback that is invoked each time the emitter updates.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpCustomUpdateConfig.js#L1
Since: 3.0.0

EmitterOpEaseConfig​

<static> EmitterOpEaseConfig​

Defines an operation yielding a value incremented continuously across a range.

nametypeoptionaldefaultdescription
startnumberNoThe starting value.
endnumberNoThe ending value.
randombooleanYesIf true, the particle starts with a minimum random value between the start and end values.
easestring | functionYes"'Linear'"The ease to find. This can be either a string from the EaseMap, or a custom function.
easeParamsArray.<number>YesAn optional array of ease parameters to go with the ease.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpEaseConfig.js#L1
Since: 3.0.0

EmitterOpInterpolationConfig​

<static> EmitterOpInterpolationConfig​

Defines an operation yielding a value incremented continuously across an interpolated data set.

nametypeoptionaldefaultdescription
valuesArray.<number>NoThe array of number values to interpolate through.
interpolationstring | functionYes"'Linear'"The interpolation function to use. Typically one of linear, bezier or catmull or a custom function.
easestring | functionYes"'Linear'"An optional ease function to use. This can be either a string from the EaseMap, or a custom function.
easeParamsArray.<number>YesAn optional array of ease parameters to go with the ease.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpInterpolationConfig.js#L1
Since: 3.60.0

EmitterOpOnEmitCallback​

<static> EmitterOpOnEmitCallback​

The returned value sets what the property will be at the START of the particle's life, on emit.

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpOnEmitCallback.js#L1
Since: 3.0.0

EmitterOpOnEmitType​

<static> EmitterOpOnEmitType​

Type: number | Array.<number> | Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback | Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig | Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig | Phaser.Types.GameObjects.Particles.EmitterOpSteppedConfig | Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpOnEmitType.js#L1
Since: 3.18.0

EmitterOpOnUpdateCallback​

<static> EmitterOpOnUpdateCallback​

The returned value updates the property for the duration of the particle's life.

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpOnUpdateCallback.js#L1
Since: 3.0.0

EmitterOpOnUpdateType​

<static> EmitterOpOnUpdateType​

Type: Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback | Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig | Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig | Phaser.Types.GameObjects.Particles.EmitterOpInterpolationConfig

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpOnUpdateType.js#L1
Since: 3.18.0

EmitterOpRandomConfig​

<static> EmitterOpRandomConfig​

Defines an operation yielding a random value within a range.

nametypeoptionaldescription
randomArray.<number>NoThe minimum and maximum values, as [min, max].

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpRandomConfig.js#L1
Since: 3.0.0

EmitterOpRandomMinMaxConfig​

<static> EmitterOpRandomMinMaxConfig​

Defines an operation yielding a random value within a range.

nametypeoptionaldescription
minnumberNoThe minimum value.
maxnumberNoThe maximum value.
intbooleanYesIf true, only integers are selected from the range.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpRandomMinMaxConfig.js#L1
Since: 3.0.0

EmitterOpSteppedConfig​

<static> EmitterOpSteppedConfig​

Defines an operation yielding a value incremented by steps across a range.

nametypeoptionaldescription
startnumberNoThe starting value.
endnumberNoThe ending value.
stepsnumberNoThe number of steps between start and end.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/EmitterOpSteppedConfig.js#L1
Since: 3.0.0

GravityWellConfig​

<static> GravityWellConfig​

nametypeoptionaldefaultdescription
xnumberYes0The x coordinate of the Gravity Well, in world space.
ynumberYes0The y coordinate of the Gravity Well, in world space.
powernumberYes0The strength of the gravity force - larger numbers produce a stronger force.
epsilonnumberYes100The minimum distance for which the gravity force is calculated.
gravitynumberYes50The gravitational force of this Gravity Well.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/GravityWellConfig.js#L1
Since: 3.0.0

ParticleClassConstructor​

<static> ParticleClassConstructor​

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleClassConstructor.js#L1
Since: 3.0.0

ParticleData​

<static> ParticleData​

nametypeoptionaldefaultdescription
tintPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0xffffff,max:0xffffff}"No description provided
alphaPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:1,max:1}"No description provided
rotatePhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
scaleXPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:1,max:1}"No description provided
scaleYPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:1,max:1}"No description provided
xPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
yPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
accelerationXPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
accelerationYPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
maxVelocityXPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
maxVelocityYPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
moveToXPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
moveToYPhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided
bouncePhaser.Types.GameObjects.Particles.ParticleDataValueYes"{min:0,max:0}"No description provided

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleData.js#L1
Since: 3.60.0

ParticleDataValue​

<static> ParticleDataValue​

nametypeoptionaldescription
minnumberNoThe minimum value.
maxnumberNoThe maximum value.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleDataValue.js#L1
Since: 3.60.0

ParticleDeathCallback​

<static> ParticleDeathCallback​

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleDeathCallback.js#L1
Since: 3.0.0

ParticleEmitterAnimConfig​

<static> ParticleEmitterAnimConfig​

nametypeoptionaldefaultdescription
animsstring | Array.<string>Phaser.Types.Animations.PlayAnimationConfigArray.<Phaser.Types.Animations.PlayAnimationConfig>Yes
cyclebooleanYesfalseWhether animations will be assigned consecutively (true) or at random (false).
quantitynumberYes1The number of consecutive particles receiving each animation, when cycle is true.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterAnimConfig.js#L1
Since: 3.60.0

ParticleEmitterBounds​

<static> ParticleEmitterBounds​

nametypeoptionaldescription
xnumberNoThe left edge of the rectangle.
ynumberNoThe top edge of the rectangle.
widthnumberNoThe width of the rectangle.
heightnumberNoThe height of the rectangle.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterBounds.js#L1
Since: 3.0.0

ParticleEmitterBoundsAlt​

<static> ParticleEmitterBoundsAlt​

nametypeoptionaldescription
xnumberNoThe left edge of the rectangle.
ynumberNoThe top edge of the rectangle.
wnumberNoThe width of the rectangle.
hnumberNoThe height of the rectangle.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterBoundsAlt.js#L1
Since: 3.0.0

ParticleEmitterCallback​

<static> ParticleEmitterCallback​

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterCallback.js#L1
Since: 3.0.0

ParticleEmitterConfig​

<static> ParticleEmitterConfig​

nametypeoptionaldescription
activebooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#active}. Setting this to false will stop the emitter from running at all. If you just wish to stop particles from emitting, set emitting property instead.
blendModePhaser.BlendModes | stringYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#blendMode}.
callbackScope*YesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope} and {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.
collideBottombooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideBottom}.
collideLeftbooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideLeft}.
collideRightbooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideRight}.
collideTopbooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideTop}.
deathCallbackfunctionYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.
deathCallbackScope*YesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope}.
emitCallbackfunctionYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.
emitCallbackScope*YesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.
followPhaser.Types.Math.Vector2LikeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#follow}.
frequencynumberYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}.
gravityXnumberYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityX}.
gravityYnumberYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityY}.
maxParticlesnumberYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxParticles}.
maxAliveParticlesnumberYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxAliveParticles}.
namestringYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#name}.
emittingbooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitting}.
particleBringToTopbooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop}.
particleClassfunctionYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleClass}.
radialbooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#radial}.
timeScalenumberYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}.
trackVisiblebooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}.
visiblebooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#visible}.
accelerationXPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationX}.
accelerationYPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationY}.
alphaPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleAlpha}.
anglePhaser.Types.GameObjects.Particles.EmitterOpOnEmitTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleAngle} (emit only).
bouncePhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#bounce}.
delayPhaser.Types.GameObjects.Particles.EmitterOpOnEmitTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#delay} (emit only).
holdPhaser.Types.GameObjects.Particles.EmitterOpOnEmitTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#hold} (emit only).
lifespanPhaser.Types.GameObjects.Particles.EmitterOpOnEmitTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#lifespan} (emit only).
maxVelocityXPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX}.
maxVelocityYPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY}.
moveToXPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToX}. If set, overrides angle and speed properties.
moveToYPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToY}. If set, overrides angle and speed properties.
quantityPhaser.Types.GameObjects.Particles.EmitterOpOnEmitTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity} (emit only).
rotatePhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleRotate}.
scalePhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesAs {@link Phaser.GameObjects.Particles.ParticleEmitter#setScale}.
scaleXPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleScaleX}.
scaleYPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleScaleY}.
speedPhaser.Types.GameObjects.Particles.EmitterOpOnEmitTypeYesAs {@link Phaser.GameObjects.Particles.ParticleEmitter#setSpeed} (emit only).
speedXPhaser.Types.GameObjects.Particles.EmitterOpOnEmitTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedX} (emit only).
speedYPhaser.Types.GameObjects.Particles.EmitterOpOnEmitTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedY} (emit only).
tintPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleTint}.
colorArray.<number>YesAn array of color values that the Particles interpolate through during their life. If set, overrides any tint property.
colorEasestringYesThe string-based name of the Easing function to use if you have enabled Particle color interpolation via the color property, otherwise has no effect.
xPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleX}.
yPhaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateTypeYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleY}.
emitZonePhaser.Types.GameObjects.Particles.EmitZoneData | Array.<Phaser.Types.GameObjects.Particles.EmitZoneData>YesAs {@link Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone}.
deathZonePhaser.Types.GameObjects.Particles.DeathZoneObject | Array.<Phaser.Types.GameObjects.Particles.DeathZoneObject>YesAs {@link Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone}.
boundsPhaser.Types.GameObjects.Particles.ParticleEmitterBounds | Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAltYesAs {@link Phaser.GameObjects.Particles.ParticleEmitter#setBounds}.
followOffsetPhaser.Types.Math.Vector2LikeYesOffset coordinates that assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.
animstring | Array.<string>Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfigYes
framenumber | Array.<number>stringArray.<string>
texturestring | Phaser.Textures.TextureYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#texture}. Overrides any texture already set on the Emitter.
reservenumberYesCreates specified number of inactive particles and adds them to this emitter's pool. {@link Phaser.GameObjects.Particles.ParticleEmitter#reserve}
advancenumberYesIf you wish to 'fast forward' the emitter in time, set this value to a number representing the amount of ms the emitter should advance. Doing so implicitly sets emitting to true.
durationnumberYesLimit the emitter to emit particles for a maximum of duration ms. Default to zero, meaning 'forever'.
stopAfternumberYesLimit the emitter to emit this exact number of particles and then stop. Default to zero, meaning no limit.
sortCallbackPhaser.Types.GameObjects.Particles.ParticleSortCallbackYesA custom callback that sorts particles prior to rendering. Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortCallback}.
sortOrderAscbooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortOrderAsc}.
sortPropertystringYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortProperty}.
tintFillbooleanYesSets {@link Phaser.GameObjects.Particles.ParticleEmitter#tintFill}.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterConfig.js#L1
Since: 3.0.0

ParticleEmitterCreatorConfig​

<static> ParticleEmitterCreatorConfig​

nametypeoptionaldescription
keystringYesThe key of the Texture this Emitter will use to render particles, as stored in the Texture Manager.
configPhaser.Types.GameObjects.Particles.ParticleEmitterConfigYesThe Particle Emitter configuration object.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterCreatorConfig.js#L1
Since: 3.60.0

ParticleEmitterDeathZoneConfig​

<static> ParticleEmitterDeathZoneConfig​

nametypeoptionaldefaultdescription
sourcePhaser.Types.GameObjects.Particles.DeathZoneSourceNoA shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.DeathZone#source}.
typestringYes"'onEnter'"'onEnter' or 'onLeave'.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterDeathZoneConfig.js#L1
Since: 3.0.0

ParticleEmitterEdgeZoneConfig​

<static> ParticleEmitterEdgeZoneConfig​

nametypeoptionaldefaultdescription
sourcePhaser.Types.GameObjects.Particles.EdgeZoneSourceNoA shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.
typestringNo'edge'.
quantitynumberNoThe number of particles to place on the source edge. Set to 0 to use stepRate instead.
stepRatenumberYesThe distance between each particle. When set, quantity is implied and should be set to 0.
yoyobooleanYesfalseWhether particles are placed from start to end and then end to start.
seamlessbooleanYestrueWhether one endpoint will be removed if it's identical to the other.
totalnumberYes1The total number of particles this zone will emit before passing over to the next emission zone in the Emitter.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterEdgeZoneConfig.js#L1
Since: 3.0.0

ParticleEmitterFrameConfig​

<static> ParticleEmitterFrameConfig​

nametypeoptionaldescription
framesArray.<number> | Array.<string>Array.<Phaser.Textures.Frame>Yes
cyclebooleanYesWhether texture frames will be assigned consecutively (true) or at random (false).
quantitynumberYesThe number of consecutive particles receiving each texture frame, when cycle is true.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterFrameConfig.js#L1
Since: 3.0.0

ParticleEmitterOps​

<static> ParticleEmitterOps​

nametypeoptionaldescription
accelerationXPhaser.GameObjects.Particles.EmitterOpNoThe accelerationX EmitterOp instance. This is an onEmit and onUpdate operator.
accelerationYPhaser.GameObjects.Particles.EmitterOpNoThe accelerationY EmitterOp instance. This is an onEmit and onUpdate operator.
alphaPhaser.GameObjects.Particles.EmitterOpNoThe alpha EmitterOp instance. This is an onEmit and onUpdate operator.
anglePhaser.GameObjects.Particles.EmitterOpNoThe angle EmitterOp instance. This is an onEmit operator only.
bouncePhaser.GameObjects.Particles.EmitterOpNoThe bounce EmitterOp instance. This is an onEmit and onUpdate operator.
colorPhaser.GameObjects.Particles.EmitterColorOpNoThe color EmitterColorOp instance. This is an onEmit and onUpdate operator.
delayPhaser.GameObjects.Particles.EmitterOpNoThe delay EmitterOp instance. This is an onEmit operator only.
holdPhaser.GameObjects.Particles.EmitterOpNoThe hold EmitterOp instance. This is an onEmit operator only.
lifespanPhaser.GameObjects.Particles.EmitterOpNoThe lifespan EmitterOp instance. This is an onEmit operator only.
maxVelocityXPhaser.GameObjects.Particles.EmitterOpNoThe maxVelocityX EmitterOp instance. This is an onEmit and onUpdate operator.
maxVelocityYPhaser.GameObjects.Particles.EmitterOpNoThe maxVelocityY EmitterOp instance. This is an onEmit and onUpdate operator.
moveToXPhaser.GameObjects.Particles.EmitterOpNoThe moveToX EmitterOp instance. This is an onEmit and onUpdate operator.
moveToYPhaser.GameObjects.Particles.EmitterOpNoThe moveToY EmitterOp instance. This is an onEmit and onUpdate operator.
quantityPhaser.GameObjects.Particles.EmitterOpNoThe quantity EmitterOp instance. This is an onEmit operator only.
rotatePhaser.GameObjects.Particles.EmitterOpNoThe rotate EmitterOp instance. This is an onEmit and onUpdate operator.
scaleXPhaser.GameObjects.Particles.EmitterOpNoThe scaleX EmitterOp instance. This is an onEmit and onUpdate operator.
scaleYPhaser.GameObjects.Particles.EmitterOpNoThe scaleY EmitterOp instance. This is an onEmit and onUpdate operator.
speedXPhaser.GameObjects.Particles.EmitterOpNoThe speedX EmitterOp instance. This is an onEmit operator only.
speedYPhaser.GameObjects.Particles.EmitterOpNoThe speedY EmitterOp instance. This is an onEmit operator only.
tintPhaser.GameObjects.Particles.EmitterOpNoThe tint EmitterOp instance. This is an onEmit and onUpdate operator.
xPhaser.GameObjects.Particles.EmitterOpNoThe x EmitterOp instance. This is an onEmit and onUpdate operator.
yPhaser.GameObjects.Particles.EmitterOpNoThe y EmitterOp instance. This is an onEmit and onUpdate operator.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterOps.js#L1
Since: 3.60.0

ParticleEmitterRandomZoneConfig​

<static> ParticleEmitterRandomZoneConfig​

nametypeoptionaldescription
sourcePhaser.Types.GameObjects.Particles.RandomZoneSourceNoA shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.RandomZone#source}.
typestringYes'random'.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleEmitterRandomZoneConfig.js#L1
Since: 3.0.0

ParticleSortCallback​

<static> ParticleSortCallback​

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/ParticleSortCallback.js#L1
Since: 3.60.0

RandomZoneSource​

<static> RandomZoneSource​

nametypeoptionaldescription
getRandomPointPhaser.Types.GameObjects.Particles.RandomZoneSourceCallbackNoA function modifying its point argument.

Type: object

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/RandomZoneSource.js#L1
Since: 3.0.0

RandomZoneSourceCallback​

<static> RandomZoneSourceCallback​

Type: function

Member of: Phaser.Types.GameObjects.Particles

Source: src/gameobjects/particles/typedefs/RandomZoneSourceCallback.js#L1
Since: 3.0.0