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

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

    17

	 */

    18

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

    19

    20

	/**

    21

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

    22

	 * @return the maximum town index.

    23

	 * @post return value is always non-negative.

    24

	 */

    25

	TownID GetMaxTownID();

    26

    27

	/**

    28

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

    29

	 *   because of the way OpenTTD works internally.

    30

	 * @return the number of towns.

    31

	 * @post return value is always non-negative.

    32

	 */

    33

	int32 GetTownCount();

    34

    35

	/**

    36

	 * Checks whether the given town index is valid.

    37

	 * @param town_id the index to check.

    38

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

    39

	 */

    40

	static bool IsValidTown(TownID town_id);

    41

    42

	/**

    43

	 * Get the name of the town.

    44

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

    45

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

    46

	 * @return the name of the town.

    47

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

    48

	 */

    49

	char *GetName(TownID town_id);

    50

    51

	/**

    52

	 * Gets the number of inhabitants in the town.

    53

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

    54

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

    55

	 * @return the number of inhabitants.

    56

	 * @post return value is always non-negative.

    57

	 */

    58

	int32 GetPopulation(TownID town_id);

    59

    60

	/**

    61

	 * Gets the location of the town.

    62

	 * @param town_id the location of the town.

    63

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

    64

	 * @return the location of the town.

    65

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

    66

	 */

    67

	TileIndex GetLocation(TownID town_id);

    68

};

    69

    70

#ifdef DEFINE_SQUIRREL_CLASS

    71

namespace SQConvert {

    72

	/* Allow AITown to be used as Squirrel parameter */

    73

	template <> AITown *GetParam(ForceType<AITown *>, HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AITown *)instance; }

    74

}; // namespace SQConvert

    75

    76

void SQAITownRegister(Squirrel *engine) {

    77

	DefSQClass <AITown> SQAITown("AITown");

    78

	SQAITown.PreRegister(engine);

    79

	SQAITown.AddConstructor(engine);

    80

    84

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

    85

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

    86

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

    87

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

    88

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

    89

    90

	SQAITown.PostRegister(engine);

    91

}

    92

#endif /* DEFINE_SQUIRREL_CLASS */

    93

    94

#endif /* AI_TOWN_HPP */