Skip to content

Commit 2b66f81

Browse files
committed
Final config structure and values
1 parent 8527e10 commit 2b66f81

1 file changed

Lines changed: 30 additions & 11 deletions

File tree

src/physics/matter-js/typedefs/MatterDebugConfig.js

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,29 @@
22
* @typedef {object} Phaser.Types.Physics.Matter.MatterDebugConfig
33
* @since 3.22.0
44
*
5-
* @property {boolean} [showBody=true] - Render the dynamic bodies in the world to the Graphics object?
6-
* @property {boolean} [showStaticBody=true] - Render the static bodies in the world to the Graphics object?
7-
* @property {boolean} [showSleeping=false] - Render any sleeping bodies (dynamic or static) in the world to the Graphics object?
8-
* @property {boolean} [showJoint=true] - Render all world constraints to the Graphics object?
9-
* @property {boolean} [showInternalEdges=false] - When rendering bodies, render the internal edges as well?
10-
* @property {boolean} [showConvexHulls=false] - When rendering polygon bodies, render the convex hull as well?
11-
* @property {boolean} [showPositions=true] - Render the position of non-static bodies?
5+
* @property {boolean} [showAxes=false] - Render all of the body axes?
6+
* @property {boolean} [showAngleIndicator=false] - Render just a single body axis?
7+
* @property {boolean} [angleColor=0xe81153] - The color of the body angle / axes lines.
8+
*
129
* @property {boolean} [showBroadphase=false] - Render the broadphase grid?
1310
* @property {boolean} [broadphaseColor=0xffb400] - The color of the broadphase grid.
11+
*
1412
* @property {boolean} [showBounds=false] - Render the bounds of the bodies in the world?
15-
* @property {boolean} [boundsColor=0xffb400] - The color of the body bounds.
16-
* @property {boolean} [showAxes=false] - Render all of the body axes?
17-
* @property {boolean} [showAngleIndicator=false] - Render just the single body angle?
18-
* @property {boolean} [angleColor=0xe81153] - The color of the body angle / axes lines.
13+
* @property {boolean} [boundsColor=0xffffff] - The color of the body bounds.
14+
*
1915
* @property {boolean} [showVelocity=false] - Render the velocity of the bodies in the world?
2016
* @property {boolean} [velocityColor=0x00aeef] - The color of the body velocity line.
17+
*
18+
* @property {boolean} [showCollisions=false] - Render the collision points and normals for colliding pairs.
19+
* @property {boolean} [collisionColor=0xf5950c] - The color of the collision points.
20+
*
21+
* @property {boolean} [showSeparation=false] - Render lines showing the separation between bodies.
22+
* @property {boolean} [separationColor=0xffa500] - The color of the body separation line.
23+
*
24+
* @property {boolean} [showBody=true] - Render the dynamic bodies in the world to the Graphics object?
25+
* @property {boolean} [showStaticBody=true] - Render the static bodies in the world to the Graphics object?
26+
* @property {boolean} [showInternalEdges=false] - When rendering bodies, render the internal edges as well?
27+
*
2128
* @property {boolean} [renderFill=false] - Render the bodies using a fill color.
2229
* @property {boolean} [renderLine=true] - Render the bodies using a line stroke.
2330
* @property {number} [fillColor=0x106909] - The color value of the fill when rendering dynamic bodies.
@@ -27,11 +34,21 @@
2734
* @property {number} [lineThickness=1] - If rendering lines, the thickness of the line.
2835
* @property {number} [staticFillColor=0x0d177b] - The color value of the fill when rendering static bodies.
2936
* @property {number} [staticLineColor=0x1327e4] - The color value of the line stroke when rendering static bodies.
37+
*
38+
* @property {boolean} [showSleeping=false] - Render any sleeping bodies (dynamic or static) in the world to the Graphics object?
3039
* @property {number} [staticBodySleepOpacity=0.7] - The amount to multiply the opacity of sleeping static bodies by.
3140
* @property {number} [sleepFillColor=0x464646] - The color value of the fill when rendering sleeping dynamic bodies.
3241
* @property {number} [sleepLineColor=0x999a99] - The color value of the line stroke when rendering sleeping dynamic bodies.
42+
*
43+
* @property {boolean} [showSensors=true] - Render bodies or body parts that are flagged as being a sensor?
44+
* @property {number} [sensorFillColor=0x0d177b] - The fill color when rendering body sensors.
45+
* @property {number} [sensorLineColor=0x1327e4] - The line color when rendering body sensors.
46+
*
47+
* @property {boolean} [showPositions=true] - Render the position of non-static bodies?
3348
* @property {number} [positionSize=4] - The size of the rectangle drawn when rendering the body position.
3449
* @property {number} [positionColor=0xe042da] - The color value of the rectangle drawn when rendering the body position.
50+
*
51+
* @property {boolean} [showJoint=true] - Render all world constraints to the Graphics object?
3552
* @property {number} [jointColor=0xe0e042] - The color value of joints when `showJoint` is set.
3653
* @property {number} [jointLineOpacity=1] - The line opacity when rendering joints, a value between 0 and 1.
3754
* @property {number} [jointLineThickness=2] - The line thickness when rendering joints.
@@ -40,5 +57,7 @@
4057
* @property {number} [springColor=0xe042e0] - The color value of spring constraints.
4158
* @property {number} [anchorColor=0xefefef] - The color value of constraint anchors.
4259
* @property {number} [anchorSize=6] - The size of the circles drawn as the constraint anchors.
60+
*
61+
* @property {boolean} [showConvexHulls=false] - When rendering polygon bodies, render the convex hull as well?
4362
* @property {number} [hullColor=0xd703d0] - The color value of hulls when `showConvexHulls` is set.
4463
*/

0 commit comments

Comments
 (0)