Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-10 15:14:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added jsdocs

Browse source
This commit is contained in:
Richard Davey 2020-01-05 23:47:25 +00:00
parent ffb604c502
commit c5675ae171
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/physics/matter-js/components/Sensor.js
View file

@ -5,7 +5,7 @@
*/
/**
* [description]
* Enables a Matter-enabled Game Object to be a sensor. Should be used as a mixin and not directly.
*
* @namespace Phaser.Physics.Matter.Components.Sensor
* @since 3.0.0
@ -13,12 +13,13 @@
var Sensor = {
/**
* [description]
* Set the body belonging to this Game Object to be a sensor.
* Sensors trigger collision events, but don't react with colliding body physically.
*
* @method Phaser.Physics.Matter.Components.Sensor#setSensor
* @since 3.0.0
*
* @param {boolean} value - [description]
* @param {boolean} value - `true` to set the body as a sensor, or `false` to disable it.
*
* @return {Phaser.GameObjects.GameObject} This Game Object.
*/
@ -30,12 +31,12 @@ var Sensor = {
},
/**
* [description]
* Is the body belonging to this Game Object a sensor or not?
*
* @method Phaser.Physics.Matter.Components.Sensor#isSensor
* @since 3.0.0
*
* @return {boolean} [description]
* @return {boolean} `true` if the body is a sensor, otherwise `false`.
*/
isSensor: function ()
{