script_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 SCRIPT_STATION_HPP
00013 #define SCRIPT_STATION_HPP
00014 
00015 #include "script_road.hpp"
00016 #include "script_basestation.hpp"
00017 
00022 class ScriptStation : public ScriptBaseStation {
00023 public:
00027   enum ErrorMessages {
00029     ERR_STATION_BASE = ScriptError::ERR_CAT_STATION << ScriptError::ERR_CAT_BIT_SIZE,
00030 
00032     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]
00033 
00035     ERR_STATION_TOO_MANY_STATIONS,            // [STR_ERROR_TOO_MANY_STATIONS_LOADING, STR_ERROR_TOO_MANY_TRUCK_STOPS, STR_ERROR_TOO_MANY_BUS_STOPS]
00036 
00038     ERR_STATION_TOO_MANY_STATIONS_IN_TOWN,    // [STR_ERROR_LOCAL_AUTHORITY_REFUSES_AIRPORT]
00039   };
00040 
00044   enum StationType {
00045     /* Values are important, as they represent the internal state of the game. */
00046     STATION_TRAIN      = 0x01, 
00047     STATION_TRUCK_STOP = 0x02, 
00048     STATION_BUS_STOP   = 0x04, 
00049     STATION_AIRPORT    = 0x08, 
00050     STATION_DOCK       = 0x10, 
00051     STATION_ANY        = 0x1F, 
00052   };
00053 
00059   static bool IsValidStation(StationID station_id);
00060 
00067   static StationID GetStationID(TileIndex tile);
00068 
00077   static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);
00078 
00087   static int32 GetCargoRating(StationID station_id, CargoID cargo_id);
00088 
00094   static int32 GetCoverageRadius(ScriptStation::StationType station_type);
00095 
00104   static int32 GetDistanceManhattanToTile(StationID station_id, TileIndex tile);
00105 
00114   static int32 GetDistanceSquareToTile(StationID station_id, TileIndex tile);
00115 
00124   static bool IsWithinTownInfluence(StationID station_id, TownID town_id);
00125 
00133   static bool HasStationType(StationID station_id, StationType station_type);
00134 
00142   static bool HasRoadType(StationID station_id, ScriptRoad::RoadType road_type);
00143 
00154   static TownID GetNearestTown(StationID station_id);
00155 };
00156 
00157 DECLARE_ENUM_AS_BIT_SET(ScriptStation::StationType)
00158 
00159 #endif /* SCRIPT_STATION_HPP */