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 "ai_company.hpp"

    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

	 * Actions that one can perform on a town.

    20

	 */

    21

	enum TownAction {

    22

		/* Values are important, as they represent the internal state of the game. */

    23

    24

		/**

    25

		 * The cargo ratings temporary gains 25% of rating (in

    26

		 * absolute percentage, so 10% becomes 35%, with a max of 99%)

    27

		 * for all stations within 10 tiles.

    28

		 */

    29

		TOWN_ACTION_ADVERTISE_SMALL  = 0,

    30

    31

		/**

    32

		 * The cargo ratings temporary gains 44% of rating (in

    33

		 * absolute percentage, so 10% becomes 54%, with a max of 99%)

    34

		 * for all stations within 15 tiles.

    35

		 */

    36

		TOWN_ACTION_ADVERTISE_MEDIUM = 1,

    37

    38

		/**

    39

		 * The cargo ratings temporary gains 63% of rating (in

    40

		 * absolute percentage, so 10% becomes 73%, with a max of 99%)

    41

		 * for all stations within 20 tiles.

    42

		 */

    43

		TOWN_ACTION_ADVERTISE_LARGE  = 2,

    44

    45

		/**

    46

		 * Rebuild the roads of this town for 6 months.

    47

		 */

    48

		TOWN_ACTION_ROAD_REBUILD     = 3,

    49

    50

		/**

    51

		 * Build a statue in this town.

    52

		 */

    53

		TOWN_ACTION_BUILD_STATUE     = 4,

    54

    55

		/**

    56

		 * Fund the creation of extra buildings for 3 months.

    57

		 */

    58

		TOWN_ACTION_FUND_BUILDINGS   = 5,

    59

    60

		/**

    61

		 * Buy exclusive rights for this town for 12 months.

    62

		 */

    63

		TOWN_ACTION_BUY_RIGHTS       = 6,

    64

    65

		/**

    66

		 * Bribe the town in order to get a higher rating.

    67

		 */

    68

		TOWN_ACTION_BRIBE            = 7,

    69

	};

    70

    71

	/**

    88

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

    89

	 * @return The maximum town index.

    90

	 * @post Return value is always non-negative.

    91

	 */

    92

	static TownID GetMaxTownID();

    93

    94

	/**

    95

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

    96

	 *   because of the way OpenTTD works internally.

    97

	 * @return The number of towns.

    98

	 * @post Return value is always non-negative.

    99

	 */

   100

	static int32 GetTownCount();

   101

   102

	/**

   103

	 * Checks whether the given town index is valid.

   104

	 * @param town_id The index to check.

   105

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

   106

	 */

   107

	static bool IsValidTown(TownID town_id);

   108

   109

	/**

   110

	 * Get the name of the town.

   111

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

   112

	 * @pre IsValidTown(town_id).

   113

	 * @return The name of the town.

   114

	 */

   115

	static char *GetName(TownID town_id);

   116

   117

	/**

   118

	 * Gets the number of inhabitants in the town.

   119

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

   120

	 * @pre IsValidTown(town_id).

   121

	 * @return The number of inhabitants.

   122

	 * @post Return value is always non-negative.

   123

	 */

   124

	static int32 GetPopulation(TownID town_id);

   125

   126

	/**

   127

	 * Gets the number of houses in the town.

   128

	 * @param town_id The town to get the number of houses of.

   129

	 * @pre IsValidTown(town_id).

   130

	 * @return The number of houses.

   131

	 * @post Return value is always non-negative.

   132

	 */

   133

	static int32 GetHouseCount(TownID town_id);

   134

   135

	/**

   136

	 * Gets the location of the town.

   137

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

   138

	 * @pre IsValidTown(town_id).

   139

	 * @return The location of the town.

   140

	 */

   141

	static TileIndex GetLocation(TownID town_id);

   142

   143

	/**

   144

	 * Get the total last month's production of the given cargo at a town.

   145

	 * @param town_id The index of the town.

   146

	 * @param cargo_id The index of the cargo.

   147

	 * @pre IsValidTown(town_id).

   148

	 * @pre AICargo::IsValidCargo(cargo_id).

   149

	 * @pre AICargo::GetTownEffect(cargo_id) == TE_PASSENGERS || AICargo::GetTownEffect(cargo_id) == TE_MAIL.

   150

	 * @return The last month's production of the given cargo for this town.

   151

	 * @post Return value is always non-negative.

   152

	 */

   153

	static int32 GetLastMonthProduction(TownID town_id, CargoID cargo_id);

   154

   155

	/**

   156

	 * Get the total amount of cargo transported from a town last month.

   157

	 * @param town_id The index of the industry.

   158

	 * @param cargo_id The index of the cargo.

   159

	 * @pre IsValidTown(town_id).

   160

	 * @pre AICargo::IsValidCargo(cargo_id).

   161

	 * @pre AICargo::GetTownEffect(cargo_id) == TE_PASSENGERS || AICargo::GetTownEffect(cargo_id) == TE_MAIL.

   162

	 * @return The amount of given cargo transported from this town last month.

   163

	 * @post Return value is always non-negative.

   164

	 */

   165

	static int32 GetLastMonthTransported(TownID town_id, CargoID cargo_id);

   166

   167

	/**

   168

	 * Get the maximum production of the given cargo at a town.

   169

	 * @param town_id The index of the town.

   170

	 * @param cargo_id The index of the cargo.

   171

	 * @pre IsValidTown(town_id).

   172

	 * @pre AICargo::IsValidCargo(cargo_id).

   173

	 * @pre AICargo::GetTownEffect(cargo_id) == TE_PASSENGERS || AICargo::GetTownEffect(cargo_id) == TE_MAIL.

   174

	 * @return The maximum production of the given cargo for this town.

   175

	 * @post Return value is always non-negative.

   176

	 */

   177

	static int32 GetMaxProduction(TownID town_id, CargoID cargo_id);

   178

   179

	/**

   180

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

   181

	 *  of the town.

   182

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

   183

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

   184

	 * @pre IsValidTown(town_id).

   185

	 * @return The distance between town and tile.

   186

	 */

   187

	static int32 GetDistanceManhattanToTile(TownID town_id, TileIndex tile);

   188

   189

	/**

   190

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

   191

	 *  of the town.

   192

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

   193

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

   194

	 * @pre IsValidTown(town_id).

   195

	 * @return The distance between town and tile.

   196

	 */

   197

	static int32 GetDistanceSquareToTile(TownID town_id, TileIndex tile);

   198

   199

	/**

   200

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

   201

	 *  Stations on this tile influence the rating of the town.

   202

	 * @param town_id The town to check.

   203

	 * @param tile The tile to check.

   204

	 * @pre IsValidTown(town_id).

   205

	 * @return True if the tile is within the rating influence of the town.

   206

	 */

   207

	static bool IsWithinTownInfluence(TownID town_id, TileIndex tile);

   208

   209

	/**

   210

	 * Find out if this town has a statue for the current player.

   211

	 * @param town_id The town to check.

   212

	 * @pre IsValidTown(town_id).

   213

	 * @return True if the town has a statue.

   214

	 */

   215

	static bool HasStatue(TownID town_id);

   216

   217

	/**

   218

	 * Find out how long the town is undergoing road reconstructions.

   219

	 * @param town_id The town to check.

   220

	 * @pre IsValidTown(town_id).

   221

	 * @return The number of months the road reworks are still going to take.

   222

	 *         The value 0 means that there are currently no road reworks.

   223

	 */

   224

	static int GetRoadReworkDuration(TownID town_id);

   225

   226

	/**

   227

	 * Find out which company currently has the exclusive rights of this town.

   228

	 * @param town_id The town to check.

   229

	 * @pre IsValidTown(town_id).

   230

	 * @return The company that has the exclusive rights. The value

   231

	 *         AICompany::INVALID_COMPANY means that there are currently no

   232

	 *         exclusive rights given out to anyone.

   233

	 */

   234

	static AICompany::CompanyID GetExclusiveRightsPlayer(TownID town_id);

   235

   236

	/**

   237

	 * Find out how long the town is under influence of the exclusive rights.

   238

	 * @param town_id The town to check.

   239

	 * @pre IsValidTown(town_id).

   240

	 * @return The number of months the exclusive rights hold.

   241

	 *         The value 0 means that there are currently no exclusive rights

   242

	 *         given out to anyone.

   243

	 */

   244

	static int32 GetExclusiveRightsDuration(TownID town_id);

   245

   246

	/**

   247

	 * Find out if an action can currently be performed on the town.

   248

	 * @param town_id The town to perform the action on.

   249

	 * @param town_action The action to perform on the town.

   250

	 * @pre IsValidTown(town_id).

   251

	 * @return True if and only if the action can performed.

   252

	 */

   253

	static bool IsActionAvailable(TownID town_id, TownAction town_action);

   254

   255

	/**

   256

	 * Perform a town action on this town.

   257

	 * @param town_id The town to perform the action on.

   258

	 * @param town_action The action to perform on the town.

   259

	 * @pre IsValidTown(town_id).

   260

	 * @pre IsActionAvailable(town_id, town_action).

   261

	 * @return True if the action succeeded.

   262

	 */

   263

	static bool PerformTownAction(TownID town_id, TownAction town_action);

   274

};

   275

   276

#endif /* AI_TOWN_HPP */