bwem

Class MiniTile

java.lang.Object

bwem.MiniTile

public final class MiniTile
extends Object

Corresponds to BWAPI/Starcraft's concept of walk tile (8x8 pixels).
- MiniTiles are accessed using WalkPositions TerrainData.getMiniTile(WalkPosition)
- A BWMap holds BWMap::WalkSize().x * BWMap::WalkSize().y MiniTiles as its "MiniTile map".
- A MiniTile contains essentialy 3 pieces of information:
i) its Walkability
ii) its altitude (distance from the nearest non walkable MiniTile, except those which are part of small enough zones (lakes))
iii) the id of the Area it is part of, if ever.
- The whole process of analysis of a BWMap relies on the walkability information
from which are derived successively: altitudes, Areas, ChokePoints.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<Pair<?,MiniTile>>	BY_ALTITUDE_ORDER

Method Summary

Modifier and Type	Method and Description
Altitude	getAltitude() Distance in pixels between the center of this MiniTile and the center of the nearest Sea-MiniTile - Sea-miniTiles all have their Altitude() equal to 0. - miniTiles having Altitude() > 0 are not Sea-miniTiles.
AreaId	getAreaId() For Sea and Lake miniTiles, returns 0 For Terrain miniTiles, returns a non zero id: - if (id > 0), id uniquely identifies the Area A that contains this MiniTile. Moreover we have: A.id() == id and BWMap::getArea(id) == A - For more information about positive Area::ids, see Area::id() - if (id < 0), then this MiniTile is part of a Terrain-zone that was considered too small to create an Area for it. - Note: negative Area::ids start from -2 - Note: because of the lakes, BWMap::getNearestArea should be prefered over BWMap::getArea.
boolean	isLake() Lake-miniTiles are unwalkable miniTiles that have their Altitude() > 0. - They form small zones (inside Terrain-zones) that can be eaysily walked around (e.g.
boolean	isSea() Sea-miniTiles are unwalkable miniTiles that have their altitude equal to 0.
boolean	isTerrain() Terrain miniTiles are just walkable miniTiles
boolean	isWalkable() Corresponds approximatively to BWAPI::isWalkable The differences are: - For each BWAPI's unwalkable MiniTile, we also mark its 8 neighbors as not walkable. According to some tests, this prevents from wrongly pretending one small unit can go by some thin path. - The relation buildable ==> walkable is enforced, by marking as walkable any MiniTile part of a buildable Tile (Cf.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BY_ALTITUDE_ORDER

public static final Comparator<Pair<?,MiniTile>> BY_ALTITUDE_ORDER

Method Detail

isWalkable

public boolean isWalkable()

Corresponds approximatively to BWAPI::isWalkable
The differences are:
- For each BWAPI's unwalkable MiniTile, we also mark its 8 neighbors as not walkable.
According to some tests, this prevents from wrongly pretending one small unit can go by some thin path.
- The relation buildable ==> walkable is enforced, by marking as walkable any MiniTile part of a buildable Tile (Cf. Tile.isBuildable())
Among the miniTiles having Altitude() > 0, the walkable ones are considered Terrain-miniTiles, and the other ones Lake-miniTiles.

getAltitude

public Altitude getAltitude()

Distance in pixels between the center of this MiniTile and the center of the nearest Sea-MiniTile
- Sea-miniTiles all have their Altitude() equal to 0.
- miniTiles having Altitude() > 0 are not Sea-miniTiles. They can be either Terrain-miniTiles or Lake-miniTiles.

isSea

public boolean isSea()

Sea-miniTiles are unwalkable miniTiles that have their altitude equal to 0.

isLake

public boolean isLake()

Lake-miniTiles are unwalkable miniTiles that have their Altitude() > 0.
- They form small zones (inside Terrain-zones) that can be eaysily walked around (e.g. Starcraft's doodads)
- The intent is to preserve the continuity of altitudes inside areas.

isTerrain

public boolean isTerrain()

Terrain miniTiles are just walkable miniTiles

getAreaId

public AreaId getAreaId()

For Sea and Lake miniTiles, returns 0
For Terrain miniTiles, returns a non zero id:
- if (id > 0), id uniquely identifies the Area A that contains this MiniTile.
Moreover we have: A.id() == id and BWMap::getArea(id) == A
- For more information about positive Area::ids, see Area::id()
- if (id < 0), then this MiniTile is part of a Terrain-zone that was considered too small to create an Area for it.
- Note: negative Area::ids start from -2
- Note: because of the lakes, BWMap::getNearestArea should be prefered over BWMap::getArea.