Phaser Class: Tileset

new Tileset(name, firstgid, width, height, margin, spacing, properties)

A Tile set is a combination of an image containing the tiles and collision data per tile. You should not normally instantiate this class directly.

Parameters:

Name	Type	Description
`name`	string	The name of the tileset in the map data.
`firstgid`	number	The Tiled firstgid value.
`width`	number	Width of each tile in pixels.
`height`	number	Height of each tile in pixels.
`margin`	number	The amount of margin around the tilesheet.
`spacing`	number	The amount of spacing between each tile in the sheet.
`properties`	object	Tileset properties.

Source:

tilemap/Tileset.js, line 21

Members

columns

Properties:

Name	Type	Description
`columns`	number	The number of columns in the tile sheet.

Source:

tilemap/Tileset.js, line 77

firstgid

Properties:

Name	Type	Description
`firstgid`	number	The Tiled firstgid value.

Default Value:

firstgid

Source:

tilemap/Tileset.js, line 32

image

Properties:

Name	Type	Description
`image`	object	The image used for rendering. This is a reference to the image stored in Phaser.Cache.

Source:

tilemap/Tileset.js, line 67

name

Properties:

Name	Type	Description
`name`	string	The name of the Tileset.

Source:

tilemap/Tileset.js, line 26

properties

Properties:

Name	Type	Description
`properties`	object	Tileset specific properties (typically defined in the Tiled editor).

Source:

tilemap/Tileset.js, line 57

rows

Properties:

Name	Type	Description
`rows`	number	The number of rows in the tile sheet.

Source:

tilemap/Tileset.js, line 72

tileHeight

Properties:

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

Source:

tilemap/Tileset.js, line 42

tileMargin

Properties:

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

Source:

tilemap/Tileset.js, line 47

tileSpacing

Properties:

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

Source:

tilemap/Tileset.js, line 52

tileWidth

Properties:

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

Source:

tilemap/Tileset.js, line 37

total

Properties:

Name	Type	Description
`total`	number	The total number of tiles in the tilesheet.

Source:

tilemap/Tileset.js, line 82

Methods

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 141

Returns:

True if a tile exists at the given index otherwise false. checkTileIndex: function (index) {

    return (this.tiles[index]);

}

Type: boolean

getTile(index) → {object}

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 88

Returns:

The tile object. getTile: function (index) {

    return this.tiles[index];

},

Type: object

getTileX(index) → {object}

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 90

Returns:

The tile object. getTileX: function (index) {

    return this.tiles[index][0];

},

Type: object

getTileY(index) → {object}

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 92

Returns:

The tile object. getTileY: function (index) {

    return this.tiles[index][1];

},

Type: object

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 94