Class: Physics

Classes

Arcade

Ninja

P2

Members

<static, constant> ARCADE : number

Type:

• number

Source:

src/physics/Physics.js line 72

<static, constant> BOX2D : number

Type:

• number

Source:

src/physics/Physics.js line 90

<static, constant> CHIPMUNK : number

Type:

• number

Source:

src/physics/Physics.js line 96

<static, constant> MATTERJS : number

Type:

• number

Source:

src/physics/Physics.js line 102

<static, constant> NINJA : number

Type:

• number

Source:

src/physics/Physics.js line 84

<static, constant> P2JS : number

Type:

• number

Source:

src/physics/Physics.js line 78

arcade : Phaser.Physics.Arcade

The Arcade Physics system.

Type:

• Phaser.Physics.Arcade

Source:

src/physics/Physics.js line 38

box2d : Phaser.Physics.Box2D

The Box2D Physics system.

Type:

• Phaser.Physics.Box2D

Source:

src/physics/Physics.js line 53

chipmunk : Phaser.Physics.Chipmunk

The Chipmunk Physics system (to be done).

Type:

• Phaser.Physics.Chipmunk

Source:

src/physics/Physics.js line 58

config : object

The physics configuration object as passed to the game on creation.

Type:

• object

Source:

src/physics/Physics.js line 33

game : Phaser.Game

Local reference to game.

Type:

• Phaser.Game

Source:

src/physics/Physics.js line 28

matter : Phaser.Physics.Matter

The MatterJS Physics system (coming soon).

Type:

• Phaser.Physics.Matter

Source:

src/physics/Physics.js line 63

ninja : Phaser.Physics.Ninja

The N+ Ninja Physics system.

Type:

• Phaser.Physics.Ninja

Source:

src/physics/Physics.js line 48

p2 : Phaser.Physics.P2

The P2.JS Physics system.

Type:

• Phaser.Physics.P2

Source:

src/physics/Physics.js line 43

Methods

<protected> clear()

Clears down all active physics systems. This doesn't destroy them, it just clears them of objects and is called when the State changes.

Source:

src/physics/Physics.js line 342

destroy()

Destroys all active physics systems. Usually only called on a Game Shutdown, not on a State swap.

Source:

src/physics/Physics.js line 390

enable(object [, system] [, debug])

This will create a default physics body on the given game object or array of objects. A game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed. It can be for any of the physics systems that have been started:

Phaser.Physics.Arcade - A light weight AABB based collision system with basic separation. Phaser.Physics.P2JS - A full-body advanced physics system supporting multiple object shapes, polygon loading, contact materials, springs and constraints. Phaser.Physics.NINJA - A port of Metanet Softwares N+ physics system. Advanced AABB and Circle vs. Tile collision. Phaser.Physics.BOX2D - A port of https://code.google.com/p/box2d-html5 Phaser.Physics.MATTER - A full-body and light-weight advanced physics system (still in development) Phaser.Physics.CHIPMUNK is still in development.

If you require more control over what type of body is created, for example to create a Ninja Physics Circle instead of the default AABB, then see the individual physics systems enable methods instead of using this generic one.

Parameters:

Name	Type	Argument	Default	Description
object	object | array			The game object to create the physics body on. Can also be an array of objects, a body will be created on every object in the array.
system	number	<optional>	Phaser.Physics.ARCADE	The physics system that will be used to create the body. Defaults to Arcade Physics.
debug	boolean	<optional>	false	Enable the debug drawing for this body. Defaults to false.

Source:

src/physics/Physics.js line 205

parseConfig()

Parses the Physics Configuration object passed to the Game constructor and starts any physics systems specified within.

Source:

src/physics/Physics.js line 106

<protected> preUpdate()

preUpdate checks.

Source:

src/physics/Physics.js line 256

<protected> reset()

Resets the active physics system. Called automatically on a Phaser.State swap.

Source:

src/physics/Physics.js line 366

<protected> setBoundsToWorld()

Updates the physics bounds to match the world dimensions.

Source:

src/physics/Physics.js line 308

setBoundsToWorld( [left] [, right] [, top] [, bottom] [, setCollisionGroup])

Sets the bounds of the Physics world to match the Game.World dimensions. You can optionally set which 'walls' to create: left, right, top or bottom.

Parameters:

Name	Type	Argument	Default	Description
left	boolean	<optional>	true	If true will create the left bounds wall.
right	boolean	<optional>	true	If true will create the right bounds wall.
top	boolean	<optional>	true	If true will create the top bounds wall.
bottom	boolean	<optional>	true	If true will create the bottom bounds wall.
setCollisionGroup	boolean	<optional>	true	If true the Bounds will be set to use its own Collision Group.

Source:

src/physics/p2/World.js line 562

setWorldMaterial(material [, left] [, right] [, top] [, bottom])

Sets the given material against the 4 bounds of this World.

Parameters:

Name	Type	Argument	Default	Description
material	Phaser.Physics.P2.Material			The material to set.
left	boolean	<optional>	true	If true will set the material on the left bounds wall.
right	boolean	<optional>	true	If true will set the material on the right bounds wall.
top	boolean	<optional>	true	If true will set the material on the top bounds wall.
bottom	boolean	<optional>	true	If true will set the material on the bottom bounds wall.

Source:

src/physics/p2/World.js line 580

startSystem(system)

This will create an instance of the requested physics simulation. Phaser.Physics.Arcade is running by default, but all others need activating directly.

You can start the following physics systems:

Phaser.Physics.P2JS - A full-body advanced physics system by Stefan Hedman. Phaser.Physics.NINJA - A port of Metanet Softwares N+ physics system. Phaser.Physics.BOX2D - A commercial Phaser Plugin (see http://phaser.io)

Both Ninja Physics and Box2D require their respective plugins to be loaded before you can start them. They are not bundled into the core Phaser library.

If the physics world has already been created (i.e. in another state in your game) then calling startSystem will reset the physics world, not re-create it. If you need to start them again from their constructors then set Phaser.Physics.p2 (or whichever system you want to recreate) to null before calling startSystem.

Parameters:

Name	Type	Description
system	number	The physics system to start: Phaser.Physics.ARCADE, Phaser.Physics.P2JS, Phaser.Physics.NINJA or Phaser.Physics.BOX2D.

Source:

src/physics/Physics.js line 140

<protected> update()

Updates all running physics systems.

Source:

src/physics/Physics.js line 282