1

/* $Id$ */

     2

     3

/** @file ai_airport.hpp Everything to query and build airports */

     4

     5

#ifndef AI_AIRPORT_HPP

     6

#define AI_AIRPORT_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all airport related functions.

    12

 */

    13

class AIAirport : public AIObject {

    14

public:

    15

	/**

    16

	 * The types of airports available in the game.

    17

	 */

    18

	enum AirportType {

    19

		/* Note: the values _are_ important as they represent an in-game value */

    20

		AT_SMALL         =   0,

    21

		AT_LARGE         =   1,

    22

		AT_HELIPORT      =   2,

    23

		AT_METROPOLITAN  =   3,

    24

		AT_INTERNATIONAL =   4,

    25

		AT_COMMUTER      =   5,

    26

		AT_HELIDEPOT     =   6,

    27

		AT_INTERCON      =   7,

    28

		AT_HELISTATION   =   8,

    29

	};

    30

    31

	/**

    32

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

    33

	 */

    34

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

    35

    36

	/**

    37

	 * Checks whether the given tile is actually a tile with a hangar.

    38

	 * @param tile the tile to check.

    39

	 * @pre AIMap::IsValidTile(tile).

    40

	 * @return true if and only if the tile has a hangar.

    41

	 */

    42

	static bool IsHangarTile(TileIndex tile);

    43

    44

	/**

    45

	 * Checks whether the given tile is actually a tile with a airport.

    46

	 * @param tile the tile to check.

    47

	 * @pre AIMap::IsValidTile(tile).

    48

	 * @return true if and only if the tile has a airport.

    49

	 */

    50

	static bool IsAirportTile(TileIndex tile);

    51

    52

	/**

    53

	 * Check if a certain airport type is already available.

    54

	 * @param type the type of airport to check.

    55

	 */

    56

	static bool AirportAvailable(AirportType type);

    57

    58

	/**

    59

	 * Get the width of this type of airport.

    60

	 * @param type the type of airport.

    61

	 * @return the width in tiles.

    62

	 */

    63

	static int32 GetAirportWidth(AirportType type);

    64

    65

	/**

    66

	 * Get the height of this type of airport.

    67

	 * @param type the type of airport.

    68

	 * @return the height in tiles.

    69

	 */

    70

	static int32 GetAirportHeight(AirportType type);

    71

    72

	/**

    73

	 * Get the coverage radius of this type of airport.

    74

	 * @param type the type of airport.

    75

	 * @return the radius in tiles.

    76

	 */

    77

	static int32 GetAirportCoverageRadius(AirportType type);

    78

    79

	/**

    80

	 * Builds a airport with tile at the topleft corner.

    81

	 * @param tile the topleft corner of the airport.

    82

	 * @param type the type of airport to build.

    83

	 * @pre AIMap::IsValidTile(tile).

    84

	 * @return whether the airport has been/can be build or not.

    85

	 */

    86

	static bool BuildAirport(TileIndex tile, AirportType type);

    87

    88

	/**

    89

	 * Removes a airport.

    90

	 * @param tile any tile of the airport.

    91

	 * @pre AIMap::IsValidTile(tile).

    92

	 * @return whether the airport has been/can be removed or not.

    93

	 */

    94

	static bool RemoveAirport(TileIndex tile);

    95

    96

	/**

    97

	 * Get the first hanger tile of the airport.

    98

	 * @param tile any tile of the airport.

    99

	 * @pre AIMap::IsValidTile(tile).

   100

	 * @return the first hanger tile of the airport.

   101

	 */

   102

	static TileIndex GetHangarOfAirport(TileIndex tile);

   103

};

   104

   105

#endif /* AI_AIRPORT_HPP */