1

/* $Id$ */

     2

     3

/** @file ai_town.hpp Everything to query towns. */

     4

     5

#ifndef AI_TOWN_HPP

     6

#define AI_TOWN_HPP

     7

     8

#include "ai_object.hpp"

     9

#include "../../town_type.h"

    10

    11

/**

    12

 * Class that handles all town related functions.

    13

 */

    14

class AITown : public AIObject {

    15

public:

    16

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

    17

    18

	/**

    19

	 * Gets the maximum town index; there are no valid towns with a higher index.

    20

	 * @return The maximum town index.

    21

	 * @post Return value is always non-negative.

    22

	 */

    23

	static TownID GetMaxTownID();

    24

    25

	/**

    26

	 * Gets the number of towns. This is different than GetMaxTownID()

    27

	 *   because of the way OpenTTD works internally.

    28

	 * @return The number of towns.

    29

	 * @post Return value is always non-negative.

    30

	 */

    31

	static int32 GetTownCount();

    32

    33

	/**

    34

	 * Checks whether the given town index is valid.

    35

	 * @param town_id The index to check.

    36

	 * @return True if and only if the town is valid.

    37

	 */

    38

	static bool IsValidTown(TownID town_id);

    39

    40

	/**

    41

	 * Get the name of the town.

    42

	 * @param town_id The town to get the name of.

    43

	 * @pre IsValidTown(town_id).

    44

	 * @return The name of the town.

    45

	 */

    46

	static char *GetName(TownID town_id);

    47

    48

	/**

    49

	 * Gets the number of inhabitants in the town.

    50

	 * @param town_id The town to get the name of.

    51

	 * @pre IsValidTown(town_id).

    52

	 * @return The number of inhabitants.

    53

	 * @post Return value is always non-negative.

    54

	 */

    55

	static int32 GetPopulation(TownID town_id);

    56

    57

	/**

    58

	 * Gets the location of the town.

    59

	 * @param town_id The location of the town.

    60

	 * @pre IsValidTown(town_id).

    61

	 * @return The location of the town.

    62

	 */

    63

	static TileIndex GetLocation(TownID town_id);

    64

    65

	/**

    66

	 * Get the manhattan distance from the tile to the AITown::GetLocation()

    67

	 *  of the town.

    68

	 * @param town_id The town to get the distance to.

    69

	 * @param tile The tile to get the distance to.

    70

	 * @pre IsValidTown(town_id).

    71

	 * @return The distance between town and tile.

    72

	 */

    73

	static int32 GetDistanceManhattanToTile(TownID town_id, TileIndex tile);

    74

    75

	/**

    76

	 * Get the square distance from the tile to the AITown::GetLocation()

    77

	 *  of the town.

    78

	 * @param town_id The town to get the distance to.

    79

	 * @param tile The tile to get the distance to.

    80

	 * @pre IsValidTown(town_id).

    81

	 * @return The distance between town and tile.

    82

	 */

    83

	static int32 GetDistanceSquareToTile(TownID town_id, TileIndex tile);

    84

};

    85

    86

#endif /* AI_TOWN_HPP */