Class: FixtureList

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:
src/physics/p2/FixtureList.js line 23

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:
src/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:
src/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:
src/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:
src/physics/p2/FixtureList.js line 170

init()

Source:
src/physics/p2/FixtureList.js line 38

parse()

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

Source:
src/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:
src/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:
src/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:
src/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:
src/physics/p2/FixtureList.js line 93

phaser-ce@2.9.2 is on GitHub and NPM

Documentation generated by JSDoc 3.5.4 on 2017-11-09 using Tomorrow.