CreatePolygonFromVertices needs to return body

[Vykri]

The CreatePolygonFromVertices function creates the body object, but does not return it.

phaser-box2d/src/physics.js

Line 1068 in f5f0681

});

. There should be a return body; line at the end of that function.

The downstream issue that this is causing is that calling CreatePhysicsEditorShape({worldId, key, url}).then(body => ...) results in body being undefined.

[Vykri]

FYI, by just adding return body; CreatePhysicsEditorShape will return an object with {bodyId, shapeId, object} where shapeId is the last shape created in the loop and object is shape's vertices, normals, etc. This doesn't really make much sense since the body is comprised of multiple shapes, so just returning the last one doesn't seem super useful. It should probably just return {bodyId} or {bodyId, shapeIds, objects}.

[mreinstein]

Maybe the CreatePhysicsEditorShape function should just return the bodyId ? I think all the shapes and polygons attached to said body can be queried from that. I'm just unsure how this function is relied upon in userland.

[mreinstein]

if that makes sense to do, it might be good to rename it, something like CreatePhysicsEditorBody which would likely reference one or more shapes?

[Vykri]

Honestly, CreatePhysicsEditorShape should probably be split into 2 parts. The comment says "It is recommended to prepare data with this before the game loop starts; It is async and quite slow.", but since it reads the file and also creates the body, it doesn't make sense to call before the game loop as the created body will be useless. I recommend Creating LoadPhysicsEditorShapeData and CreatePhysicsEditorBodyFromData functions where you call LoadPhysicsEditorShapeData during preload and CreatePhysicsEditorBodyFromData to actually create the bodies from that data.

[Vykri]

Regardless of what is done to CreatePhysicsEditorShape, CreatePolygonFromVertices should still be fixed to return body at the end of the function.

[Vykri]

Another issue I found with CreatePolygonFromVertices is that the call to CreatePolygon (Which is only called for the first shape when body doesn't exist yet) doesn't pass all of the necessary data along. Specifically, shapeDef should be included as this caused a bug where I called CreatePolygonFromVertices with shapeDef.isSensor = true, but the first shape of the body didn't include this and therefore had collision. The rest of the shapes that were created with the b2CreatePolygonShape calls were correctly marked as sensors, which meant that one small part of my sprite was not a sensor and had collision.

I was able to fix this by adding shapeDef to the param object being sent to CreatePolygon.