Filter
Phaser . GameObjects . Particles . Zones . EdgeZone
Phaser . GameObjects . Particles . Zones . EdgeZone
A zone that places particles on a shape's edges.
Constructor:
new EdgeZone(source, quantity, stepRate, [yoyo], [seamless], [total])
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| source | Phaser.Types.GameObjects.Particles.EdgeZoneSource |
An object instance with a |
||
| quantity | number |
The number of particles to place on the source edge. Set to 0 to use |
||
| stepRate | number |
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. -1 means it will never pass over and you must use |
Members
Description:
The counter used for iterating the EdgeZone's points.
Type:
Description:
The points placed on the source edge.
Type:
Description:
The number of particles to place on the source edge. Set to 0 to use stepRate instead.
Type:
Description:
Whether one endpoint will be removed if it's identical to the other.
Type:
Description:
An object instance with a getPoints(quantity, stepRate) method returning an array of points.
Type:
Description:
The distance between each particle. When set, quantity is implied and should be set to 0.
Type:
Description:
The total number of particles this zone will emit before the Emitter transfers control over to the next zone in its emission zone list.
By default this is -1, meaning it will never pass over from this
zone to another one. You can call the ParticleEmitter.setEmitZone
method to change it, or set this value to something else via the
config, or directly at runtime.
A value of 1 would mean the zones rotate in order, but it can be set to any integer value.
Type:
Description:
Whether particles are placed from start to end and then end to start.
Type:
Methods
Description:
Change the source of the EdgeZone.
Parameters:
| name | type | description |
|---|---|---|
| source | Phaser.Types.GameObjects.Particles.EdgeZoneSource |
An object instance with a |
Returns:
Description:
This Edge Zone.
Description:
Get the next point in the Zone and set its coordinates on the given Particle.
Parameters:
| name | type | description |
|---|---|---|
| particle | Phaser.GameObjects.Particles.Particle |
The Particle. |
Description:
Update the Phaser.GameObjects.Particles.Zones.EdgeZone#points from the EdgeZone's Phaser.GameObjects.Particles.Zones.EdgeZone#source.
Also updates internal properties.
Returns:
Description:
This Edge Zone.