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

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

    16

    17

	/**

    18

	 * The types of airports available in the game.

    19

	 */

    20

	enum AirportType {

    21

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

    22

		AT_SMALL         =   0, //!< The small airport.

    23

		AT_LARGE         =   1, //!< The large airport.

    24

		AT_METROPOLITAN  =   3, //!< The metropolitan airport.

    25

		AT_INTERNATIONAL =   4, //!< The international airport.

    26

		AT_COMMUTER      =   5, //!< The commuter airport.

    27

		AT_INTERCON      =   7, //!< The intercontinental airport.

    28

    29

		/* Next are the airports which only have helicopter platforms */

    30

		AT_HELIPORT      =   2, //!< The heliport.

    31

		AT_HELISTATION   =   8, //!< The helistation.

    32

		AT_HELIDEPOT     =   6, //!< The helidepot.

    33

	};

    34

    35

	/**

    36

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

    37

	 * @param tile The tile to check.

    38

	 * @pre AIMap::IsValidTile(tile).

    39

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

    40

	 */

    41

	static bool IsHangarTile(TileIndex tile);

    42

    43

	/**

    44

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

    45

	 * @param tile The tile to check.

    46

	 * @pre AIMap::IsValidTile(tile).

    47

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

    48

	 */

    49

	static bool IsAirportTile(TileIndex tile);

    50

    51

	/**

    52

	 * Check if a certain airport type is already available.

    53

	 * @param type The type of airport to check.

    54

	 */

    55

	static bool AirportAvailable(AirportType type);

    56

    57

	/**

    58

	 * Get the width of this type of airport.

    59

	 * @param type The type of airport.

    60

	 * @return The width in tiles.

    61

	 */

    62

	static int32 GetAirportWidth(AirportType type);

    63

    64

	/**

    65

	 * Get the height of this type of airport.

    66

	 * @param type The type of airport.

    67

	 * @return The height in tiles.

    68

	 */

    69

	static int32 GetAirportHeight(AirportType type);

    70

    71

	/**

    72

	 * Get the coverage radius of this type of airport.

    73

	 * @param type The type of airport.

    74

	 * @return The radius in tiles.

    75

	 */

    76

	static int32 GetAirportCoverageRadius(AirportType type);

    77

    78

	/**

    79

	 * Get the first hanger tile of the airport.

    80

	 * @param tile Any tile of the airport.

    81

	 * @pre AIMap::IsValidTile(tile).

    82

	 * @return The first hanger tile of the airport.

    83

	 * @note Possible there are more hangars, but you won't be able to find them

    84

	 *  without walking over all the tiles of the airport and using

    85

	 *  IsHangarTile() on them.

    86

	 */

    87

	static TileIndex GetHangarOfAirport(TileIndex tile);

    88

    89

	/**

    90

	 * Builds a airport with tile at the topleft corner.

    91

	 * @param tile The topleft corner of the airport.

    92

	 * @param type The type of airport to build.

    93

	 * @pre AIMap::IsValidTile(tile).

   100

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

   101

	 */

   102

	static bool BuildAirport(TileIndex tile, AirportType type);

   103

   104

	/**

   105

	 * Removes a airport.

   106

	 * @param tile Any tile of the airport.

   107

	 * @pre AIMap::IsValidTile(tile).

   109

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

   110

	 */

   111

	static bool RemoveAirport(TileIndex tile);

   112

};

   113

   114

#endif /* AI_AIRPORT_HPP */