The Arcade physics World that will manage the collisions.
Whether to check for collisions or overlaps.
The first object to check for collision.
The second object to check for collision.
The callback to invoke when the two objects collide.
The callback to invoke when the two objects collide. Must return a boolean.
The scope in which to call the callbacks.
Whether the collider is active.
The context the collideCallback and processCallback will run in.
The callback to invoke when the two objects collide.
The name of the collider (unused by Phaser).
The first object to check for collision.
The second object to check for collision.
Whether to check for collisions or overlaps.
If a processCallback exists it must return true or collision checking will be skipped.
The world in which the bodies will collide.
Removes Collider from World and disposes of its resources.
A name for the Collider.
Phaser does not use this value, it's for your own reference.
The name to assign to the Collider.
Called by World as part of its step processing, initial operation of collision checking.
An Arcade Physics Collider will automatically check for collision, or overlaps, between two objects every step. If a collision, or overlap, occurs it will invoke the given callbacks.
Note, if setting
overlapOnlytotrue, and one of the objects is aTilemapLayer, 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.