Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-22 20:53:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added JSDocs for fromPhysicsEditor method and tidied things up a bit.

Browse source
This commit is contained in:
Richard Davey 2020-01-10 08:56:49 +00:00
parent ea338cadaa
commit 0d66c98ff0
1 changed files with 41 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
src/physics/matter-js/Factory.js
View file

@ -198,11 +198,49 @@ var Factory = new Class({
return body;
},
fromPhysicsEditor: function (x, y, width, height, config)
/**
* Creates a body using data exported from the application PhysicsEditor (https://www.codeandweb.com/physicseditor)
*
* The PhysicsEditor file should be loaded as JSON:
*
* ```javascript
* preload ()
* {
* this.load.json('vehicles', 'assets/vehicles.json);
* }
*
* create ()
* {
* const vehicleShapes = this.cache.json.get('vehicles');
* this.matter.add.fromPhysicsEditor(400, 300, vehicleShapes.truck);
* }
* ```
*
* Do not pass the entire JSON file to this method, but instead pass one of the shapes contained within it.
*
* If you pas in an `options` object, any settings in there will override those in the PhysicsEditor config object.
*
* @method Phaser.Physics.Matter.Factory#fromPhysicsEditor
* @since 3.22.0
*
* @param {number} x - The horizontal world location of the body.
* @param {number} y - The vertical world location of the body.
* @param {any} config - The JSON data exported from PhysicsEditor.
* @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.
* @param {boolean} [addToWorld=true] - Should the newly created body be immediately added to the World?
*
* @return {MatterJS.Body} A Matter JS Body.
*/
fromPhysicsEditor: function (x, y, config, options, addToWorld)
{
var body = PhysicsEditorParser.parseBody(x, y, width, height, config);
if (addToWorld === undefined) { addToWorld = true; }
// this.world.add(body);
var body = PhysicsEditorParser.parseBody(x, y, config, options);
if (addToWorld && !this.world.has(body))
{
this.world.add(body);
}
return body;
},