ai_marine.hpp

Go to the documentation of this file.
00001 /* $Id: ai_marine.hpp 21888 2011-01-22 10:33:16Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #ifndef AI_MARINE_HPP
00013 #define AI_MARINE_HPP
00014 
00015 #include "ai_error.hpp"
00016 
00020 class AIMarine : public AIObject {
00021 public:
00023   static const char *GetClassName() { return "AIMarine"; }
00024 
00028   enum ErrorMessages {
00030     ERR_MARINE_BASE = AIError::ERR_CAT_MARINE << AIError::ERR_CAT_BIT_SIZE,
00031 
00033     ERR_MARINE_MUST_BE_BUILT_ON_WATER,                  // [STR_ERROR_MUST_BE_BUILT_ON_WATER]
00034   };
00035 
00039   enum BuildType {
00040     BT_DOCK,  
00041     BT_DEPOT, 
00042     BT_BUOY,  
00043   };
00044 
00051   static bool IsWaterDepotTile(TileIndex tile);
00052 
00059   static bool IsDockTile(TileIndex tile);
00060 
00067   static bool IsBuoyTile(TileIndex tile);
00068 
00075   static bool IsLockTile(TileIndex tile);
00076 
00083   static bool IsCanalTile(TileIndex tile);
00084 
00096   static bool AreWaterTilesConnected(TileIndex tile_from, TileIndex tile_to);
00097 
00111   static bool BuildWaterDepot(TileIndex tile, TileIndex front);
00112 
00125   static bool BuildDock(TileIndex tile, StationID station_id);
00126 
00136   static bool BuildBuoy(TileIndex tile);
00137 
00146   static bool BuildLock(TileIndex tile);
00147 
00158   static bool BuildCanal(TileIndex tile);
00159 
00167   static bool RemoveWaterDepot(TileIndex tile);
00168 
00176   static bool RemoveDock(TileIndex tile);
00177 
00185   static bool RemoveBuoy(TileIndex tile);
00186 
00194   static bool RemoveLock(TileIndex tile);
00195 
00203   static bool RemoveCanal(TileIndex tile);
00204 
00210   static Money GetBuildCost(BuildType build_type);
00211 };
00212 
00213 #endif /* AI_MARINE_HPP */