Phaser Class: Tileset

new Tileset(image, key, tileWidth, tileHeight, tileMargin, tileSpacing)

A Tile set is a combination of an image containing the tiles and collision data per tile.

Parameters:

Name	Type	Argument	Description
`image`	Image		The Image object from the Cache.
`key`	string		The key of the tileset in the cache.
`tileWidth`	number		The width of the tile in pixels.
`tileHeight`	number		The height of the tile in pixels.
`tileMargin`	number	<optional>	The margin around the tiles in the sheet.
`tileSpacing`	number	<optional>	The spacing between the tiles in the sheet.

Source:

tilemap/Tileset.js, line 19

Members

image

Properties:

Name	Type	Description
`image`	object	The image used for rendering.

Source:

tilemap/Tileset.js, line 32

key

Properties:

Name	Type	Description
`key`	string	The cache ID.

Source:

tilemap/Tileset.js, line 27

margin

Properties:

Name	Type	Description
`tileMargin`	number	The margin around the tiles in the sheet.

Source:

tilemap/Tileset.js, line 47

spacing

Properties:

Name	Type	Description
`tileSpacing`	number	The margin around the tiles in the sheet.

Source:

tilemap/Tileset.js, line 52

tileHeight

Properties:

Name	Type	Description
`tileHeight`	number	The height of a tile in pixels.

Source:

tilemap/Tileset.js, line 42

tiles

Properties:

Name	Type	Description
`tiles`	array	An array of the tile collision data.

Source:

tilemap/Tileset.js, line 57

tileWidth

Properties:

Name	Type	Description
`tileWidth`	number	The width of a tile in pixels.

Source:

tilemap/Tileset.js, line 37

<readonly> total

Properties:

Name	Type	Description
`total`	number	The total number of tiles in this Tileset.

Source:

tilemap/Tileset.js, line 184

Methods

addTile(tile)

Adds a Tile into this set.

Parameters:

Name	Type	Description
`tile`	Phaser.Tile	The tile to add to this set.

Source:

tilemap/Tileset.js, line 63

canCollide(index) → {boolean}

Checks if the tile at the given index can collide.

Parameters:

Name	Type	Description
`index`	number	The index of the tile within the set.

Source:

tilemap/Tileset.js, line 109

Returns:

True or false depending on the tile collision or null if no tile was found at the given index.

Type: boolean

checkTileIndex(index) → {boolean}

Checks if the tile at the given index exists.

Parameters:

Name	Type	Description
`index`	number	The index of the tile within the set.

Source:

tilemap/Tileset.js, line 127

Returns:

True if a tile exists at the given index otherwise false.

Type: boolean

getTile(index) → {Phaser.Tile}

Gets a Tile from this set.

Parameters:

Name	Type	Description
`index`	number	The index of the tile within the set.

Source:

tilemap/Tileset.js, line 77

Returns:

The tile.

Type: Phaser.Tile

setCollision(index, left, right, up, down)

Sets collision values on a tile in the set.

Parameters:

Name	Type	Description
`index`	number	The index of the tile within the set.
`left`	boolean	Should the tile collide on the left?
`right`	boolean	Should the tile collide on the right?
`up`	boolean	Should the tile collide on the top?
`down`	boolean	Should the tile collide on the bottom?

Source:

tilemap/Tileset.js, line 163

setCollisionRange(start, stop, left, right, up, down)

Sets collision values on a range of tiles in the set.

Parameters:

Name	Type	Description
`start`	number	The index to start setting the collision data on.
`stop`	number	The index to stop setting the collision data on.
`left`	boolean	Should the tile collide on the left?
`right`	boolean	Should the tile collide on the right?
`up`	boolean	Should the tile collide on the top?
`down`	boolean	Should the tile collide on the bottom?

Source:

tilemap/Tileset.js, line 140

setSpacing(tileMargin, tileSpacing)

Sets tile spacing and margins.

Parameters:

Name	Type	Argument	Description
`tileMargin`	number	<optional>	The margin around the tiles in the sheet.
`tileSpacing`	number	<optional>	The spacing between the tiles in the sheet.

Source:

tilemap/Tileset.js, line 95