Phaser API Documentation

  Version: 
setCollisionByProperty(properties, [collides], [recalculateFaces])

Description:

Sets collision on the tiles within a layer by checking tile properties. If a tile has a property that matches the given properties object, its collision flag will be set. The collides parameter controls if collision will be enabled (true) or disabled (false). Passing in { collides: true } would update the collision flag on any tiles with a "collides" property that has a value of true. Any tile that doesn't have "collides" set to true will be ignored. You can also use an array of values, e.g. { types: ["stone", "lava", "sand" ] }. If a tile has a "types" property that matches any of those values, its collision flag will be updated.

Parameters:

name type arguments Default description
properties object

An object with tile properties and corresponding values that should be checked.

collides boolean <optional> true

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

recalculateFaces boolean <optional> true

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

Returns:
Description:

This Tilemap Layer object.

Since: 3.50.0