1

/* $Id$ */

     2

     3

/** @file ai_bridge.hpp Everything to query and build bridges. */

     4

     5

#ifndef AI_BRIDGE_HPP

     6

#define AI_BRIDGE_HPP

     7

     8

#include "ai_object.hpp"

     9

#include "ai_vehicle.hpp"

    10

#include "../../bridge.h"

    11

    12

/** In OpenTTD Core 'BridgeID' is called 'BridgeType', so map it to make this API more logic. */

    13

typedef BridgeType BridgeID;

    14

    15

/**

    16

 * Class that handles all bridge related functions.

    17

 */

    18

class AIBridge : public AIObject {

    19

public:

    20

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

    21

    22

	/**

    23

	 * Checks whether the given bridge type is valid.

    24

	 * @param bridge_id The bridge to check.

    25

	 * @return True if and only if the bridge type is valid.

    26

	 */

    27

	static bool IsValidBridge(BridgeID bridge_id);

    28

    29

	/**

    30

	 * Checks whether the given tile is actually a bridge start or end tile.

    31

	 * @param tile The tile to check.

    32

	 * @pre AIMap::IsValidTile(tile).

    33

	 * @return True if and only if the tile is the beginning or end of a bridge.

    34

	 */

    35

	static bool IsBridgeTile(TileIndex tile);

    36

    37

	/**

    38

	 * Get the name of a bridge.

    39

	 * @param bridge_id The bridge to get the name of.

    40

	 * @pre IsValidBridge(bridge_id).

    41

	 * @return The name the bridge has.

    42

	 */

    43

	static char *GetName(BridgeID bridge_id);

    44

    45

	/**

    46

	 * Get the maximum speed of a bridge (in km/h).

    47

	 * @param bridge_id The bridge to get the maximum speed of.

    48

	 * @pre IsValidBridge(bridge_id).

    49

	 * @return The maximum speed the bridge has.

    50

	 */

    51

	static uint32 GetMaxSpeed(BridgeID bridge_id);

    52

    53

	/**

    54

	 * Get the new cost of a bridge.

    55

	 * @param bridge_id The bridge to get the new cost of.

    56

	 * @param length The length of the bridge.

    57

	 * @pre IsValidBridge(bridge_id).

    58

	 * @return The new cost the bridge has.

    59

	 */

    60

	static uint32 GetPrice(BridgeID bridge_id, uint length);

    61

    62

	/**

    63

	 * Get the maximum length of a bridge.

    64

	 * @param bridge_id The bridge to get the maximum length of.

    65

	 * @pre IsValidBridge(bridge_id).

    66

	 * @returns The maximum length the bridge has.

    67

	 */

    68

	static uint32 GetMaxLength(BridgeID bridge_id);

    69

    70

	/**

    71

	 * Get the minimum length of a bridge.

    72

	 * @param bridge_id The bridge to get the minimum length of.

    73

	 * @pre IsValidBridge(bridge_id).

    74

	 * @returns The minimum length the bridge has.

    75

	 */

    76

	static uint32 GetMinLength(BridgeID bridge_id);

    77

    78

	/**

    79

	 * Get the year in which a bridge becomes available.

    80

	 * @param bridge_id The bridge to get the year of availability of.

    81

	 * @pre IsValidBridge(bridge_id).

    82

	 * @returns The year of availability the bridge has.

    83

	 * @note Years are like 2010, -10 (10 B.C.), 1950, ..

    84

	 */

    85

	static int32 GetYearAvailable(BridgeID bridge_id);

    86

    87

	/**

    88

	 * Build a bridge from one tile to the other.

    89

	 * @param vehicle_type The vehicle-type of bridge to build.

    90

	 * @param bridge_id The bridge-type to build.

    91

	 * @param start Where to start the bridge.

    92

	 * @param end Where to end the bridge.

    93

	 * @pre AIMap::IsValidTile(start).

    94

	 * @pre AIMap::IsValidTile(end).

    95

	 * @pre 'start' and 'end' are in a straight line, i.e.

    96

	 *  AIMap::GetTileX(start) == AIMap::GetTileX(end) or

    97

	 *  AIMap::GetTileY(start) == AIMap::GetTileY(end).

    99

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

   100

	 */

   101

	static bool BuildBridge(AIVehicle::VehicleType vehicle_type, BridgeID bridge_id, TileIndex start, TileIndex end);

   102

   103

	/**

   104

	 * Removes a bridge, by executing it on either the start or end tile.

   105

	 * @param tile An end or start tile of the bridge.

   106

	 * @pre AIMap::IsValidTile(tile).

   107

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

   108

	 */

   109

	static bool RemoveBridge(TileIndex tile);

   110

};

   111

   112

#endif /* AI_BRIDGE_HPP */