script_basestation.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_BASESTATION_HPP
00013 #define SCRIPT_BASESTATION_HPP
00014 
00015 #include "script_error.hpp"
00016 
00021 class ScriptBaseStation : public ScriptObject {
00022 public:
00027   enum SpecialStationIDs {
00028     STATION_NEW = 0xFFFD,           
00029     STATION_JOIN_ADJACENT = 0xFFFE, 
00030     STATION_INVALID = 0xFFFF,       
00031   };
00032 
00039   static bool IsValidBaseStation(StationID station_id);
00040 
00047   static char *GetName(StationID station_id);
00048 
00059   static bool SetName(StationID station_id, const char *name);
00060 
00069   static TileIndex GetLocation(StationID station_id);
00070 
00076   static int32 GetConstructionDate(StationID station_id);
00077 };
00078 
00079 #endif /* SCRIPT_BASESTATION_HPP */