You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Class: 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.

new DeathZone(source, killOnEnter)

Parameters:
Name Type Description
source Phaser.Types.GameObjects.Particles.DeathZoneSource

An object instance that has a contains method that returns a boolean when given x and y arguments.
killOnEnter boolean

Should the Particle be killed when it enters the zone? true or leaves it? false
Since: 3.0.0
Source: src/gameobjects/particles/zones/DeathZone.js (Line 9)

Members

killOnEnter :boolean

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:
  • boolean
Since: 3.0.0
Source: src/gameobjects/particles/zones/DeathZone.js (Line 42)

source :Phaser.Types.GameObjects.Particles.DeathZoneSource

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.

Type:
Since: 3.0.0
Source: src/gameobjects/particles/zones/DeathZone.js (Line 32)

Methods

willKill(particle)

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 be checked against this zone.
Since: 3.0.0
Source: src/gameobjects/particles/zones/DeathZone.js (Line 53)
Returns:

Return true if the Particle is to be killed, otherwise return false.

Type
boolean