AITile Class Reference

Class that handles all tile related functions. More...


Public Types

enum  ErrorMessages {
  ERR_TILE_BASE,
  ERR_TILE_TOO_HIGH,
  ERR_TILE_TOO_LOW,
  ERR_AREA_ALREADY_FLAT,
  ERR_EXCAVATION_WOULD_DAMAGE
}
 Error messages related to modifying tiles. More...
enum  Corner {
  CORNER_W,
  CORNER_S,
  CORNER_E,
  CORNER_N,
  CORNER_INVALID
}
 Enumeration for corners of tiles. More...
enum  Slope {
  SLOPE_FLAT,
  SLOPE_W,
  SLOPE_S,
  SLOPE_E,
  SLOPE_N,
  SLOPE_STEEP,
  SLOPE_NW,
  SLOPE_SW,
  SLOPE_SE,
  SLOPE_NE,
  SLOPE_EW,
  SLOPE_NS,
  SLOPE_ELEVATED,
  SLOPE_NWS,
  SLOPE_WSE,
  SLOPE_SEN,
  SLOPE_ENW,
  SLOPE_STEEP_W,
  SLOPE_STEEP_S,
  SLOPE_STEEP_E,
  SLOPE_STEEP_N,
  SLOPE_INVALID
}
 Enumeration for the slope-type. More...
enum  TransportType {
  TRANSPORT_RAIL,
  TRANSPORT_ROAD,
  TRANSPORT_WATER,
  TRANSPORT_AIR,
  TRANSPORT_INVALID
}
 The different transport types a tile can have. More...
enum  BuildType {
  BT_FOUNDATION,
  BT_TERRAFORM,
  BT_BUILD_TREES,
  BT_CLEAR_GRASS,
  BT_CLEAR_ROUGH,
  BT_CLEAR_ROCKY,
  BT_CLEAR_FIELDS,
  BT_CLEAR_HOUSE
}
 Get the base cost for building/clearing several things. More...
enum  TerrainType {
  TERRAIN_NORMAL,
  TERRAIN_DESERT,
  TERRAIN_RAINFOREST,
  TERRAIN_SNOW
}
 The types of terrain a tile can have. More...

Static Public Member Functions

static bool IsBuildable (TileIndex tile)
 Check if this tile is buildable, i.e.
static bool IsBuildableRectangle (TileIndex tile, uint width, uint height)
 Check if this tile is buildable in a rectangle around a tile, with the entry in the list as top-left.
static bool IsWaterTile (TileIndex tile)
 Checks whether the given tile is actually a water tile.
static bool IsCoastTile (TileIndex tile)
 Checks whether the given tile is actually a coast tile.
static bool IsStationTile (TileIndex tile)
 Checks whether the given tile is a station tile of any station.
static bool IsSteepSlope (Slope slope)
 Check if a tile has a steep slope.
static bool IsHalftileSlope (Slope slope)
 Check if a tile has a halftile slope.
static bool HasTreeOnTile (TileIndex tile)
 Check if the tile has any tree on it.
static bool IsFarmTile (TileIndex tile)
 Check if the tile is a farmland tile.
static bool IsRockTile (TileIndex tile)
 Check if the tile is a rock tile.
static bool IsRoughTile (TileIndex tile)
 Check if the tile is a rough tile.
static bool IsSnowTile (TileIndex tile)
 Check if the tile without buildings or infrastructure is a snow tile.
static bool IsDesertTile (TileIndex tile)
 Check if the tile without buildings or infrastructure is a desert tile.
static TerrainType GetTerrainType (TileIndex tile)
 Get the type of terrain regardless of buildings or infrastructure.
static Slope GetSlope (TileIndex tile)
 Get the slope of a tile.
static Slope GetComplementSlope (Slope slope)
 Get the complement of the slope.
static int32 GetMinHeight (TileIndex tile)
 Get the minimal height on a tile.
static int32 GetMaxHeight (TileIndex tile)
 Get the maximal height on a tile.
static int32 GetCornerHeight (TileIndex tile, Corner corner)
 Get the height of a certain corner of a tile.
static AICompany::CompanyID GetOwner (TileIndex tile)
 Get the owner of the tile.
static bool HasTransportType (TileIndex tile, TransportType transport_type)
 Checks whether the given tile contains parts suitable for the given TransportType.
static int32 GetCargoAcceptance (TileIndex tile, CargoID cargo_type, int width, int height, int radius)
 Check how much cargo this tile accepts.
static int32 GetCargoProduction (TileIndex tile, CargoID cargo_type, int width, int height, int radius)
 Checks how many producers in the radius produces this cargo.
static int32 GetDistanceManhattanToTile (TileIndex tile_from, TileIndex tile_to)
 Get the manhattan distance from the tile to the tile.
static int32 GetDistanceSquareToTile (TileIndex tile_from, TileIndex tile_to)
 Get the square distance from the tile to the tile.
static bool RaiseTile (TileIndex tile, int32 slope)
 Raise the given corners of the tile.
static bool LowerTile (TileIndex tile, int32 slope)
 Lower the given corners of the tile.
static bool LevelTiles (TileIndex start_tile, TileIndex end_tile)
 Level all tiles in the rectangle between start_tile and end_tile so they are at the same height.
static bool DemolishTile (TileIndex tile)
 Destroy everything on the given tile.
static bool PlantTree (TileIndex tile)
 Create a random tree on a tile.
static bool PlantTreeRectangle (TileIndex tile, uint width, uint height)
 Create a random tree on a rectangle of tiles.
static bool IsWithinTownInfluence (TileIndex tile, TownID town_id)
 Find out if this tile is within the rating influence of a town.
static TownID GetTownAuthority (TileIndex tile)
 Find the town which has authority for the tile.
static TownID GetClosestTown (TileIndex tile)
 Find the town that is closest to a tile.
static Money GetBuildCost (BuildType build_type)
 Get the baseprice of building/clearing various tile-related things.


Detailed Description

Class that handles all tile related functions.

Member Enumeration Documentation

Error messages related to modifying tiles.

Enumerator:
ERR_TILE_BASE  Base for tile related errors.
ERR_TILE_TOO_HIGH  Tile can't be raised any higher.
ERR_TILE_TOO_LOW  Tile can't be lowered any lower.
ERR_AREA_ALREADY_FLAT  The area was already flat.
ERR_EXCAVATION_WOULD_DAMAGE  There is a tunnel underneed.

Enumeration for corners of tiles.

Enumerator:
CORNER_W  West corner.
CORNER_S  South corner.
CORNER_E  East corner.
CORNER_N  North corner.
CORNER_INVALID  An invalid corner.

Enumeration for the slope-type.

This enumeration use the chars N, E, S, W corresponding the direction North, East, South and West. The top corner of a tile is the north-part of the tile.

Enumerator:
SLOPE_FLAT  A flat tile.
SLOPE_W  The west corner of the tile is raised.
SLOPE_S  The south corner of the tile is raised.
SLOPE_E  The east corner of the tile is raised.
SLOPE_N  The north corner of the tile is raised.
SLOPE_STEEP  Indicates the slope is steep (The corner opposite of the not-raised corner is raised two times).
SLOPE_NW  North and west corner are raised.
SLOPE_SW  South and west corner are raised.
SLOPE_SE  South and east corner are raised.
SLOPE_NE  North and east corner are raised.
SLOPE_EW  East and west corner are raised.
SLOPE_NS  North and south corner are raised.
SLOPE_ELEVATED  Bit mask containing all 'simple' slopes. Does not appear as a slope.
SLOPE_NWS  North, west and south corner are raised.
SLOPE_WSE  West, south and east corner are raised.
SLOPE_SEN  South, east and north corner are raised.
SLOPE_ENW  East, north and west corner are raised.
SLOPE_STEEP_W  A steep slope falling to east (from west).
SLOPE_STEEP_S  A steep slope falling to north (from south).
SLOPE_STEEP_E  A steep slope falling to west (from east).
SLOPE_STEEP_N  A steep slope falling to south (from north).
SLOPE_INVALID  An invalid slope.

The different transport types a tile can have.

Enumerator:
TRANSPORT_RAIL  Tile with rail.
TRANSPORT_ROAD  Tile with road.
TRANSPORT_WATER  Tile with navigable waterways.
TRANSPORT_AIR  Tile with airport.
TRANSPORT_INVALID  Tile without any transport type.

Get the base cost for building/clearing several things.

Enumerator:
BT_FOUNDATION  Build a foundation under something.
BT_TERRAFORM  Terraform.
BT_BUILD_TREES  Build trees.
BT_CLEAR_GRASS  Clear a tile with just grass.
BT_CLEAR_ROUGH  Clear a rough tile.
BT_CLEAR_ROCKY  Clear a tile with rocks.
BT_CLEAR_FIELDS  Clear a tile with farm fields.
BT_CLEAR_HOUSE  Clear a tile with a house.

The types of terrain a tile can have.

Note:
When a desert or rainforest tile are changed, their terrain type will remain the same. In other words, a sea tile can be of the desert terrain type.

The snow terrain type can change to the normal terrain type and vice versa based on landscaping or variable snow lines from NewGRFs.

Enumerator:
TERRAIN_NORMAL  A normal tile (default); not desert, rainforest or snow.
TERRAIN_DESERT  A tile in the desert (manually set in in scenarios, below certain height and certain distance from water in random games).
TERRAIN_RAINFOREST  A tile in the rainforest (manually set in scenarios, certain distance away from deserts in random games),.
TERRAIN_SNOW  A tile on or above the snowline level.


Member Function Documentation

static bool AITile::IsBuildable ( TileIndex  tile  )  [static]

Check if this tile is buildable, i.e.

no things on it that needs demolishing.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if it is buildable, false if not.
Note:
For trams you also might want to check for AIRoad::IsRoad(), as you can build tram-rails on road-tiles.

For rail you also might want to check for AIRoad::IsRoad(), as in some cases you can build rails on road-tiles.

static bool AITile::IsBuildableRectangle ( TileIndex  tile,
uint  width,
uint  height 
) [static]

Check if this tile is buildable in a rectangle around a tile, with the entry in the list as top-left.

Parameters:
tile The tile to check on.
width The width of the rectangle.
height The height of the rectangle.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if it is buildable, false if not.

static bool AITile::IsWaterTile ( TileIndex  tile  )  [static]

Checks whether the given tile is actually a water tile.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if the tile is a water tile.

static bool AITile::IsCoastTile ( TileIndex  tile  )  [static]

Checks whether the given tile is actually a coast tile.

Parameters:
tile The tile to check.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if the tile is a coast tile.
Note:
Building on coast tiles in general is more expensive. This is not true if there are also trees on the tile, see HasTreeOnTile.

static bool AITile::IsStationTile ( TileIndex  tile  )  [static]

Checks whether the given tile is a station tile of any station.

Parameters:
tile The tile to check.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if the tile is a station tile.

static bool AITile::IsSteepSlope ( Slope  slope  )  [static]

Check if a tile has a steep slope.

Steep slopes are slopes with a height difference of 2 across one diagonal of the tile.

Parameters:
slope The slope to check on.
Precondition:
slope != SLOPE_INVALID.
Returns:
True if the slope is a steep slope.

static bool AITile::IsHalftileSlope ( Slope  slope  )  [static]

Check if a tile has a halftile slope.

Halftile slopes appear on top of halftile foundations. E.g. the slope you get when building a horizontal railtrack on the top of a SLOPE_N or SLOPE_STEEP_N.

Parameters:
slope The slope to check on.
Precondition:
slope != SLOPE_INVALID.
Returns:
True if the slope is a halftile slope.
Note:
Currently there is no API function that would return or accept a halftile slope.

static bool AITile::HasTreeOnTile ( TileIndex  tile  )  [static]

Check if the tile has any tree on it.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if there is a tree on the tile.

static bool AITile::IsFarmTile ( TileIndex  tile  )  [static]

Check if the tile is a farmland tile.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if the tile is farmland.

static bool AITile::IsRockTile ( TileIndex  tile  )  [static]

Check if the tile is a rock tile.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if the tile is rock tile.

static bool AITile::IsRoughTile ( TileIndex  tile  )  [static]

Check if the tile is a rough tile.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if the tile is rough tile.

static bool AITile::IsSnowTile ( TileIndex  tile  )  [static]

Check if the tile without buildings or infrastructure is a snow tile.

Note:
If you want to know if a tile (with or without buildings and infrastructure) is on or above the snowline, use AITile::GetTerrainType(tile).
Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if the tile is snow tile.

static bool AITile::IsDesertTile ( TileIndex  tile  )  [static]

Check if the tile without buildings or infrastructure is a desert tile.

Note:
If you want to know if a tile (with or without buildings and infrastructure) is in a desert, use AITile::GetTerrainType(tile).
Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if the tile is desert tile.

static TerrainType AITile::GetTerrainType ( TileIndex  tile  )  [static]

Get the type of terrain regardless of buildings or infrastructure.

Note:
When a desert or rainforest tile are changed, their terrain type will remain the same. In other words, a sea tile can be of the desert terrain type.

The snow terrain type can change to the normal terrain type and vice versa based on landscaping or variable snow lines from NewGRFs.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
The TerrainType.

static Slope AITile::GetSlope ( TileIndex  tile  )  [static]

Get the slope of a tile.

This is the slope of the bare tile. A possible foundation on the tile does not influence this slope.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
Bit mask encoding the slope. See Slope for a description of the returned values.

static Slope AITile::GetComplementSlope ( Slope  slope  )  [static]

Get the complement of the slope.

Parameters:
slope The slope to get the complement of.
Precondition:
slope != SLOPE_INVALID.

!IsSteepSlope(slope).

!IsHalftileSlope(slope).

Returns:
The complement of a slope. This means that all corners that weren't raised, are raised, and visa versa.

static int32 AITile::GetMinHeight ( TileIndex  tile  )  [static]

Get the minimal height on a tile.

The returned height is the height of the bare tile. A possible foundation on the tile does not influence this height.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
The height of the lowest corner of the tile, ranging from 0 to 15.

static int32 AITile::GetMaxHeight ( TileIndex  tile  )  [static]

Get the maximal height on a tile.

The returned height is the height of the bare tile. A possible foundation on the tile does not influence this height.

Parameters:
tile The tile to check on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
The height of the highest corner of the tile, ranging from 0 to 15.

static int32 AITile::GetCornerHeight ( TileIndex  tile,
Corner  corner 
) [static]

Get the height of a certain corner of a tile.

The returned height is the height of the bare tile. A possible foundation on the tile does not influence this height.

Parameters:
tile The tile to check on.
corner The corner to query.
Precondition:
AIMap::IsValidTile(tile).
Returns:
The height of the lowest corner of the tile, ranging from 0 to 15.

static AICompany::CompanyID AITile::GetOwner ( TileIndex  tile  )  [static]

Get the owner of the tile.

Parameters:
tile The tile to get the owner from.
Precondition:
AIMap::IsValidTile(tile).
Returns:
The CompanyID of the owner of the tile, or COMPANY_INVALID if there is no owner (grass/industry/water tiles, etc.).

static bool AITile::HasTransportType ( TileIndex  tile,
TransportType  transport_type 
) [static]

Checks whether the given tile contains parts suitable for the given TransportType.

Parameters:
tile The tile to check.
transport_type The TransportType to check against.
Precondition:
AIMap::IsValidTile(tile).

transport_type != TRANSPORT_AIR.

Note:
Returns false on tiles with roadworks and on road tiles with only a single piece of road as these tiles cannot be used to transport anything on. It furthermore returns true on some coast tile for TRANSPORT_WATER because ships can navigate over them.

Use AIAirport.IsAirportTile to check for airport tiles. Aircraft can fly over every tile on the map so using HasTransportType doesn't make sense for TRANSPORT_AIR.

Returns:
True if and only if the tile has the given TransportType.

static int32 AITile::GetCargoAcceptance ( TileIndex  tile,
CargoID  cargo_type,
int  width,
int  height,
int  radius 
) [static]

Check how much cargo this tile accepts.

It creates a radius around the tile, and adds up all acceptance of this cargo.

Parameters:
tile The tile to check on.
cargo_type The cargo to check the acceptance of.
width The width of the station.
height The height of the station.
radius The radius of the station.
Precondition:
AIMap::IsValidTile(tile).

AICargo::IsValidCargo(cargo_type)

width > 0.

height > 0.

radius >= 0.

Returns:
Value below 8 means no acceptance; the more the better.

static int32 AITile::GetCargoProduction ( TileIndex  tile,
CargoID  cargo_type,
int  width,
int  height,
int  radius 
) [static]

Checks how many producers in the radius produces this cargo.

It creates a radius around the tile, and counts all producer of this cargo.

Parameters:
tile The tile to check on.
cargo_type The cargo to check the production of.
width The width of the station.
height The height of the station.
radius The radius of the station.
Precondition:
AIMap::IsValidTile(tile).

AICargo::IsValidCargo(cargo_type)

width > 0.

height > 0.

radius >= 0.

Returns:
The number of producers that produce this cargo within radius of the tile.

static int32 AITile::GetDistanceManhattanToTile ( TileIndex  tile_from,
TileIndex  tile_to 
) [static]

Get the manhattan distance from the tile to the tile.

Parameters:
tile_from The tile to get the distance to.
tile_to The tile to get the distance to.
Returns:
The distance between the two tiles.

static int32 AITile::GetDistanceSquareToTile ( TileIndex  tile_from,
TileIndex  tile_to 
) [static]

Get the square distance from the tile to the tile.

Parameters:
tile_from The tile to get the distance to.
tile_to The tile to get the distance to.
Returns:
The distance between the two tiles.

static bool AITile::RaiseTile ( TileIndex  tile,
int32  slope 
) [static]

Raise the given corners of the tile.

The corners can be combined, for example: SLOPE_N | SLOPE_W (= SLOPE_NW) will raise the west and the north corner.

Note:
The corners will be modified in the order west (first), south, east, north (last). Changing one corner might cause another corner to be changed too. So modifiing multiple corners may result in changing some corners by multiple steps.
Parameters:
tile The tile to raise.
slope Corners to raise (SLOPE_xxx).
Precondition:
tile < AIMap::GetMapSize().
Exceptions:
AIError::ERR_AREA_NOT_CLEAR 
AIError::ERR_TOO_CLOSE_TO_EDGE 
AITile::ERR_TILE_TOO_HIGH 
Returns:
0 means failed, 1 means success.

static bool AITile::LowerTile ( TileIndex  tile,
int32  slope 
) [static]

Lower the given corners of the tile.

The corners can be combined, for example: SLOPE_N | SLOPE_W (= SLOPE_NW) will lower the west and the north corner.

Note:
The corners will be modified in the order west (first), south, east, north (last). Changing one corner might cause another corner to be changed too. So modifiing multiple corners may result in changing some corners by multiple steps.
Parameters:
tile The tile to lower.
slope Corners to lower (SLOPE_xxx).
Precondition:
tile < AIMap::GetMapSize().
Exceptions:
AIError::ERR_AREA_NOT_CLEAR 
AIError::ERR_TOO_CLOSE_TO_EDGE 
AITile::ERR_TILE_TOO_LOW 
Returns:
0 means failed, 1 means success.

static bool AITile::LevelTiles ( TileIndex  start_tile,
TileIndex  end_tile 
) [static]

Level all tiles in the rectangle between start_tile and end_tile so they are at the same height.

All tiles will be raised or lowered until they are at height AITile::GetCornerHeight(start_tile, AITile::CORNER_N).

Parameters:
start_tile One corner of the rectangle to level.
end_tile The opposite corner of the rectangle.
Precondition:
start_tile < AIMap::GetMapSize().

end_tile < AIMap::GetMapSize().

Exceptions:
AIError::ERR_AREA_NOT_CLEAR 
AIError::ERR_TOO_CLOSE_TO_EDGE 
Returns:
True if one or more tiles were leveled.
Note:
Even if leveling some part fails, some other part may have been successfully leveled already.

This function may return true in AITestMode, although it fails in AIExecMode.

static bool AITile::DemolishTile ( TileIndex  tile  )  [static]

Destroy everything on the given tile.

Parameters:
tile The tile to demolish.
Precondition:
AIMap::IsValidTile(tile).
Exceptions:
AIError::ERR_AREA_NOT_CLEAR 
Returns:
True if and only if the tile was demolished.

static bool AITile::PlantTree ( TileIndex  tile  )  [static]

Create a random tree on a tile.

Parameters:
tile The tile to build a tree on.
Precondition:
AIMap::IsValidTile(tile).
Returns:
True if and only if a tree was added on the tile.

static bool AITile::PlantTreeRectangle ( TileIndex  tile,
uint  width,
uint  height 
) [static]

Create a random tree on a rectangle of tiles.

Parameters:
tile The top left tile of the rectangle.
width The width of the rectangle.
height The height of the rectangle.
Precondition:
AIMap::IsValidTile(tile).

width >= 1 && width <= 20.

height >= 1 && height <= 20.

Returns:
True if and only if a tree was added on any of the tiles in the rectangle.

static bool AITile::IsWithinTownInfluence ( TileIndex  tile,
TownID  town_id 
) [static]

Find out if this tile is within the rating influence of a town.

If a station sign would be on this tile, the servicing quality of the station would influence the rating of the town.

Parameters:
tile The tile to check.
town_id The town to check.
Returns:
True if the tile is within the rating influence of the town.

static TownID AITile::GetTownAuthority ( TileIndex  tile  )  [static]

Find the town which has authority for the tile.

The rating of your company in this town will be checked and affected when building stations, trees etc.

Parameters:
tile The tile to check.
Returns:
The TownID of the town which has authority on this tile.

static TownID AITile::GetClosestTown ( TileIndex  tile  )  [static]

Find the town that is closest to a tile.

Stations you build at this tile will belong to this town.

Parameters:
tile The tile to check.
Returns:
The TownID of the town closest to the tile.

static Money AITile::GetBuildCost ( BuildType  build_type  )  [static]

Get the baseprice of building/clearing various tile-related things.

Parameters:
build_type the type to build
Returns:
The baseprice of building or removing the given object.


Generated on Thu Jun 30 21:53:52 2016 for OpenTTD NoAI API by  doxygen 1.5.6