name | type |
---|---|
contains | Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback |
name | type | description |
---|---|---|
x | number |
The x coordinate of the particle to check against this source area. |
y | number |
The y coordinate of the particle to check against this source area. |
name | type | description |
---|---|---|
getPoints | Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback |
A function placing points on the sources edge or edges. |
name | type | arguments | description |
---|---|---|---|
quantity | number |
The number of particles to place on the source edge. If 0, |
|
stepRate | number | <optional> |
The distance between each particle. When set, |
name | type | description |
---|---|---|
onEmit | Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback |
A callback that is invoked each time the emitter emits a particle. |
name | type | arguments | description |
---|---|---|---|
onEmit | Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback | <optional> |
A callback that is invoked each time the emitter emits a particle. |
onUpdate | Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback |
A callback that is invoked each time the emitter updates. |
Defines an operation yielding a value incremented continuously across a range.
name | type | arguments | Default | description |
---|---|---|---|---|
start | number |
The starting value. |
||
end | number |
The ending value. |
||
random | boolean | <optional> |
If true, the particle starts with a minimum random value between the start and end values. |
|
ease | string | function | <optional> | 'Linear' |
The ease to find. This can be either a string from the EaseMap, or a custom function. |
easeParams | Array.<number> | <optional> |
An optional array of ease parameters to go with the ease. |
Defines an operation yielding a value incremented continuously across an interpolated data set.
name | type | arguments | Default | description |
---|---|---|---|---|
values | Array.<number> |
The array of number values to interpolate through. |
||
interpolation | string | function | <optional> | 'Linear' |
The interpolation function to use. Typically one of |
ease | string | function | <optional> | 'Linear' |
An optional ease function to use. This can be either a string from the EaseMap, or a custom function. |
easeParams | Array.<number> | <optional> |
An optional array of ease parameters to go with the ease. |
The returned value sets what the property will be at the START of the particle's life, on emit.
name | type | arguments | description |
---|---|---|---|
particle | Phaser.GameObjects.Particles.Particle | <optional> |
The particle. |
key | string | <optional> |
The name of the property. |
value | number | <optional> |
The current value of the property. |
The new value of the property.
The returned value updates the property for the duration of the particle's life.
name | type | description |
---|---|---|
particle | Phaser.GameObjects.Particles.Particle |
The particle. |
key | string |
The name of the property. |
t | number |
The normalized lifetime of the particle, between 0 (start) and 1 (end). |
value | number |
The current value of the property. |
The new value of the property.
Defines an operation yielding a random value within a range.
name | type | description |
---|---|---|
random | Array.<number> |
The minimum and maximum values, as [min, max]. |
Defines an operation yielding a random value within a range.
name | type | arguments | description |
---|---|---|---|
min | number |
The minimum value. |
|
max | number |
The maximum value. |
|
int | boolean | <optional> |
If true, only integers are selected from the range. |
Defines an operation yielding a value incremented by steps across a range.
name | type | description |
---|---|---|
start | number |
The starting value. |
end | number |
The ending value. |
steps | number |
The number of steps between start and end. |
name | type | arguments | Default | description |
---|---|---|---|---|
x | number | <optional> | 0 |
The x coordinate of the Gravity Well, in world space. |
y | number | <optional> | 0 |
The y coordinate of the Gravity Well, in world space. |
power | number | <optional> | 0 |
The strength of the gravity force - larger numbers produce a stronger force. |
epsilon | number | <optional> | 100 |
The minimum distance for which the gravity force is calculated. |
gravity | number | <optional> | 50 |
The gravitational force of this Gravity Well. |
name | type | description |
---|---|---|
emitter | Phaser.GameObjects.Particles.ParticleEmitter |
The Emitter to which this Particle belongs. |
name | type | description |
---|---|---|
min | number |
The minimum value. |
max | number |
The maximum value. |
name | type | description |
---|---|---|
particle | Phaser.GameObjects.Particles.Particle |
The particle that died. |
name | type | arguments | Default | description |
---|---|---|---|---|
anims | string | Array.<string> | Phaser.Types.Animations.PlayAnimationConfig | Array.<Phaser.Types.Animations.PlayAnimationConfig> | <optional> |
One or more animations names, or Play Animation Config objects. |
|
cycle | boolean | <optional> | false |
Whether animations will be assigned consecutively (true) or at random (false). |
quantity | number | <optional> | 1 |
The number of consecutive particles receiving each animation, when |
name | type | description |
---|---|---|
x | number |
The left edge of the rectangle. |
y | number |
The top edge of the rectangle. |
width | number |
The width of the rectangle. |
height | number |
The height of the rectangle. |
name | type | description |
---|---|---|
x | number |
The left edge of the rectangle. |
y | number |
The top edge of the rectangle. |
w | number |
The width of the rectangle. |
h | number |
The height of the rectangle. |
name | type | description |
---|---|---|
particle | Phaser.GameObjects.Particles.Particle |
The particle associated with the call. |
emitter | Phaser.GameObjects.Particles.ParticleEmitter |
This particle emitter associated with the call. |
name | type | arguments | description |
---|---|---|---|
key | string | <optional> |
The key of the Texture this Emitter will use to render particles, as stored in the Texture Manager. |
config | Phaser.Types.GameObjects.Particles.ParticleEmitterConfig | <optional> |
The Particle Emitter configuration object. |
name | type | arguments | Default | description |
---|---|---|---|---|
source | Phaser.Types.GameObjects.Particles.DeathZoneSource |
A shape representing the zone. See Phaser.GameObjects.Particles.Zones.DeathZone#source. |
||
type | string | <optional> | 'onEnter' |
'onEnter' or 'onLeave'. |
name | type | arguments | Default | description |
---|---|---|---|---|
source | Phaser.Types.GameObjects.Particles.EdgeZoneSource |
A shape representing the zone. See Phaser.GameObjects.Particles.Zones.EdgeZone#source. |
||
type | string |
'edge'. |
||
quantity | number |
The number of particles to place on the source edge. Set to 0 to use |
||
stepRate | number | <optional> |
The distance between each particle. When set, |
|
yoyo | boolean | <optional> | false |
Whether particles are placed from start to end and then end to start. |
seamless | boolean | <optional> | true |
Whether one endpoint will be removed if it's identical to the other. |
total | number | <optional> | 1 |
The total number of particles this zone will emit before passing over to the next emission zone in the Emitter. |
name | type | arguments | description |
---|---|---|---|
frames | Array.<number> | Array.<string> | Array.<Phaser.Textures.Frame> | <optional> |
Array of texture frames. |
cycle | boolean | <optional> |
Whether texture frames will be assigned consecutively (true) or at random (false). |
quantity | number | <optional> |
The number of consecutive particles receiving each texture frame, when |
name | type | description |
---|---|---|
accelerationX | Phaser.GameObjects.Particles.EmitterOp |
The accelerationX EmitterOp instance. This is an onEmit and onUpdate operator. |
accelerationY | Phaser.GameObjects.Particles.EmitterOp |
The accelerationY EmitterOp instance. This is an onEmit and onUpdate operator. |
alpha | Phaser.GameObjects.Particles.EmitterOp |
The alpha EmitterOp instance. This is an onEmit and onUpdate operator. |
angle | Phaser.GameObjects.Particles.EmitterOp |
The angle EmitterOp instance. This is an onEmit operator only. |
bounce | Phaser.GameObjects.Particles.EmitterOp |
The bounce EmitterOp instance. This is an onEmit and onUpdate operator. |
color | Phaser.GameObjects.Particles.EmitterColorOp |
The color EmitterColorOp instance. This is an onEmit and onUpdate operator. |
delay | Phaser.GameObjects.Particles.EmitterOp |
The delay EmitterOp instance. This is an onEmit operator only. |
hold | Phaser.GameObjects.Particles.EmitterOp |
The hold EmitterOp instance. This is an onEmit operator only. |
lifespan | Phaser.GameObjects.Particles.EmitterOp |
The lifespan EmitterOp instance. This is an onEmit operator only. |
maxVelocityX | Phaser.GameObjects.Particles.EmitterOp |
The maxVelocityX EmitterOp instance. This is an onEmit and onUpdate operator. |
maxVelocityY | Phaser.GameObjects.Particles.EmitterOp |
The maxVelocityY EmitterOp instance. This is an onEmit and onUpdate operator. |
moveToX | Phaser.GameObjects.Particles.EmitterOp |
The moveToX EmitterOp instance. This is an onEmit and onUpdate operator. |
moveToY | Phaser.GameObjects.Particles.EmitterOp |
The moveToY EmitterOp instance. This is an onEmit and onUpdate operator. |
quantity | Phaser.GameObjects.Particles.EmitterOp |
The quantity EmitterOp instance. This is an onEmit operator only. |
rotate | Phaser.GameObjects.Particles.EmitterOp |
The rotate EmitterOp instance. This is an onEmit and onUpdate operator. |
scaleX | Phaser.GameObjects.Particles.EmitterOp |
The scaleX EmitterOp instance. This is an onEmit and onUpdate operator. |
scaleY | Phaser.GameObjects.Particles.EmitterOp |
The scaleY EmitterOp instance. This is an onEmit and onUpdate operator. |
speedX | Phaser.GameObjects.Particles.EmitterOp |
The speedX EmitterOp instance. This is an onEmit operator only. |
speedY | Phaser.GameObjects.Particles.EmitterOp |
The speedY EmitterOp instance. This is an onEmit operator only. |
tint | Phaser.GameObjects.Particles.EmitterOp |
The tint EmitterOp instance. This is an onEmit and onUpdate operator. |
x | Phaser.GameObjects.Particles.EmitterOp |
The x EmitterOp instance. This is an onEmit and onUpdate operator. |
y | Phaser.GameObjects.Particles.EmitterOp |
The y EmitterOp instance. This is an onEmit and onUpdate operator. |
name | type | arguments | description |
---|---|---|---|
source | Phaser.Types.GameObjects.Particles.RandomZoneSource |
A shape representing the zone. See Phaser.GameObjects.Particles.Zones.RandomZone#source. |
|
type | string | <optional> |
'random'. |
name | type | description |
---|---|---|
a | Phaser.GameObjects.Particles.Particle |
The first Particle being compared. |
b | Phaser.GameObjects.Particles.Particle |
The second Particle being compared. |
name | type | description |
---|---|---|
getRandomPoint | Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback |
A function modifying its point argument. |
name | type | description |
---|---|---|
point | Phaser.Types.Math.Vector2Like |
A point to modify. |