Filter
Phaser . GameObjects . Particles . Zones . DeathZone
Phaser . GameObjects . Particles . Zones . DeathZone
A Death Zone.
A Death Zone is a special type of zone that will kill a Particle as soon as it either enters, or leaves, the zone.
The zone consists of a source which could be a Geometric shape, such as a Rectangle or Ellipse, or your own
object as long as it includes a contains method for which the Particles can be tested against.
Constructor:
new DeathZone(source, killOnEnter)
Parameters:
| name | type | description |
|---|---|---|
| source | Phaser.Types.GameObjects.Particles.DeathZoneSource |
An object instance that has a |
| killOnEnter | boolean |
Should the Particle be killed when it enters the zone? |
Members
Description:
Set to true if the Particle should be killed if it enters this zone.
Set to false to kill the Particle if it leaves this zone.
Type:
Description:
An object instance that has a contains method that returns a boolean when given x and y arguments.
This could be a Geometry shape, such as Phaser.Geom.Circle, or your own custom object.
Methods
Description:
Checks if the given Particle will be killed or not by this zone.
Parameters:
| name | type | description |
|---|---|---|
| particle | Phaser.GameObjects.Particles.Particle |
The particle to test against this Death Zones. |
Returns:
Description:
Return true if the Particle is to be killed, otherwise return false.
Type:
- boolean