TiledMap::getTileCollisionShapes()

Returns collision outlines defined in a tile's tileset object group. Coordinates start at the tile's top-left; x points right and y points up. Shapes are independent copies and do not modify the map when transformed.

Examples

TiledMapData.java

 
import org.openpatch.scratch.Shape;
import org.openpatch.scratch.extensions.tiled.TiledMap;
 
/**
 * Reading map data does not need a window.
 * @example.online false
 */
public class TiledMapData {
  public TiledMapData() {
    TiledMap map = new TiledMap("src/examples/java/reference/assets/tiled-data.tmx");
    System.out.println(map.getProperty("biome", "forest"));
    System.out.println(map.getWidth() + " columns, " + map.getHeight() + " rows");
    System.out.println(map.getTileWidth() + " x " + map.getTileHeight() + " pixel cells");
    int tileId = map.getTileId("Ground", 1, 0);
    Shape[] localShapes = map.getTileCollisionShapes(tileId);
    Shape[] placedShapes = map.getTileCollisionShapes("Ground", 1, 0);
    for (Shape shape : placedShapes) System.out.println(shape.getBounds());
    // Use these shapes with the game's collision rules; rendering is optional.
  }
  public static void main(String[] args) { new TiledMapData(); }
}

View on GitHub

Syntax

Java

.getTileCollisionShapes(tileId)
.getTileCollisionShapes(layerName, column, row)

Parameters

Name	Data Type	Description
tileId	int	global tile ID (zero and unknown IDs have no shapes)
layerName	String	tile layer name
column	int	column index, starting at zero
row	int	row index, starting at zero

Return

Shape[]