src/script/api/script_airport.cpp

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file script_airport.cpp Implementation of ScriptAirport. */
   9
  10 #include "../../stdafx.h"
  11 #include "script_airport.hpp"
  12 #include "script_station.hpp"
  13 #include "../../station_base.h"
  14 #include "../../town.h"
  15 #include "../../landscape_cmd.h"
  16 #include "../../station_cmd.h"
  17
  18 #include "../../safeguards.h"
  19
  20 /* static */ bool ScriptAirport::IsValidAirportType(AirportType type)
  21 {
  22         return IsAirportInformationAvailable(type) && ::AirportSpec::Get(type)->IsAvailable();
  23 }
  24
  25 /* static */ bool ScriptAirport::IsAirportInformationAvailable(AirportType type)
  26 {
  27         return type >= 0 && type < (AirportType)NUM_AIRPORTS && AirportSpec::Get(type)->enabled;
  28 }
  29
  30 /* static */ Money ScriptAirport::GetPrice(AirportType type)
  31 {
  32         if (!IsValidAirportType(type)) return -1;
  33
  34         const AirportSpec *as = ::AirportSpec::Get(type);
  35         return _price[PR_BUILD_STATION_AIRPORT] * as->size_x * as->size_y;
  36 }
  37
  38 /* static */ bool ScriptAirport::IsHangarTile(TileIndex tile)
  39 {
  40         if (!::IsValidTile(tile)) return false;
  41
  42         return ::IsTileType(tile, MP_STATION) && ::IsHangar(tile);
  43 }
  44
  45 /* static */ bool ScriptAirport::IsAirportTile(TileIndex tile)
  46 {
  47         if (!::IsValidTile(tile)) return false;
  48
  49         return ::IsTileType(tile, MP_STATION) && ::IsAirport(tile);
  50 }
  51
  52 /* static */ int32 ScriptAirport::GetAirportWidth(AirportType type)
  53 {
  54         if (!IsAirportInformationAvailable(type)) return -1;
  55
  56         return ::AirportSpec::Get(type)->size_x;
  57 }
  58
  59 /* static */ int32 ScriptAirport::GetAirportHeight(AirportType type)
  60 {
  61         if (!IsAirportInformationAvailable(type)) return -1;
  62
  63         return ::AirportSpec::Get(type)->size_y;
  64 }
  65
  66 /* static */ int32 ScriptAirport::GetAirportCoverageRadius(AirportType type)
  67 {
  68         if (!IsAirportInformationAvailable(type)) return -1;
  69
  70         return _settings_game.station.modified_catchment ? ::AirportSpec::Get(type)->catchment : (uint)CA_UNMODIFIED;
  71 }
  72
  73 /* static */ bool ScriptAirport::BuildAirport(TileIndex tile, AirportType type, StationID station_id)
  74 {
  75         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
  76         EnforcePrecondition(false, ::IsValidTile(tile));
  77         EnforcePrecondition(false, IsValidAirportType(type));
  78         EnforcePrecondition(false, station_id == ScriptStation::STATION_NEW || station_id == ScriptStation::STATION_JOIN_ADJACENT || ScriptStation::IsValidStation(station_id));
  79
  80         return ScriptObject::Command<CMD_BUILD_AIRPORT>::Do(tile, type, 0, (ScriptStation::IsValidStation(station_id) ? station_id : INVALID_STATION), station_id == ScriptStation::STATION_JOIN_ADJACENT);
  81 }
  82
  83 /* static */ bool ScriptAirport::RemoveAirport(TileIndex tile)
  84 {
  85         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
  86         EnforcePrecondition(false, ::IsValidTile(tile))
  87         EnforcePrecondition(false, IsAirportTile(tile) || IsHangarTile(tile));
  88
  89         return ScriptObject::Command<CMD_LANDSCAPE_CLEAR>::Do(tile);
  90 }
  91
  92 /* static */ int32 ScriptAirport::GetNumHangars(TileIndex tile)
  93 {
  94         if (!::IsValidTile(tile)) return -1;
  95         if (!::IsTileType(tile, MP_STATION)) return -1;
  96
  97         const Station *st = ::Station::GetByTile(tile);
  98         if (st->owner != ScriptObject::GetCompany() && ScriptObject::GetCompany() != OWNER_DEITY) return -1;
  99         if ((st->facilities & FACIL_AIRPORT) == 0) return -1;
 100
 101         return st->airport.GetNumHangars();
 102 }
 103
 104 /* static */ TileIndex ScriptAirport::GetHangarOfAirport(TileIndex tile)
 105 {
 106         if (!::IsValidTile(tile)) return INVALID_TILE;
 107         if (!::IsTileType(tile, MP_STATION)) return INVALID_TILE;
 108         if (GetNumHangars(tile) < 1) return INVALID_TILE;
 109
 110         const Station *st = ::Station::GetByTile(tile);
 111         if (st->owner != ScriptObject::GetCompany() && ScriptObject::GetCompany() != OWNER_DEITY) return INVALID_TILE;
 112         if ((st->facilities & FACIL_AIRPORT) == 0) return INVALID_TILE;
 113
 114         return st->airport.GetHangarTile(0);
 115 }
 116
 117 /* static */ ScriptAirport::AirportType ScriptAirport::GetAirportType(TileIndex tile)
 118 {
 119         if (!ScriptTile::IsStationTile(tile)) return AT_INVALID;
 120
 121         StationID station_id = ::GetStationIndex(tile);
 122
 123         if (!ScriptStation::HasStationType(station_id, ScriptStation::STATION_AIRPORT)) return AT_INVALID;
 124
 125         return (AirportType)::Station::Get(station_id)->airport.type;
 126 }
 127
 128
 129 /* static */ int ScriptAirport::GetNoiseLevelIncrease(TileIndex tile, AirportType type)
 130 {
 131         extern Town *AirportGetNearestTown(const AirportSpec *as, const TileIterator &it, uint &mindist);
 132         extern uint8 GetAirportNoiseLevelForDistance(const AirportSpec *as, uint distance);
 133
 134         if (!::IsValidTile(tile)) return -1;
 135         if (!IsAirportInformationAvailable(type)) return -1;
 136
 137         const AirportSpec *as = ::AirportSpec::Get(type);
 138         if (!as->IsWithinMapBounds(0, tile)) return -1;
 139
 140         if (_settings_game.economy.station_noise_level) {
 141                 AirportTileTableIterator it(as->table[0], tile);
 142                 uint dist;
 143                 AirportGetNearestTown(as, it, dist);
 144                 return GetAirportNoiseLevelForDistance(as, dist);
 145         }
 146
 147         return 1;
 148 }
 149
 150 /* static */ TownID ScriptAirport::GetNearestTown(TileIndex tile, AirportType type)
 151 {
 152         extern Town *AirportGetNearestTown(const AirportSpec *as, const TileIterator &it, uint &mindist);
 153
 154         if (!::IsValidTile(tile)) return INVALID_TOWN;
 155         if (!IsAirportInformationAvailable(type)) return INVALID_TOWN;
 156
 157         const AirportSpec *as = AirportSpec::Get(type);
 158         if (!as->IsWithinMapBounds(0, tile)) return INVALID_TOWN;
 159
 160         uint dist;
 161         return AirportGetNearestTown(as, AirportTileTableIterator(as->table[0], tile), dist)->index;
 162 }
 163
 164 /* static */ uint16 ScriptAirport::GetMaintenanceCostFactor(AirportType type)
 165 {
 166         if (!IsAirportInformationAvailable(type)) return INVALID_TOWN;
 167
 168         return AirportSpec::Get(type)->maintenance_cost;
 169 }
 170
 171 /* static */ Money ScriptAirport::GetMonthlyMaintenanceCost(AirportType type)
 172 {
 173         if (!IsAirportInformationAvailable(type)) return -1;
 174
 175         return (int64)GetMaintenanceCostFactor(type) * _price[PR_INFRASTRUCTURE_AIRPORT] >> 3;
 176 }