Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-24 21:53:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added jsdocs

Browse source
This commit is contained in:
Richard Davey 2018-06-04 01:38:45 +01:00
parent 996ba89e4b
commit 15af7c6d0c
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/physics/arcade/World.js
View file

@ -1735,7 +1735,22 @@ var World = new Class({
},
/**
* Tests if Game Objects overlap and separates them (if possible).
* Performs a collision check and separation between the two physics enabled objects given, which can be single
* Game Objects, arrays of Game Objects, Physics Groups, arrays of Physics Groups or normal Groups.
*
* If you don't require separation then use {@link #overlap} instead.
*
* If two Groups or arrays are passed, each member of one will be tested against each member of the other.
*
* If one Group **only** is passed (as `object1`), each member of the Group will be collided against the other members.
*
* Two callbacks can be provided. The `collideCallback` is invoked if a collision occurs and the two colliding
* objects are passed to it.
*
* Arcade Physics uses the Projection Method of collision resolution and separation. While it's fast and suitable
* for 'arcade' style games it lacks stability when multiple objects are in close proximity or resting upon each other.
* The separation that stops two objects penetrating may create a new penetration against a different object. If you
* require a high level of stability please consider using an alternative physics system, such as Matter.js.
*
* @method Phaser.Physics.Arcade.World#collide
* @since 3.0.0