Documentation

Tile implements PropertyBagHolder Uses PropertyBagTrait

Represents tiles in a tileSet.

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

Documentation

Interfaces, Classes and Traits

PropertyBagHolder
Interface for all elements, which contains properties.

Table of Contents

$animation  : Animation|null
$bottomLeftTerrainId  : int|null
Defines the terrain type of bottom left corner of the tile.
$bottomRightTerrainId  : int|null
Defines the terrain type of bottom right corner of the tile.
$id  : int|null
The local tile ID within its tile set.
$probability  : float
A percentage indicating the probability that this tile is chosen when it competes with others while editing with the terrain tool.
$propertyBag  : PropertyBag|null
$topLeftTerrainId  : int|null
Defines the terrain type of top left corner of the tile.
$topRightTerrainId  : int|null
Defines the terrain type of top right corner of the tile.
$type  : string|null
The type of the tile. Refers to an object type and is used by tile objects.
getAnimation()  : Animation|null
getBottomLeftTerrainId()  : int|null
getBottomRightTerrainId()  : int|null
getId()  : int|null
getProbability()  : float
getPropertyBag()  : PropertyBag|null
getTopLeftTerrainId()  : int|null
getTopRightTerrainId()  : int|null
getType()  : string|null
setAnimation()  : Tile
setBottomLeftTerrainId()  : Tile
setBottomRightTerrainId()  : Tile
setId()  : Tile
setProbability()  : Tile
setPropertyBag()  : self
setTopLeftTerrainId()  : Tile
setTopRightTerrainId()  : Tile
setType()  : Tile

Properties

Methods

getBottomLeftTerrainId()

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

getBottomRightTerrainId()

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

getId()

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

getProbability()

public getProbability() : float
Return values
float —

getTopLeftTerrainId()

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

getTopRightTerrainId()

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

getType()

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

setBottomLeftTerrainId()

public setBottomLeftTerrainId(int|null $bottomLeftTerrainId) : Tile
Parameters
$bottomLeftTerrainId : int|null
Return values
Tile —

setBottomRightTerrainId()

public setBottomRightTerrainId(int|null $bottomRightTerrainId) : Tile
Parameters
$bottomRightTerrainId : int|null
Return values
Tile —

setId()

public setId(int|null $id) : Tile
Parameters
$id : int|null
Return values
Tile —

setProbability()

public setProbability(float $probability) : Tile
Parameters
$probability : float
Return values
Tile —

setTopLeftTerrainId()

public setTopLeftTerrainId(int|null $topLeftTerrainId) : Tile
Parameters
$topLeftTerrainId : int|null
Return values
Tile —

setTopRightTerrainId()

public setTopRightTerrainId(int|null $topRightTerrainId) : Tile
Parameters
$topRightTerrainId : int|null
Return values
Tile —

setType()

public setType(string|null $type) : Tile
Parameters
$type : string|null
Return values
Tile —

Search results