Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-16 14:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: clarify overlapOnly param

Browse source 
in Phaser.Physics.Arcade.Collider

Explain that the callback will trigger on any overlap with any part of a tileLayer
This commit is contained in:
biometricPsychography 2024-01-26 20:48:26 -06:00
parent 2e4b43be4e
commit 631dc01f91
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/physics/arcade/Collider.js
View file

@ -17,7 +17,9 @@ var Class = require('../../utils/Class');
* @since 3.0.0
*
* @param {Phaser.Physics.Arcade.World} world - The Arcade physics World that will manage the collisions.
* @param {boolean} overlapOnly - Whether to check for collisions or overlap.
* @param {boolean} overlapOnly - Whether to check for collisions or overlaps. Note, if checking for overlaps with a
* TilemapLayer, every tile in the layer, regardless of tile ID, will be checked for collision.
* Even if the layer has had only a subset of tile IDs enabled for collision, all tiles will still be checked for overlap.
* @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object1 - The first object to check for collision.
* @param {Phaser.Types.Physics.Arcade.ArcadeColliderType} object2 - The second object to check for collision.
* @param {Phaser.Types.Physics.Arcade.ArcadePhysicsCallback} collideCallback - The callback to invoke when the two objects collide.