bwem

Class Tile

java.lang.Object

bwem.Tile

public final class Tile
extends Object

Corresponds to BWAPI/Starcraft's concept of tile (32x32 pixels).
- Tiles are accessed using TilePositions (Cf. TerrainData.getTile(TilePosition)).
- A BWMap holds BWMap::Size().x * BWMap::Size().y Tiles as its "Tile map".

- It should be noted that a Tile exactly overlaps 4 x 4 MiniTiles.
- As there are 16 times as many MiniTiles as Tiles, we allow a Tiles to contain more data than MiniTiles.
- As a consequence, Tiles should be preferred over MiniTiles, for efficiency.
- The use of Tiles is further facilitated by some functions like Tile::AreaId or Tile::LowestAltitude
which somewhat aggregate the MiniTile's corresponding information

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tile.GroundHeight Corresponds to BWAPI::getGroundHeight divided by 2.

Method Summary

Modifier and Type	Method and Description
AreaId	getAreaId() This function somewhat aggregates the MiniTile::getAreaId() values of the 4 x 4 sub-miniTiles.
Tile.GroundHeight	getGroundHeight() Corresponds to BWAPI::getGroundHeight / 2
Altitude	getLowestAltitude() Tile::LowestAltitude() somewhat aggregates the MiniTile::Altitude() values of the 4 x 4 sub-miniTiles. - Returns the minimum value.
Neutral	getNeutral() If any Neutral occupies this Tile, returns it (note that all the Tiles it occupies will then return it). Otherwise, returns nullptr. - Neutrals are minerals, geysers and StaticBuildings (Cf.
int	getStackedNeutralCount() Returns the number of Neutrals that occupy this Tile (Cf.
boolean	isBuildable() BWEM enforces the relation buildable ==> walkable (Cf.
boolean	isDoodad() Tells if this Tile is part of a doodad.
boolean	isTerrain() Tells if at least one of the sub-miniTiles is a Terrain-MiniTile.
boolean	isWalkable() Tells if at least one of the sub-miniTiles is Walkable.

Methods inherited from class java.lang.Object

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

Method Detail

isBuildable

public boolean isBuildable()

BWEM enforces the relation buildable ==> walkable (Cf. MiniTile.isWalkable())

getAreaId

public AreaId getAreaId()

This function somewhat aggregates the MiniTile::getAreaId() values of the 4 x 4 sub-miniTiles.
- Let S be the set of MiniTile::AreaId() values for each walkable MiniTile in this Tile.
- If empty(S), returns 0. Note: in this case, no contained MiniTile is walkable, so all of them have their AreaId() == 0.
- If S = {a}, returns a (whether positive or negative).
- If size(S) > 1 returns -1 (note that -1 is never returned by MiniTile::AreaId()).

getLowestAltitude

public Altitude getLowestAltitude()

Tile::LowestAltitude() somewhat aggregates the MiniTile::Altitude() values of the 4 x 4 sub-miniTiles.
- Returns the minimum value.

isWalkable

public boolean isWalkable()

Tells if at least one of the sub-miniTiles is Walkable.

isTerrain

public boolean isTerrain()

Tells if at least one of the sub-miniTiles is a Terrain-MiniTile.

getGroundHeight

public Tile.GroundHeight getGroundHeight()

Corresponds to BWAPI::getGroundHeight / 2

isDoodad

public boolean isDoodad()

Tells if this Tile is part of a doodad. Corresponds to BWAPI::getGroundHeight % 2

getNeutral

public Neutral getNeutral()

If any Neutral occupies this Tile, returns it (note that all the Tiles it occupies will then return it).
Otherwise, returns nullptr.
- Neutrals are minerals, geysers and StaticBuildings (Cf. Neutral).
- In some maps (e.g. Benzene.scx), several Neutrals are stacked at the same location.
In this case, only the "bottom" one is returned, while the other ones can be accessed using Neutral::nextStacked().
- Because Neutrals never move on the BWMap, the returned value is guaranteed to remain the same, unless some Neutral
is destroyed and BWEM is informed of that by a call of BWMap::onMineralDestroyed(BWAPI::unit u) for exemple. In such a case,
- BWEM automatically updates the data by deleting the Neutral instance and clearing any reference to it such as the one
returned by Tile::GetNeutral(). In case of stacked Neutrals, the next one is then returned.

getStackedNeutralCount

public int getStackedNeutralCount()

Returns the number of Neutrals that occupy this Tile (Cf. getNeutral()).