Tileset (mini2Dx)

java.lang.Object
- org.mini2Dx.tiled.Tileset

public class Tileset
extends java.lang.Object

A tileset loaded with a TiledMap

Constructor Summary

Constructors
Constructor and Description

Tileset(int width, int height, int tileWidth, int tileHeight, int spacing, int margin, int firstGid)

Constructors
Constructor and Description
`Tileset(int width, int height, int tileWidth, int tileHeight, int spacing, int margin, int firstGid)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(int tileId)` Returns true if this tileset contains the tile with the given id
`boolean`	`containsProperty(java.lang.String propertyName)` Returns if the tileset contains the specified property
`void`	`drawTile(Graphics g, int tileId, int renderX, int renderY)` Draws a tile to the `Graphics` context
`void`	`drawTileset(Graphics g, int renderX, int renderY)` Draws the whole tileset to the `Graphics` context
`int`	`getFirstGid()` Returns the first GID.
`int`	`getHeight()` Returns the height of this tileset in pixels
`int`	`getHeightInTiles()` Returns the height of this tileset in tiles
`int`	`getMargin()` Returns the margin at the borders of the tileset
`java.lang.String`	`getName()` Returns the name of this tileset
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Returns the properties `Map` of this `Tileset`
`java.lang.String`	`getProperty(java.lang.String propertyName)` Returns the value of a specified property
`int`	`getSpacing()` Returns the internal spacing between each tile
`Tile`	`getTile(int tileId)` Returns the `Tile` for a given tile id
`Tile`	`getTile(int x, int y)` Returns the `Tile` for a given tile coordinate on the tileset
`int`	`getTileHeight()` Returns the height of each tile in pixels
`int`	`getTileId(int x, int y)` Returns the tile ID for a given tile within this tileset
`java.lang.String`	`getTilesetImagePath()` Returns the relative path of the tileset image
`int`	`getTileWidth()` Returns the width of each tile in pixels
`int`	`getTileX(int tileId)` Returns the x coordinate of a tile within this tileset
`int`	`getTileY(int tileId)` Returns the y coordinate of a tile within this tileset
`java.lang.String`	`getTransparentColorValue()`
`int`	`getWidth()` Returns the width of this tileset in pixels
`int`	`getWidthInTiles()` Returns the width of this tileset in tiles
`boolean`	`isTextureLoaded()` Returns if the tileset image has been loaded
`void`	`loadTexture(com.badlogic.gdx.files.FileHandle tmxDirectory)` Loads the tileset image
`void`	`setName(java.lang.String name)` Sets the name of this tileset
`void`	`setProperty(java.lang.String propertyName, java.lang.String value)` Sets the value of a specified property
`void`	`setTilesetImagePath(java.lang.String tilesetImagePath)` Sets the relative path of the tileset image
`void`	`setTransparentColorValue(java.lang.String transparentColorValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Tileset
```
public Tileset(int width,
               int height,
               int tileWidth,
               int tileHeight,
               int spacing,
               int margin,
               int firstGid)
```
- Method Detail
  - containsProperty
```
public boolean containsProperty(java.lang.String propertyName)
```
    Returns if the tileset contains the specified property
    
    Parameters:
    
    propertyName - The property name to search for
    
    Returns:
    
    True if the tileset contains the property
  - getProperty
```
public java.lang.String getProperty(java.lang.String propertyName)
```
    Returns the value of a specified property
    
    Parameters:
    
    propertyName - The property name to search for
    
    Returns:
    
    Null if there is no such property
  - setProperty
```
public void setProperty(java.lang.String propertyName,
                        java.lang.String value)
```
    Sets the value of a specified property
    
    Parameters:
    
    propertyName - The property name to set the value for
    
    value - The value of the property to set
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Returns the properties Map of this Tileset
    
    Returns:
    
    Null if there are no properties
  - drawTile
```
public void drawTile(Graphics g,
                     int tileId,
                     int renderX,
                     int renderY)
```
    Draws a tile to the Graphics context
    
    Parameters:
    
    g - The Graphics context available for rendering
    
    tileId - The tile id to render
    
    renderX - The X coordinate to render at
    
    renderY - The Y coordinate to render at
  - drawTileset
```
public void drawTileset(Graphics g,
                        int renderX,
                        int renderY)
```
    Draws the whole tileset to the Graphics context
    
    Parameters:
    
    g - The Graphics context available for rendering
    
    renderX - The X coordinate to render at
    
    renderY - The Y coordinate to render at
  - getTile
```
public Tile getTile(int tileId)
```
    Returns the Tile for a given tile id
    
    Parameters:
    
    tileId - The tile id to look up
    
    Returns:
    
    The Tile
  - getTile
```
public Tile getTile(int x,
                    int y)
```
    Returns the Tile for a given tile coordinate on the tileset
    
    Parameters:
    
    x - The x coordinate in tiles
    
    y - The y coordinate in tiles
    
    Returns:
    
    The Tile
  - isTextureLoaded
```
public boolean isTextureLoaded()
```
    Returns if the tileset image has been loaded
    
    Returns:
    
    True if loaded
  - loadTexture
```
public void loadTexture(com.badlogic.gdx.files.FileHandle tmxDirectory)
```
    Loads the tileset image
    
    Parameters:
    
    tmxDirectory - The directory containing the TMX files for the TiledMap that has loaded this tileset
  - contains
```
public boolean contains(int tileId)
```
    Returns true if this tileset contains the tile with the given id
    
    Parameters:
    
    tileId - The tile id to search for
    
    Returns:
    
    False if the tileset does not contain the tile
  - getTileId
```
public int getTileId(int x,
                     int y)
```
    Returns the tile ID for a given tile within this tileset
    
    Parameters:
    
    x - The x coordinate of the tile on the tileset
    
    y - The y coordinate of the tile on the tileset
    
    Returns:
    
    The tile ID
  - getTileX
```
public int getTileX(int tileId)
```
    Returns the x coordinate of a tile within this tileset
    
    Parameters:
    
    tileId - The tile id to get the x coordinate for
    
    Returns:
  - getTileY
```
public int getTileY(int tileId)
```
    Returns the y coordinate of a tile within this tileset
    
    Parameters:
    
    tileId - The tile id to get the y coordinate for
    
    Returns:
  - getWidthInTiles
```
public int getWidthInTiles()
```
    Returns the width of this tileset in tiles
    
    Returns:
  - getHeightInTiles
```
public int getHeightInTiles()
```
    Returns the height of this tileset in tiles
    
    Returns:
  - getName
```
public java.lang.String getName()
```
    Returns the name of this tileset
    
    Returns:
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of this tileset
    
    Parameters:
    
    name - The name to set
  - getWidth
```
public int getWidth()
```
    Returns the width of this tileset in pixels
    
    Returns:
  - getHeight
```
public int getHeight()
```
    Returns the height of this tileset in pixels
    
    Returns:
  - getTileWidth
```
public int getTileWidth()
```
    Returns the width of each tile in pixels
    
    Returns:
  - getTileHeight
```
public int getTileHeight()
```
    Returns the height of each tile in pixels
    
    Returns:
  - getSpacing
```
public int getSpacing()
```
    Returns the internal spacing between each tile
    
    Returns:
    
    The spacing in pixels
  - getMargin
```
public int getMargin()
```
    Returns the margin at the borders of the tileset
    
    Returns:
    
    The margin in pixels
  - getFirstGid
```
public int getFirstGid()
```
    Returns the first GID. See: TMX Map Format
    
    Returns:
  - getTilesetImagePath
```
public java.lang.String getTilesetImagePath()
```
    Returns the relative path of the tileset image
    
    Returns:
  - setTilesetImagePath
```
public void setTilesetImagePath(java.lang.String tilesetImagePath)
```
    Sets the relative path of the tileset image
    
    Parameters:
    
    tilesetImagePath -
  - getTransparentColorValue
```
public java.lang.String getTransparentColorValue()
```
  - setTransparentColorValue
```
public void setTransparentColorValue(java.lang.String transparentColorValue)
```

Class Tileset

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Tileset

Method Detail

containsProperty

getProperty

setProperty

getProperties

drawTile

drawTileset

getTile

getTile

isTextureLoaded

loadTexture

contains

getTileId

getTileX

getTileY

getWidthInTiles

getHeightInTiles

getName

setName

getWidth

getHeight

getTileWidth

getTileHeight

getSpacing

getMargin

getFirstGid

getTilesetImagePath

setTilesetImagePath

getTransparentColorValue

setTransparentColorValue