Navigation
These archived docs are for Phaser 2.4.8 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

Phaser.Physics.P2. FixtureList

new FixtureList(list)

Allow to access a list of created fixture (coming from Body#addPhaserPolygon) which itself parse the input from PhysicsEditor with the custom phaser exporter. You can access fixtures of a Body by a group index or even by providing a fixture Key. You can set the fixture key and also the group index for a fixture in PhysicsEditor. This gives you the power to create a complex body built of many fixtures and modify them during runtime (to remove parts, set masks, categories & sensor properties)

Parameters
Name Type Description
list Array

A list of fixtures (from Phaser.Physics.P2.Body#addPhaserPolygon)

Source code: physics/p2/FixtureList.js (Line 23)

Public Methods

flatten(array)

A helper to flatten arrays. This is very useful as the fixtures are nested from time to time due to the way P2 creates and splits polygons.

Parameters
Name Type Description
array array

The array to flatten. Notice: This will happen recursive not shallow.

Source code: physics/p2/FixtureList.js (Line 212)

getFixtureByKey(key)

Accessor to get either a single fixture by its key.

Parameters
Name Type Description
key string

The key of the fixture.

Source code: physics/p2/FixtureList.js (Line 158)

getFixtures(keys)

Accessor to get either a list of specified fixtures by key or the whole fixture list

Parameters
Name Type Description
keys array

A list of fixture keys

Source code: physics/p2/FixtureList.js (Line 123)

getGroup(groupID)

Accessor to get a group of fixtures by its group index.

Parameters
Name Type Description
groupID number

The group index.

Source code: physics/p2/FixtureList.js (Line 170)

init()

Source code: physics/p2/FixtureList.js (Line 38)

parse()

Parser for the output of Phaser.Physics.P2.Body#addPhaserPolygon

Source code: physics/p2/FixtureList.js (Line 182)

setCategory(bit, fixtureKey)

Parameters
Name Type Description
bit number

The bit to set as the collision group.

fixtureKey string

Only apply to the fixture with the given key.

Source code: physics/p2/FixtureList.js (Line 63)

setMask(bit, fixtureKey)

Parameters
Name Type Description
bit number

The bit to set as the collision mask

fixtureKey string

Only apply to the fixture with the given key

Source code: physics/p2/FixtureList.js (Line 78)

setMaterial(material, fixtureKey)

Parameters
Name Type Description
material Object

The contact material for a fixture

fixtureKey string

Only apply to the fixture with the given key

Source code: physics/p2/FixtureList.js (Line 108)

setSensor(value, fixtureKey)

Parameters
Name Type Description
value boolean

sensor true or false

fixtureKey string

Only apply to the fixture with the given key

Source code: physics/p2/FixtureList.js (Line 93)