Types.GameObjects.Particles

contains

Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback

No

No description provided

getPoints

Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback

No

A function placing points on the sources edge or edges.

onEmit

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback

No

A callback that is invoked each time the emitter emits a particle.

onEmit

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback

Yes

A callback that is invoked each time the emitter emits a particle.

onUpdate

Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback

No

A callback that is invoked each time the emitter updates.

start

number

No

The starting value.

end

number

No

The ending value.

random

boolean

Yes

If true, the particle starts with a minimum random value between the start and end values.

ease

string | function

Yes

"'Linear'"

The ease to find. This can be either a string from the EaseMap, or a custom function.

easeParams

Array.<number>

Yes

An optional array of ease parameters to go with the ease.

values

Array.<number>

No

The array of number values to interpolate through.

interpolation

string | function

Yes

"'Linear'"

The interpolation function to use. Typically one of linear, bezier or catmull or a custom function.

ease

string | function

Yes

"'Linear'"

An optional ease function to use. This can be either a string from the EaseMap, or a custom function.

easeParams

Array.<number>

Yes

An optional array of ease parameters to go with the ease.

random

Array.<number>

No

The minimum and maximum values, as [min, max].

min

number

No

The minimum value.

max

number

No

The maximum value.

int

boolean

Yes

If true, only integers are selected from the range.

start

number

No

The starting value.

end

number

No

The ending value.

steps

number

No

The number of steps between start and end.

x

number

Yes

0

The x coordinate of the Gravity Well, in world space.

y

number

Yes

0

The y coordinate of the Gravity Well, in world space.

power

number

Yes

0

The strength of the gravity force - larger numbers produce a stronger force.

epsilon

number

Yes

100

The minimum distance for which the gravity force is calculated.

gravity

number

Yes

50

The gravitational force of this Gravity Well.

tint

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0xffffff,max:0xffffff}"

No description provided

alpha

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:1,max:1}"

No description provided

rotate

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

scaleX

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:1,max:1}"

No description provided

scaleY

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:1,max:1}"

No description provided

x

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

y

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

accelerationX

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

accelerationY

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

maxVelocityX

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

maxVelocityY

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

moveToX

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

moveToY

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

bounce

Phaser.Types.GameObjects.Particles.ParticleDataValue

Yes

"{min:0,max:0}"

No description provided

min

number

No

The minimum value.

max

number

No

The maximum value.

anims

string | Array.<string>

Phaser.Types.Animations.PlayAnimationConfig

Array.<Phaser.Types.Animations.PlayAnimationConfig>

Yes

cycle

boolean

Yes

false

Whether animations will be assigned consecutively (true) or at random (false).

quantity

number

Yes

1

The number of consecutive particles receiving each animation, when cycle is true.

x

number

No

The left edge of the rectangle.

y

number

No

The top edge of the rectangle.

width

number

No

The width of the rectangle.

height

number

No

The height of the rectangle.

x

number

No

The left edge of the rectangle.

y

number

No

The top edge of the rectangle.

w

number

No

The width of the rectangle.

h

number

No

The height of the rectangle.

active

boolean

Yes

Sets {@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.

blendMode

Phaser.BlendModes | string

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#blendMode}.

callbackScope

*

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope} and {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.

collideBottom

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideBottom}.

collideLeft

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideLeft}.

collideRight

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideRight}.

collideTop

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideTop}.

deathCallback

function

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.

deathCallbackScope

*

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope}.

emitCallback

function

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.

emitCallbackScope

*

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.

follow

Phaser.Types.Math.Vector2Like

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#follow}.

frequency

number

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}.

gravityX

number

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityX}.

gravityY

number

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityY}.

maxParticles

number

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxParticles}.

maxAliveParticles

number

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxAliveParticles}.

name

string

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#name}.

emitting

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitting}.

particleBringToTop

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop}.

particleClass

function

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleClass}.

radial

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#radial}.

timeScale

number

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}.

trackVisible

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}.

visible

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#visible}.

accelerationX

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationX}.

accelerationY

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationY}.

alpha

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleAlpha}.

angle

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleAngle} (emit only).

bounce

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#bounce}.

delay

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#delay} (emit only).

hold

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#hold} (emit only).

lifespan

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#lifespan} (emit only).

maxVelocityX

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX}.

maxVelocityY

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY}.

moveToX

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToX}. If set, overrides angle and speed properties.

moveToY

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToY}. If set, overrides angle and speed properties.

quantity

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity} (emit only).

rotate

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleRotate}.

scale

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

As {@link Phaser.GameObjects.Particles.ParticleEmitter#setScale}.

scaleX

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleScaleX}.

scaleY

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleScaleY}.

speed

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType

Yes

As {@link Phaser.GameObjects.Particles.ParticleEmitter#setSpeed} (emit only).

speedX

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedX} (emit only).

speedY

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedY} (emit only).

tint

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleTint}.

color

Array.<number>

Yes

An array of color values that the Particles interpolate through during their life. If set, overrides any tint property.

colorEase

string

Yes

The string-based name of the Easing function to use if you have enabled Particle color interpolation via the color property, otherwise has no effect.

x

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleX}.

y

Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleY}.

emitZone

Phaser.Types.GameObjects.Particles.EmitZoneData | Array.<Phaser.Types.GameObjects.Particles.EmitZoneData>

Yes

As {@link Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone}.

deathZone

Phaser.Types.GameObjects.Particles.DeathZoneObject | Array.<Phaser.Types.GameObjects.Particles.DeathZoneObject>

Yes

As {@link Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone}.

bounds

Phaser.Types.GameObjects.Particles.ParticleEmitterBounds | Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt

Yes

As {@link Phaser.GameObjects.Particles.ParticleEmitter#setBounds}.

followOffset

Phaser.Types.Math.Vector2Like

Yes

Offset coordinates that assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.

anim

string | Array.<string>

Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig

Yes

frame

number | Array.<number>

string

Array.<string>

texture

string | Phaser.Textures.Texture

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#texture}. Overrides any texture already set on the Emitter.

reserve

number

Yes

Creates specified number of inactive particles and adds them to this emitter's pool. {@link Phaser.GameObjects.Particles.ParticleEmitter#reserve}

advance

number

Yes

If 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.

duration

number

Yes

Limit the emitter to emit particles for a maximum of duration ms. Default to zero, meaning 'forever'.

stopAfter

number

Yes

Limit the emitter to emit this exact number of particles and then stop. Default to zero, meaning no limit.

sortCallback

Phaser.Types.GameObjects.Particles.ParticleSortCallback

Yes

A custom callback that sorts particles prior to rendering. Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortCallback}.

sortOrderAsc

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortOrderAsc}.

sortProperty

string

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortProperty}.

tintFill

boolean

Yes

Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tintFill}.

key

string

Yes

The key of the Texture this Emitter will use to render particles, as stored in the Texture Manager.

config

Phaser.Types.GameObjects.Particles.ParticleEmitterConfig

Yes

The Particle Emitter configuration object.

source

Phaser.Types.GameObjects.Particles.DeathZoneSource

No

A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.DeathZone#source}.

type

string

Yes

"'onEnter'"

'onEnter' or 'onLeave'.

source

Phaser.Types.GameObjects.Particles.EdgeZoneSource

No

A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.

type

string

No

'edge'.

quantity

number

No

The number of particles to place on the source edge. Set to 0 to use stepRate instead.

stepRate

number

Yes

The distance between each particle. When set, quantity is implied and should be set to 0.

yoyo

boolean

Yes

false

Whether particles are placed from start to end and then end to start.

seamless

boolean

Yes

true

Whether one endpoint will be removed if it's identical to the other.

total

number

Yes

1

The total number of particles this zone will emit before passing over to the next emission zone in the Emitter.

frames

Array.<number> | Array.<string>

Array.<Phaser.Textures.Frame>

Yes

cycle

boolean

Yes

Whether texture frames will be assigned consecutively (true) or at random (false).

quantity

number

Yes

The number of consecutive particles receiving each texture frame, when cycle is true.

accelerationX

Phaser.GameObjects.Particles.EmitterOp

No

The accelerationX EmitterOp instance. This is an onEmit and onUpdate operator.

accelerationY

Phaser.GameObjects.Particles.EmitterOp

No

The accelerationY EmitterOp instance. This is an onEmit and onUpdate operator.

alpha

Phaser.GameObjects.Particles.EmitterOp

No

The alpha EmitterOp instance. This is an onEmit and onUpdate operator.

angle

Phaser.GameObjects.Particles.EmitterOp

No

The angle EmitterOp instance. This is an onEmit operator only.

bounce

Phaser.GameObjects.Particles.EmitterOp

No

The bounce EmitterOp instance. This is an onEmit and onUpdate operator.

color

Phaser.GameObjects.Particles.EmitterColorOp

No

The color EmitterColorOp instance. This is an onEmit and onUpdate operator.

delay

Phaser.GameObjects.Particles.EmitterOp

No

The delay EmitterOp instance. This is an onEmit operator only.

hold

Phaser.GameObjects.Particles.EmitterOp

No

The hold EmitterOp instance. This is an onEmit operator only.

lifespan

Phaser.GameObjects.Particles.EmitterOp

No

The lifespan EmitterOp instance. This is an onEmit operator only.

maxVelocityX

Phaser.GameObjects.Particles.EmitterOp

No

The maxVelocityX EmitterOp instance. This is an onEmit and onUpdate operator.

maxVelocityY

Phaser.GameObjects.Particles.EmitterOp

No

The maxVelocityY EmitterOp instance. This is an onEmit and onUpdate operator.

moveToX

Phaser.GameObjects.Particles.EmitterOp

No

The moveToX EmitterOp instance. This is an onEmit and onUpdate operator.

moveToY

Phaser.GameObjects.Particles.EmitterOp

No

The moveToY EmitterOp instance. This is an onEmit and onUpdate operator.

quantity

Phaser.GameObjects.Particles.EmitterOp

No

The quantity EmitterOp instance. This is an onEmit operator only.

rotate

Phaser.GameObjects.Particles.EmitterOp

No

The rotate EmitterOp instance. This is an onEmit and onUpdate operator.

scaleX

Phaser.GameObjects.Particles.EmitterOp

No

The scaleX EmitterOp instance. This is an onEmit and onUpdate operator.

scaleY

Phaser.GameObjects.Particles.EmitterOp

No

The scaleY EmitterOp instance. This is an onEmit and onUpdate operator.

speedX

Phaser.GameObjects.Particles.EmitterOp

No

The speedX EmitterOp instance. This is an onEmit operator only.

speedY

Phaser.GameObjects.Particles.EmitterOp

No

The speedY EmitterOp instance. This is an onEmit operator only.

tint

Phaser.GameObjects.Particles.EmitterOp

No

The tint EmitterOp instance. This is an onEmit and onUpdate operator.

x

Phaser.GameObjects.Particles.EmitterOp

No

The x EmitterOp instance. This is an onEmit and onUpdate operator.

y

Phaser.GameObjects.Particles.EmitterOp

No

The y EmitterOp instance. This is an onEmit and onUpdate operator.

source

Phaser.Types.GameObjects.Particles.RandomZoneSource

No

A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.RandomZone#source}.

type

string

Yes

'random'.

getRandomPoint

Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback

No

A function modifying its point argument.