Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . GameObjects . Particles . GravityWell

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . GameObjects . Particles . GravityWell

The GravityWell action applies a force on the particle to draw it towards, or repel it from, a single point.

The force applied is inversely proportional to the square of the distance from the particle to the point, in accordance with Newton's law of gravity.

This simulates the effect of gravity over large distances (as between planets, for example).

Constructor:

new GravityWell([x], [y], [power], [epsilon], [gravity])

Parameters:

name type arguments Default description
x number | Phaser.Types.GameObjects.Particles.GravityWellConfig <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.

Since: 3.0.0

Members

<private> _epsilon: number
Focus
Focus

Description:

Internal epsilon value.

Type:
number
Default: 0
Since: 3.0.0
Focus
Focus
<private> _gravity: number
Focus
Focus

Description:

Internal gravity value.

Type:
number
Since: 3.0.0
Focus
Focus
<private> _power: number
Focus
Focus

Description:

Internal power value.

Type:
number
Default: 0
Since: 3.0.0
Focus
Focus
active: boolean
Focus
Focus

Description:

The active state of the Gravity Well. An inactive Gravity Well will not influence any particles.

Type:
boolean
Default: true
Since: 3.0.0
Focus
Focus
epsilon: number
Focus
Focus

Description:

The minimum distance for which the gravity force is calculated.

Type:
number
Since: 3.0.0
Focus
Focus
power: number
Focus
Focus

Description:

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

Type:
number
Since: 3.0.0
Focus
Focus
x: number
Focus
Focus

Description:

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

Type:
number
Since: 3.0.0
Focus
Focus
y: number
Focus
Focus

Description:

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

Type:
number
Since: 3.0.0
Focus
Focus

Methods

update(particle, delta, step)
Focus
Focus

Description:

Takes a Particle and updates it based on the properties of this Gravity Well.

Parameters:

name type description
particle Phaser.GameObjects.Particles.Particle

The Particle to update.

delta number

The delta time in ms.

step number

The delta value divided by 1000.

Examples:
Since: 3.0.0
Focus
Focus