Filter
The ObjectHelper helps tie objects with gids into the tileset
that sits behind them.
Constructor:
new ObjectHelper(tilesets)
Parameters:
| name | type | description |
|---|---|---|
| tilesets | Array.<Phaser.Tilemaps.Tileset> |
The backing tileset data. |
Members
Description:
Enabled if the object helper reaches in to tilesets for data. Disabled if it only uses data directly on a gid object.
Type:
Description:
The Tile GIDs array.
Type:
Methods
Description:
Gets the Tiled type field value from the object or the gid behind it.
Parameters:
| name | type | description |
|---|---|---|
| obj | Phaser.Types.Tilemaps.TiledObject |
The Tiled object to investigate. |
Returns:
Description:
The type of the object, the tile behind the gid of the object, or undefined.
Type:
- string
Description:
Sets the sprite.data field from the tiled properties on the object and its tile (if any).
Parameters:
| name | type |
|---|---|
| sprite | Phaser.GameObjects.GameObject |
| obj | Phaser.Types.Tilemaps.TiledObject |
Description:
Sets the sprite texture data as specified (usually in a config) or, failing that,
as specified in the gid of the object being loaded (if any).
This fallback will only work if the tileset was loaded as a spritesheet matching
the geometry of sprites fed into tiled, so that, for example: "tile id #3"" within
the tileset is the same as texture frame 3 from the image of the tileset.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| sprite | Phaser.GameObjects.GameObject |
The Game Object to modify. |
|
| key | string | Phaser.Textures.Texture | <optional> |
The texture key to set (or else the |
| frame | string | number | Phaser.Textures.Frame | <optional> |
The frames key to set (or else the |
| obj | Phaser.Types.Tilemaps.TiledObject | <optional> |
The Tiled object for fallback. |