1

/* $Id$ */

     2

     3

/** @file ai_station.hpp Everything to query and build stations. */

     4

     5

#ifndef AI_STATION_HPP

     6

#define AI_STATION_HPP

     7

     8

#include "ai_object.hpp"

     9

#include "../../station_type.h"

    10

    11

/**

    12

 * Class that handles all station related functions.

    13

 */

    14

class AIStation : public AIObject {

    15

public:

    16

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

    17

    18

	/**

    19

	 * Type of stations known in the game.

    20

	 */

    21

	enum StationType {

    22

		STATION_ANY        = 0x00, //!< All station types

    23

		STATION_TRAIN      = 0x01, //!< Train station

    24

		STATION_TRUCK_STOP = 0x02, //!< Truck station

    25

		STATION_BUS_STOP   = 0x04, //!< Bus station

    26

		STATION_AIRPORT    = 0x08, //!< Airport

    27

		STATION_DOCK       = 0x10, //!< Dock

    28

	};

    29

    30

	/**

    31

	 * Checks whether the given station is valid and owned by you.

    32

	 * @param station_id The station to check.

    33

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

    34

	 */

    35

	static bool IsValidStation(StationID station_id);

    36

    37

	/**

    38

	 * Get the StationID of a tile, if there is a station.

    39

	 * @param tile The tile to find the stationID of

    40

	 * @return StationID of the station.

    41

	 * @post Use IsValidStation() to see if the station is valid.

    42

	 */

    43

	static StationID GetStationID(TileIndex tile);

    44

    45

	/**

    46

	 * Get the name of a station.

    47

	 * @param station_id The station to get the name of.

    48

	 * @pre IsValidStation(station_id).

    49

	 * @return The name of the station.

    50

	 */

    51

	static char *GetName(StationID station_id);

    52

    53

	/**

    54

	 * Get the current location of a station.

    55

	 * @param station_id The station to get the location of.

    56

	 * @pre IsValidStation(station_id).

    57

	 * @return The tile the station is currently on.

    58

	 */

    59

	static TileIndex GetLocation(StationID station_id);

    60

    61

	/**

    62

	 * See how much cargo there is waiting on a station.

    63

	 * @param station_id The station to get the cargo-waiting of.

    64

	 * @param cargo_id The cargo to get the cargo-waiting of.

    65

	 * @pre IsValidStation(station_id).

    66

	 * @pre IsValidCargo(cargo_id).

    67

	 * @return The amount of units waiting at the station.

    68

	 */

    69

	static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);

    70

    71

	/**

    72

	 * See how high the rating is of a cargo on a station.

    73

	 * @param station_id The station to get the cargo-rating of.

    74

	 * @param cargo_id The cargo to get the cargo-rating of.

    75

	 * @pre IsValidStation(station_id).

    76

	 * @pre IsValidCargo(cargo_id).

    77

	 * @return The rating in percent of the cargo on the station.

    78

	 */

    79

	static int32 GetCargoRating(StationID station_id, CargoID cargo_id);

    80

    81

	/**

    82

	 * Get the coverage radius of this type of station.

    83

	 * @param type The type of station.

    84

	 * @return The radius in tiles.

    85

	 */

    86

	static int32 GetCoverageRadius(AIStation::StationType type);

    87

    88

	/**

    89

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

    90

	 *  of the station.

    91

	 * @param station_id The station to get the distance to.

    92

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

    93

	 * @return The distance between station and tile.

    94

	 */

    95

	static int32 GetDistanceManhattanToTile(StationID station_id, TileIndex tile);

    96

    97

	/**

    98

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

    99

	 *  of the station.

   100

	 * @param station_id The station to get the distance to.

   101

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

   102

	 * @return The distance between station and tile.

   103

	 */

   104

	static int32 GetDistanceSquareToTile(StationID station_id, TileIndex tile);

   105

};

   106

   107

DECLARE_ENUM_AS_BIT_SET(AIStation::StationType);

   108

   109

#endif /* AI_STATION_HPP */