phaser/resources/docgen/output/Phaser.Physics.P2.FixtureList.json

{"class":{"name":"Phaser.Physics.P2.FixtureList","extends":"","static":false,"constructor":true,"parameters":[{"name":"list","type":["array"],"help":"A list of fixtures (from Phaser.Physics.P2.Body#addPhaserPolygon)","optional":false,"default":null}],"help":"Allow to access a list of created fixture (coming from Body#addPhaserPolygon)\\nwhich itself parse the input from PhysicsEditor with the custom phaser exporter.\\nYou can access fixtures of a Body by a group index or even by providing a fixture Key.\\n\\nYou can set the fixture key and also the group index for a fixture in PhysicsEditor.\\nThis gives you the power to create a complex body built of many fixtures and modify them\\nduring runtime (to remove parts, set masks, categories & sensor properties)"},"consts":[],"methods":{"public":[{"name":"flatten","static":false,"returns":null,"help":"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.","line":218,"public":true,"protected":false,"private":false,"parameters":[{"name":"array","type":["array"],"help":"The array to flatten. Notice: This will happen recursive not shallow.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFixtureByKey","static":false,"returns":null,"help":"Accessor to get either a single fixture by its key.","line":164,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The key of the fixture.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFixtures","static":false,"returns":null,"help":"Accessor to get either a list of specified fixtures by key or the whole fixture list","line":129,"public":true,"protected":false,"private":false,"parameters":[{"name":"keys","type":["array"],"help":"A list of fixture keys","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getGroup","static":false,"returns":null,"help":"Accessor to get a group of fixtures by its group index.","line":176,"public":true,"protected":false,"private":false,"parameters":[{"name":"groupID","type":["number"],"help":"The group index.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"init","static":false,"returns":null,"help":"","line":41,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"parse","static":false,"returns":null,"help":"Parser for the output of Phaser.Physics.P2.Body#addPhaserPolygon","line":187,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setCategory","static":false,"returns":null,"help":"","line":68,"public":true,"protected":false,"private":false,"parameters":[{"name":"bit","type":["number"],"help":"The bit to set as the collision group.","optional":false,"default":null},{"name":"fixtureKey","type":["string"],"help":"Only apply to the fixture with the given key.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setMask","static":false,"returns":null,"help":"","line":83,"public":true,"protected":false,"private":false,"parameters":[{"name":"bit","type":["number"],"help":"The bit to set as the collision mask","optional":false,"default":null},{"name":"fixtureKey","type":["string"],"help":"Only apply to the fixture with the given key","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setMaterial","static":false,"returns":null,"help":"","line":113,"public":true,"protected":false,"private":false,"parameters":[{"name":"material","type":["object"],"help":"The contact material for a fixture","optional":false,"default":null},{"name":"fixtureKey","type":["string"],"help":"Only apply to the fixture with the given key","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setSensor","static":false,"returns":null,"help":"","line":98,"public":true,"protected":false,"private":false,"parameters":[{"name":"value","type":["boolean"],"help":"sensor true or false","optional":false,"default":null},{"name":"fixtureKey","type":["string"],"help":"Only apply to the fixture with the given key","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[{"name":"allFixtures","type":["array"],"help":"","inlineHelp":"This is a list of everything in this collection","line":59,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"groupedFixtures","type":["array"],"help":"","inlineHelp":"Collect all given fixtures per group index. Notice: Every fixture with a key also belongs to a group","line":53,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"namedFixtures","type":["object"],"help":"","inlineHelp":"Collect all fixtures with a key","line":47,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}