diff options
author | truebrain <truebrain@openttd.org> | 2011-11-29 23:07:38 +0000 |
---|---|---|
committer | truebrain <truebrain@openttd.org> | 2011-11-29 23:07:38 +0000 |
commit | afdb67a3534f85b4efbd3327ece8137211042d7b (patch) | |
tree | b62375a3846c2089e1c6904331e8f5a3d44851ba /src/ai/api/ai_tunnel.hpp | |
parent | 5f6dc2466318b1275e8b654a260a6c565a0ecc5c (diff) | |
download | openttd-afdb67a3534f85b4efbd3327ece8137211042d7b.tar.xz |
(svn r23354) -Codechange: move all src/ai/api/ai_*.[hc]pp files to src/script/api/script_* (Rubidium)
Diffstat (limited to 'src/ai/api/ai_tunnel.hpp')
-rw-r--r-- | src/ai/api/ai_tunnel.hpp | 111 |
1 files changed, 0 insertions, 111 deletions
diff --git a/src/ai/api/ai_tunnel.hpp b/src/ai/api/ai_tunnel.hpp deleted file mode 100644 index 18f14a03e..000000000 --- a/src/ai/api/ai_tunnel.hpp +++ /dev/null @@ -1,111 +0,0 @@ -/* $Id$ */ - -/* - * This file is part of OpenTTD. - * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2. - * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>. - */ - -/** @file ai_tunnel.hpp Everything to query and build tunnels. */ - -#ifndef AI_TUNNEL_HPP -#define AI_TUNNEL_HPP - -#include "ai_vehicle.hpp" - -/** - * Class that handles all tunnel related functions. - */ -class AITunnel : public AIObject { -public: - /** - * All tunnel related errors. - */ - enum ErrorMessages { - - /** Base for bridge related errors */ - ERR_TUNNEL_BASE = AIError::ERR_CAT_TUNNEL << AIError::ERR_CAT_BIT_SIZE, - - /** Can't build tunnels on water */ - ERR_TUNNEL_CANNOT_BUILD_ON_WATER, // [STR_ERROR_CAN_T_BUILD_ON_WATER] - - /** The start tile must slope either North, South, West or East */ - ERR_TUNNEL_START_SITE_UNSUITABLE, // [STR_ERROR_SITE_UNSUITABLE_FOR_TUNNEL] - - /** Another tunnel is in the way */ - ERR_TUNNEL_ANOTHER_TUNNEL_IN_THE_WAY, // [STR_ERROR_ANOTHER_TUNNEL_IN_THE_WAY] - - /** Unable to excavate land at the end to create the tunnel's exit */ - ERR_TUNNEL_END_SITE_UNSUITABLE, // [STR_ERROR_UNABLE_TO_EXCAVATE_LAND] - }; - - /** - * Check whether the tile is an entrance to a tunnel. - * @param tile The tile to check. - * @pre AIMap::IsValidTile(tile). - * @return True if and only if the tile is the beginning or end of a tunnel. - */ - static bool IsTunnelTile(TileIndex tile); - - /** - * Get the tile that exits on the other end of a (would be) tunnel starting - * at tile. If there is no 'simple' inclined slope at the start tile, - * this function will return AIMap::TILE_INVALID. - * @param tile The tile that is an entrance to a tunnel or the tile where you may want to build a tunnel. - * @pre AIMap::IsValidTile(tile). - * @return The TileIndex that is the other end of the (would be) tunnel, or - * AIMap::TILE_INVALID if no other end was found (can't build tunnel). - * @note Even if this function returns a valid tile, that is no guarantee - * that building a tunnel will succeed. Use BuildTunnel in AITestMode to - * check whether a tunnel can actually be build. - */ - static TileIndex GetOtherTunnelEnd(TileIndex tile); - -#ifndef DOXYGEN_AI_DOCS - /** - * Internal function to help BuildTunnel in case of road. - */ - static bool _BuildTunnelRoad1(); - - /** - * Internal function to help BuildTunnel in case of road. - */ - static bool _BuildTunnelRoad2(); -#endif /* DOXYGEN_AI_DOCS */ - - /** - * Builds a tunnel starting at start. The direction of the tunnel depends - * on the slope of the start tile. Tunnels can be created for either - * rails or roads; use the appropriate AIVehicle::VehicleType. - * As an extra for road, this functions builds two half-pieces of road on - * each end of the tunnel, making it easier for you to connect it to your - * network. - * @param start Where to start the tunnel. - * @param vehicle_type The vehicle-type of tunnel to build. - * @pre AIMap::IsValidTile(start). - * @pre vehicle_type == AIVehicle::VT_ROAD || (vehicle_type == AIVehicle::VT_RAIL && - * AIRail::IsRailTypeAvailable(AIRail::GetCurrentRailType())). - * @exception AIError::ERR_AREA_NOT_CLEAR - * @exception AITunnel::ERR_TUNNEL_CANNOT_BUILD_ON_WATER - * @exception AITunnel::ERR_TUNNEL_START_SITE_UNSUITABLE - * @exception AITunnel::ERR_TUNNEL_ANOTHER_TUNNEL_IN_THE_WAY - * @exception AITunnel::ERR_TUNNEL_END_SITE_UNSUITABLE - * @return Whether the tunnel has been/can be build or not. - * @note The slope of a tile can be determined by AITile::GetSlope(TileIndex). - * @note No matter if the road pieces were build or not, if building the - * tunnel succeeded, this function returns true. - */ - static bool BuildTunnel(AIVehicle::VehicleType vehicle_type, TileIndex start); - - /** - * Remove the tunnel whose entrance is located at tile. - * @param tile The tile that is an entrance to a tunnel. - * @pre AIMap::IsValidTile(tile) && IsTunnelTile(tile). - * @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY - * @return Whether the tunnel has been/can be removed or not. - */ - static bool RemoveTunnel(TileIndex tile); -}; - -#endif /* AI_TUNNEL_HPP */ |