1

/* $Id$ */

     2

     3

/** @file ai_tile.hpp tile related functions */

     4

     5

#ifndef AI_TILE_HPP

     6

#define AI_TILE_HPP

     7

     8

#include "ai_abstractlist.hpp"

     9

    10

/**

    11

 * Class that handles all tile related functions.

    12

 */

    13

class AITile : public AIObject {

    14

public:

    15

	/**

    16

	 * The name of the class, needed by several sub-processes.

    17

	 */

    18

	static const char *GetClassName() { return "AITile"; }

    19

    20

	/**

    21

	 * Check if this tile is buildable (e.g.: no things on it that needs removing).

    22

	 * @note Road and rail are considered buildable.

    23

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    24

	 * @param tile the tile to check on.

    25

	 * @return true if it is buildable, false if not.

    26

	 */

    27

	static bool IsBuildable(TileIndex tile);

    28

    29

	/**

    30

	 * Get the slope of a tile.

    31

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    32

	 * @param tile the tile to check on.

    33

	 * @return 0 means flat, others indicate internal state of slope.

    34

	 */

    35

	static int32 GetSlope(TileIndex tile);

    36

    37

	/**

    38

	 * Check how much cargo this tile accepts.

    39

	 *  It creates a radius around the tile and adds up all acceptance of this

    40

	 *   cargo and returns that value.

    41

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    42

	 * @param tile the tile to check on.

    43

	 * @param cargo_type the cargo to check the acceptance of.

    44

	 * @param width the width of the station.

    45

	 * @param height the height of the station.

    46

	 * @param radius the radius of the station.

    47

	 * @return value below 8 means no acceptance; the more the better.

    48

	 */

    49

	static int32 GetCargoAcceptance(TileIndex tile, CargoID cargo_type, uint width, uint height, uint radius);

    50

};

    51

    52

#endif /* AI_TILE_HPP */