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

    10

/**

    11

 * Class that handles all town related functions.

    12

 */

    13

class AITown : public AIObject {

    14

public:

    15

	/**

    16

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

    17

	 * @return the maximum town index.

    18

	 * @post return value is always non-negative.

    19

	 */

    20

	TownID GetMaxTownID();

    21

    22

	/**

    23

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

    24

	 *   because of the way OpenTTD works internally.

    25

	 * @return the number of towns.

    26

	 * @post return value is always non-negative.

    27

	 */

    28

	int32 GetTownCount();

    29

    30

	/**

    31

	 * Checks whether the given town index is valid.

    32

	 * @param town_id the index to check.

    33

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

    34

	 */

    35

	bool IsValidTown(TownID town_id);

    36

    37

	/**

    38

	 * Get the name of the town.

    39

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

    40

	 * @pre town_id has to be valid (use IsValidTown()).

    41

	 * @return the name of the town.

    42

	 * @note the returned name must be free'd (C++ only).

    43

	 */

    44

	char *GetName(TownID town_id);

    45

    46

	/**

    47

	 * Gets the number of inhabitants in the town.

    48

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

    49

	 * @pre town_id has to be valid (use IsValidTown()).

    50

	 * @return the number of inhabitants.

    51

	 * @post return value is always non-negative.

    52

	 */

    53

	int32 GetPopulation(TownID town_id);

    54

    55

	/**

    56

	 * Gets the location of the town.

    57

	 * @param town_id the location of the town.

    58

	 * @pre town_id has to be valid (use IsValidTown()).

    59

	 * @return the location of the town.

    60

	 * @post return value is always positive and below AIMap::GetMapSize().

    61

	 */

    62

	TileIndex GetLocation(TownID town_id);

    63

};

    64

    65

#ifdef DEFINE_SQUIRREL_CLASS

    66

void SQAITownRegister(Squirrel *engine) {

    67

	DefSQClass <AITown> SQAITown("AITown");

    68

	SQAITown.PreRegister(engine);

    69

	SQAITown.AddConstructor(engine);

    70

	SQAITown.DefSQFunction(engine, &AITown::GetMaxTownID,  "GetMaxTownID");

    71

	SQAITown.DefSQFunction(engine, &AITown::GetTownCount,  "GetTownCount");

    72

	SQAITown.DefSQFunction(engine, &AITown::IsValidTown,   "IsValidTown");

    73

	SQAITown.DefSQFunction(engine, &AITown::GetName,       "GetName");

    74

	SQAITown.DefSQFunction(engine, &AITown::GetPopulation, "GetPopulation");

    75

	SQAITown.DefSQFunction(engine, &AITown::GetLocation,   "GetLocation");

    76

	SQAITown.PostRegister(engine);

    77

}

    78

#endif /* SQUIRREL_CLASS */

    79

    80

#endif /* AI_TOWN_HPP */