1

/* $Id$ */

     2

     3

/** @file ai_tunnel.hpp Everything to query and build tunnels. */

     4

     5

#ifndef AI_TUNNEL_HPP

     6

#define AI_TUNNEL_HPP

     7

     8

#include "ai_object.hpp"

     9

#include "ai_vehicle.hpp"

    10

    11

/**

    12

 * Class that handles all tunnel related functions.

    13

 */

    14

class AITunnel : public AIObject {

    15

public:

    16

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

    17

    18

	/**

    19

	 * Check whether the tile is an entrance to a tunnel.

    20

	 * @param tile The tile to check.

    21

	 * @pre AIMap::IsValidTile(tile).

    22

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

    23

	 */

    24

	static bool IsTunnelTile(TileIndex tile);

    25

    26

	/**

    27

	 * Get the tile that exits on the other end of a (would be) tunnel starting

    28

	 *  at tile.

    29

	 * @param tile The tile that is an entrance to a tunnel or the tile where you may want to build a tunnel.

    30

	 * @pre AIMap::IsValidTile(tile).

    31

	 * @return The TileIndex that is the other end of the (would be) tunnel, or

    32

	 *  'tile' if no other end was found (crossing tunnels).

    33

	 */

    34

	static TileIndex GetOtherTunnelEnd(TileIndex tile);

    35

    36

	/**

    37

	 * Builds a tunnel starting at start. The direction of the tunnel depends

    38

	 *  on the slope of the start tile. Tunnels can be created for either

    39

	 *  rails or roads; use the appropriate AIVehicle::VehicleType.

    40

	 * @param start Where to start the tunnel.

    41

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

    42

	 * @pre AIMap::IsValidTile(start).

    43

	 * @pre 'vehicle_type' is either AIVehicle::VEHICLE_RAIL or AIVEHICLE::VEHICLE_ROAD.

    44

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

    45

	 * @note The slope of a tile can be determined by AITile::GetSlope(TileIndex).

    46

	 */

    47

	static bool BuildTunnel(AIVehicle::VehicleType vehicle_type, TileIndex start);

    48

    49

	/**

    50

	 * Remove the tunnel whose entrance is located at tile.

    51

	 * @param tile The tile that is an entrance to a tunnel.

    52

	 * @pre AIMap::IsValidTile(tile) && IsTunnelTile(tile).

    53

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

    54

	 */

    55

	static bool RemoveTunnel(TileIndex tile);

    56

};

    57

    58

#endif /* AI_TUNNEL_HPP */