ai_station.hpp

Go to the documentation of this file.
00001 /* $Id: ai_station.hpp 20288 2010-08-01 20:41:46Z yexo $ */
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_STATION_HPP
00013 #define AI_STATION_HPP
00014 
00015 #include "ai_object.hpp"
00016 #include "ai_error.hpp"
00017 #include "ai_road.hpp"
00018 #include "ai_basestation.hpp"
00019 
00023 class AIStation : public AIBaseStation {
00024 public:
00026   static const char *GetClassName() { return "AIStation"; }
00027 
00031   enum ErrorMessages {
00033     ERR_STATION_BASE = AIError::ERR_CAT_STATION << AIError::ERR_CAT_BIT_SIZE,
00034 
00036     ERR_STATION_TOO_CLOSE_TO_ANOTHER_STATION, // [STR_ERROR_TOO_CLOSE_TO_ANOTHER_AIRPORT, STR_ERROR_TOO_CLOSE_TO_ANOTHER_STATION, STR_ERROR_TOO_CLOSE_TO_ANOTHER_DOCK]
00037 
00039     ERR_STATION_TOO_MANY_STATIONS,            // [STR_ERROR_TOO_MANY_STATIONS_LOADING, STR_ERROR_TOO_MANY_TRUCK_STOPS, STR_ERROR_TOO_MANY_BUS_STOPS]
00040 
00042     ERR_STATION_TOO_MANY_STATIONS_IN_TOWN,    // [STR_ERROR_LOCAL_AUTHORITY_REFUSES_AIRPORT]
00043   };
00044 
00048   enum StationType {
00049     /* Values are important, as they represent the internal state of the game. */
00050     STATION_TRAIN      = 0x01, 
00051     STATION_TRUCK_STOP = 0x02, 
00052     STATION_BUS_STOP   = 0x04, 
00053     STATION_AIRPORT    = 0x08, 
00054     STATION_DOCK       = 0x10, 
00055     STATION_ANY        = 0x1F, 
00056   };
00057 
00063   static bool IsValidStation(StationID station_id);
00064 
00071   static StationID GetStationID(TileIndex tile);
00072 
00081   static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);
00082 
00091   static int32 GetCargoRating(StationID station_id, CargoID cargo_id);
00092 
00098   static int32 GetCoverageRadius(AIStation::StationType station_type);
00099 
00108   static int32 GetDistanceManhattanToTile(StationID station_id, TileIndex tile);
00109 
00118   static int32 GetDistanceSquareToTile(StationID station_id, TileIndex tile);
00119 
00127   static bool IsWithinTownInfluence(StationID station_id, TownID town_id);
00128 
00136   static bool HasStationType(StationID station_id, StationType station_type);
00137 
00145   static bool HasRoadType(StationID station_id, AIRoad::RoadType road_type);
00146 
00157   static TownID GetNearestTown(StationID station_id);
00158 };
00159 
00160 DECLARE_ENUM_AS_BIT_SET(AIStation::StationType)
00161 
00162 #endif /* AI_STATION_HPP */

Generated on Fri Dec 31 17:15:28 2010 for OpenTTD by  doxygen 1.6.1