script_airport.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_AIRPORT_HPP
00013 #define SCRIPT_AIRPORT_HPP
00014 
00015 #include "script_object.hpp"
00016 
00021 class ScriptAirport : public ScriptObject {
00022 public:
00026   enum AirportType {
00027     /* Note: the values _are_ important as they represent an in-game value */
00028     AT_SMALL         =   0, 
00029     AT_LARGE         =   1, 
00030     AT_METROPOLITAN  =   3, 
00031     AT_INTERNATIONAL =   4, 
00032     AT_COMMUTER      =   5, 
00033     AT_INTERCON      =   7, 
00034 
00035     /* Next are the airports which only have helicopter platforms */
00036     AT_HELIPORT      =   2, 
00037     AT_HELISTATION   =   8, 
00038     AT_HELIDEPOT     =   6, 
00039 
00040     AT_INVALID       = 255, 
00041   };
00042 
00046   enum PlaneType {
00047     /* Note: the values _are_ important as they represent an in-game value */
00048     PT_HELICOPTER    =   0, 
00049     PT_SMALL_PLANE   =   1, 
00050     PT_BIG_PLANE     =   3, 
00051 
00052     PT_INVALID       =  -1, 
00053   };
00054 
00061   static bool IsValidAirportType(AirportType type);
00062 
00071   static bool IsAirportInformationAvailable(AirportType type);
00072 
00079   static Money GetPrice(AirportType type);
00080 
00087   static bool IsHangarTile(TileIndex tile);
00088 
00095   static bool IsAirportTile(TileIndex tile);
00096 
00103   static int32 GetAirportWidth(AirportType type);
00104 
00111   static int32 GetAirportHeight(AirportType type);
00112 
00119   static int32 GetAirportCoverageRadius(AirportType type);
00120 
00127   static int32 GetNumHangars(TileIndex tile);
00128 
00139   static TileIndex GetHangarOfAirport(TileIndex tile);
00140 
00156   static bool BuildAirport(TileIndex tile, AirportType type, StationID station_id);
00157 
00165   static bool RemoveAirport(TileIndex tile);
00166 
00174   static AirportType GetAirportType(TileIndex tile);
00175 
00185   static int GetNoiseLevelIncrease(TileIndex tile, AirportType type);
00186 
00195   static TownID GetNearestTown(TileIndex tile, AirportType type);
00196 
00203   static uint16 GetMaintenanceCostFactor(AirportType type);
00204 };
00205 
00206 #endif /* SCRIPT_AIRPORT_HPP */