Skip to content

Commit

Permalink
Clarify set body docs further
Browse files Browse the repository at this point in the history
  • Loading branch information
photonstorm committed Sep 14, 2023
1 parent 5238c0b commit a1bc5e2
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions src/physics/matter-js/components/SetBody.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ var Vertices = require('../lib/geometry/Vertices');
var SetBody = {

/**
* Set the body on a Game Object to a rectangle.
* Set this Game Objects Matter physics body to be a rectangle shape.
*
* Calling this methods resets previous properties you may have set on the body, including
* plugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.
* Calling this methods resets all previous properties you may have set on the body, including
* plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.
*
* @method Phaser.Physics.Matter.Components.SetBody#setRectangle
* @since 3.0.0
Expand All @@ -41,10 +41,10 @@ var SetBody = {
},

/**
* Set the body on a Game Object to a circle.
* Set this Game Objects Matter physics body to be a circle shape.
*
* Calling this methods resets previous properties you may have set on the body, including
* plugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.
* Calling this methods resets all previous properties you may have set on the body, including
* plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.
*
* @method Phaser.Physics.Matter.Components.SetBody#setCircle
* @since 3.0.0
Expand All @@ -60,10 +60,10 @@ var SetBody = {
},

/**
* Set the body on the Game Object to a polygon shape.
* Set this Game Objects Matter physics body to be a polygon shape.
*
* Calling this methods resets previous properties you may have set on the body, including
* plugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.
* Calling this methods resets all previous properties you may have set on the body, including
* plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.
*
* @method Phaser.Physics.Matter.Components.SetBody#setPolygon
* @since 3.0.0
Expand All @@ -80,10 +80,10 @@ var SetBody = {
},

/**
* Set the body on the Game Object to a trapezoid shape.
* Set this Game Objects Matter physics body to be a trapezoid shape.
*
* Calling this methods resets previous properties you may have set on the body, including
* plugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.
* Calling this methods resets all previous properties you may have set on the body, including
* plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.
*
* @method Phaser.Physics.Matter.Components.SetBody#setTrapezoid
* @since 3.0.0
Expand Down Expand Up @@ -175,8 +175,8 @@ var SetBody = {
/**
* Set this Game Object to create and use a new Body based on the configuration object given.
*
* Calling this method resets previous properties you may have set on the body, including
* plugins, mass, friction, etc. So be sure to re-apply these in the options object if needed.
* Calling this methods resets all previous properties you may have set on the body, including
* plugins, mass, friction, collision categories, etc. So be sure to re-apply these as needed.
*
* @method Phaser.Physics.Matter.Components.SetBody#setBody
* @since 3.0.0
Expand Down

0 comments on commit a1bc5e2

Please sign in to comment.