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

Updated JSDocs

Browse source
This commit is contained in:
Richard Davey 2020-01-08 11:14:40 +00:00
parent 6a8bce9250
commit 2ac0562fb6
4 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/physics/matter-js/MatterGameObject.js
View file

@ -35,7 +35,7 @@ function hasGetterOrSetter (def)
*
* @param {Phaser.Physics.Matter.World} world - The Matter world to add the body to.
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will have the Matter body applied to it.
* @param {(object|MatterJS.Body)} [options] - A Matter Body configuration object, or an instance of a Matter Body.
* @param {(Phaser.Types.Physics.Matter.MatterBodyConfig|MatterJS.Body)} [options] - A Matter Body configuration object, or an instance of a Matter Body.
* @param {boolean} [addToWorld=true] - Should the newly created body be immediately added to the World?
*
* @return {Phaser.GameObjects.GameObject} The Game Object that was created with the Matter body.

2
src/physics/matter-js/MatterImage.js
View file

@ -58,7 +58,7 @@ var Vector2 = require('../../math/Vector2');
* @param {number} y - The vertical position of this Game Object in the world.
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
* @param {object} [options={}] - Matter.js configuration object.
* @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.
*/
var MatterImage = new Class({

8
src/physics/matter-js/MatterPhysics.js
View file

@ -1090,7 +1090,7 @@ var MatterPhysics = new Class({
* Sets just the horizontal linear velocity of the physics bodies.
* The vertical velocity of the body is unchanged.
*
* @method Phaser.Physics.Matter.MatterPhysics#setVelocity
* @method Phaser.Physics.Matter.MatterPhysics#setVelocityX
* @since 3.22.0
*
* @param {(MatterJS.Body|MatterJS.Body[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.
@ -1119,7 +1119,7 @@ var MatterPhysics = new Class({
* Sets just the vertical linear velocity of the physics bodies.
* The horizontal velocity of the body is unchanged.
*
* @method Phaser.Physics.Matter.MatterPhysics#setVelocity
* @method Phaser.Physics.Matter.MatterPhysics#setVelocityY
* @since 3.22.0
*
* @param {(MatterJS.Body|MatterJS.Body[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.
@ -1175,7 +1175,7 @@ var MatterPhysics = new Class({
* @since 3.22.0
*
* @param {(MatterJS.Body|MatterJS.Body[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.
* @param {Phaser.Math.Vector2Like} force - A Vector that specifies the force to apply.
* @param {Phaser.Types.Math.Vector2Like} force - A Vector that specifies the force to apply.
*
* @return {this} This Matter Physics instance.
*/
@ -1206,7 +1206,7 @@ var MatterPhysics = new Class({
* @since 3.22.0
*
* @param {(MatterJS.Body|MatterJS.Body[])} bodies - Either a single Body, or an array of bodies to update. If falsey it will use all bodies in the world.
* @param {Phaser.Math.Vector2Like} position - A Vector that specifies the world-space position to apply the force at.
* @param {Phaser.Types.Math.Vector2Like} position - A Vector that specifies the world-space position to apply the force at.
* @param {number} speed - A speed value to be applied to a directional force.
* @param {number} [angle] - The angle, in radians, to apply the force from. Leave undefined to use the current body angle.
*

2
src/physics/matter-js/MatterSprite.js
View file

@ -62,7 +62,7 @@ var Vector2 = require('../../math/Vector2');
* @param {number} y - The vertical position of this Game Object in the world.
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
* @param {object} [options={}] - Matter.js configuration object.
* @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation.
*/
var MatterSprite = new Class({