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

Class: GravityWell

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).

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

Parameters:
Name Type Argument 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
Source: src/gameobjects/particles/GravityWell.js (Line 10)

Members

active :boolean

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

Type:
  • boolean
Since: 3.0.0
Default Value:
  • true
Source: src/gameobjects/particles/GravityWell.js (Line 72)

epsilon :number

The minimum distance for which the gravity force is calculated.

Type:
  • number
Since: 3.0.0
Source: src/gameobjects/particles/GravityWell.js (Line 123)

power :number

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

Type:
  • number
Since: 3.0.0
Source: src/gameobjects/particles/GravityWell.js (Line 114)

x :number

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

Type:
  • number
Since: 3.0.0
Source: src/gameobjects/particles/GravityWell.js (Line 54)

y :number

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

Type:
  • number
Since: 3.0.0
Source: src/gameobjects/particles/GravityWell.js (Line 63)

Methods

update(particle, delta, step)

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.
Since: 3.0.0
Source: src/gameobjects/particles/GravityWell.js (Line 133)