1

/* $Id$ */

     2

     4

     5

#ifndef AI_STATION_HPP

     6

#define AI_STATION_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all station related functions.

    12

 */

    13

class AIStation : public AIObject {

    14

public:

    17

	/**

    18

	 * Type of stations known in the game.

    19

	 */

    20

	enum StationType {

    21

		STATION_ANY        = 0x00,

    22

		STATION_TRAIN      = 0x01,

    23

		STATION_TRUCK_STOP = 0x02,

    24

		STATION_BUS_STOP   = 0x04,

    25

		STATION_AIRPORT    = 0x08,

    26

		STATION_DOCK       = 0x10,

    27

	};

    28

    29

	/**

    30

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

    31

	 * @param station_id the station to check.

    32

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

    33

	 */

    34

	static bool IsValidStation(StationID station_id);

    35

    36

	/**

    37

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

    38

	 * @param tile the tile to find the stationID of

    39

	 * @return StationID of the station.

    40

	 * @post use IsValidStation to see if the station is valid.

    41

	 */

    42

	static StationID GetStationID(TileIndex tile);

    43

    44

	/**

    45

	 * Get the name of a station.

    46

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

    47

	 * @pre IsValidStation(station_id).

    48

	 * @return the name of the station.

    49

	 */

    50

	static char *GetName(StationID station_id);

    51

    52

	/**

    53

	 * Get the current location of a station.

    54

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

    55

	 * @pre IsValidStation(station_id).

    56

	 * @return the tile the station is currently on.

    57

	 */

    58

	static TileIndex GetLocation(StationID station_id);

    59

    60

	/**

    61

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

    62

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

    63

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

    64

	 * @pre IsValidStation(station_id).

    65

	 * @pre IsValidCargo(cargo_id).

    66

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

    67

	 */

    68

	static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);

    69

    70

	/**

    71

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

    72

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

    73

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

    74

	 * @pre IsValidStation(station_id).

    75

	 * @pre IsValidCargo(cargo_id).

    76

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

    77

	 */

    78

	static int32 GetCargoRating(StationID station_id, CargoID cargo_id);

    79

    80

	/**

    81

	 * Get the coverage radius of this type of station.

    82

	 * @param type the type of station.

    83

	 * @return the radius in tiles.

    84

	 */

    85

	static int32 GetCoverageRadius(AIStation::StationType type);

    86

    87

	/**

    88

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

    89

	 *  of the station.

    90

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

    91

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

    92

	 * @return The distance between station and tile.

    93

	 */

    94

	static int32 GetDistanceManhattanToTile(StationID station_id, TileIndex tile);

    95

    96

	/**

    97

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

    98

	 *  of the station.

    99

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

   100

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

   101

	 * @return The distance between station and tile.

   102

	 */

   103

	static int32 GetDistanceSquareToTile(StationID station_id, TileIndex tile);

   104

};

   105

DECLARE_ENUM_AS_BIT_SET(AIStation::StationType);

   106

   107

#endif /* AI_STATION_HPP */