Phaser API Documentation

  Version: 
<static> SetCollisionBetween(start, stop, collides, recalculateFaces, layer, [updateLayer])

Description:

Sets collision on a range of tiles in a layer whose index is between the specified start and stop (inclusive). Calling this with a start value of 10 and a stop value of 14 would set collision for tiles 10, 11, 12, 13 and 14. The collides parameter controls if collision will be enabled (true) or disabled (false).

Parameters:

name type arguments Default description
start number

The first index of the tile to be set for collision.

stop number

The last index of the tile to be set for collision.

collides boolean

If true it will enable collision. If false it will clear collision.

recalculateFaces boolean

Whether or not to recalculate the tile faces after the update.

layer Phaser.Tilemaps.LayerData

The Tilemap Layer to act upon.

updateLayer boolean <optional> true

If true, updates the current tiles on the layer. Set to false if no tiles have been placed for significant performance boost.