Documentation

TileSet implements PropertyBagHolder Uses PropertyBagTrait

Represents the tileOffset object.

Tags
see
https://doc.mapeditor.org/en/stable/reference/tmx-map-format/#tileset

Documentation

Interfaces, Classes and Traits

PropertyBagHolder
Interface for all elements, which contains properties.

Table of Contents

$columns  : int|null
The number of tile columns in the tileset.
$firstGid  : int|null
The first global tile ID of this tileset (this global ID maps to the first tile in this tileset).
$image  : Image|null
$margin  : int|null
The margin around the tiles in this tileset.
$name  : string|null
The name of this tileset.
$objectAlignment  : string|null
Controls the alignment for tile objects.
$propertyBag  : PropertyBag|null
$source  : string|null
If this tileset is stored in an external TSX (Tile Set XML) file, this attribute refers to that file.
$spacing  : int|null
The spacing in pixels between the tiles in this tileset.
$terrainCollection  : TerrainCollection|null
$tileCount  : int|null
The number of tiles in this tileset.
$tileHeight  : int|null
The (maximum) height of the tiles in this tileset.
$tileOffset  : TileOffset|null
$tiles  : array<string|int, mixed>
$tileWidth  : int|null
The (maximum) width of the tiles in this tileset.
$wangCollection  : WangCollection|null
addTile()  : self
getColumns()  : int|null
getFirstGid()  : int|null
getImage()  : Image|null
getMargin()  : int|null
getName()  : string|null
getObjectAlignment()  : string|null
getPropertyBag()  : PropertyBag|null
getSource()  : string|null
getSpacing()  : int|null
getTerrainCollection()  : TerrainCollection|null
getTileCount()  : int|null
getTileHeight()  : int|null
getTileOffset()  : TileOffset|null
getTiles()  : array<string|int, Tile>
getTileWidth()  : int|null
getWangCollection()  : WangCollection|null
removeTile()  : self
setColumns()  : TileSet
setFirstGid()  : TileSet
setImage()  : TileSet
setMargin()  : TileSet
setName()  : TileSet
setObjectAlignment()  : TileSet
setPropertyBag()  : self
setSource()  : TileSet
setSpacing()  : TileSet
setTerrainCollection()  : TileSet
setTileCount()  : TileSet
setTileHeight()  : TileSet
setTileOffset()  : TileSet
setTileWidth()  : TileSet
setWangCollection()  : TileSet

Properties

Methods

addTile()

public addTile(Tile $tile) : self
Parameters
$tile : Tile
Return values
self —

getColumns()

public getColumns() : int|null
Return values
int|null —

getFirstGid()

public getFirstGid() : int|null
Return values
int|null —

getMargin()

public getMargin() : int|null
Return values
int|null —

getName()

public getName() : string|null
Return values
string|null —

getObjectAlignment()

public getObjectAlignment() : string|null
Return values
string|null —

getSource()

public getSource() : string|null
Return values
string|null —

getSpacing()

public getSpacing() : int|null
Return values
int|null —

getTileCount()

public getTileCount() : int|null
Return values
int|null —

getTileHeight()

public getTileHeight() : int|null
Return values
int|null —

getTiles()

public getTiles() : array<string|int, Tile>
Return values
array<string|int, Tile> —

getTileWidth()

public getTileWidth() : int|null
Return values
int|null —

removeTile()

public removeTile(Tile $tile) : self
Parameters
$tile : Tile
Return values
self —

setColumns()

public setColumns(int|null $columns) : TileSet
Parameters
$columns : int|null
Return values
TileSet —

setFirstGid()

public setFirstGid(int|null $firstGid) : TileSet
Parameters
$firstGid : int|null
Return values
TileSet —

setMargin()

public setMargin(int|null $margin) : TileSet
Parameters
$margin : int|null
Return values
TileSet —

setName()

public setName(string|null $name) : TileSet
Parameters
$name : string|null
Return values
TileSet —

setObjectAlignment()

public setObjectAlignment(string|null $objectAlignment) : TileSet
Parameters
$objectAlignment : string|null
Return values
TileSet —

setSource()

public setSource(string|null $source) : TileSet
Parameters
$source : string|null
Return values
TileSet —

setSpacing()

public setSpacing(int|null $spacing) : TileSet
Parameters
$spacing : int|null
Return values
TileSet —

setTileCount()

public setTileCount(int|null $tileCount) : TileSet
Parameters
$tileCount : int|null
Return values
TileSet —

setTileHeight()

public setTileHeight(int|null $tileHeight) : TileSet
Parameters
$tileHeight : int|null
Return values
TileSet —

setTileWidth()

public setTileWidth(int|null $tileWidth) : TileSet
Parameters
$tileWidth : int|null
Return values
TileSet —

Search results