# ai_station.hpp

Go to the documentation of this file.

    00001 /* $Id$ */
    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:
    00025   static const char *GetClassName() { return "AIStation"; }
    00026
    00030   enum ErrorMessages {
    00032     ERR_STATION_BASE = AIError::ERR_CAT_STATION << AIError::ERR_CAT_BIT_SIZE,
    00033
    00035     ERR_STATION_TOO_LARGE,                    // [STR_ERROR_STATION_TOO_SPREAD_OUT]
    00036
    00038     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]
    00039
    00041     ERR_STATION_TOO_MANY_STATIONS,            // [STR_ERROR_TOO_MANY_STATIONS_LOADING, STR_ERROR_TOO_MANY_TRUCK_STOPS, STR_ERROR_TOO_MANY_BUS_STOPS]
    00042
    00044     ERR_STATION_TOO_MANY_STATIONS_IN_TOWN,    // []
    00045   };
    00046
    00050   enum StationType {
    00051     /* Values are important, as they represent the internal state of the game. */
    00052     STATION_TRAIN      = 0x01,
    00053     STATION_TRUCK_STOP = 0x02,
    00054     STATION_BUS_STOP   = 0x04,
    00055     STATION_AIRPORT    = 0x08,
    00056     STATION_DOCK       = 0x10,
    00057     STATION_ANY        = 0x1F,
    00058   };
    00059
    00065   static bool IsValidStation(StationID station_id);
    00066
    00073   static StationID GetStationID(TileIndex tile);
    00074
    00083   static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);
    00084
    00093   static int32 GetCargoRating(StationID station_id, CargoID cargo_id);
    00094
    00100   static int32 GetCoverageRadius(AIStation::StationType station_type);
    00101
    00110   static int32 GetDistanceManhattanToTile(StationID station_id, TileIndex tile);
    00111
    00120   static int32 GetDistanceSquareToTile(StationID station_id, TileIndex tile);
    00121
    00129   static bool IsWithinTownInfluence(StationID station_id, TownID town_id);
    00130
    00138   static bool HasStationType(StationID station_id, StationType station_type);
    00139
    00147   static bool HasRoadType(StationID station_id, AIRoad::RoadType road_type);
    00148
    00159   static TownID GetNearestTown(StationID station_id);
    00160 };
    00161
    00162 DECLARE_ENUM_AS_BIT_SET(AIStation::StationType);
    00163
    00164 #endif /* AI_STATION_HPP */