src/script/api/script_airport.cpp

   1 /* $Id: script_airport.cpp 23633 2011-12-19 21:05:36Z truebrain $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file script_airport.cpp Implementation of ScriptAirport. */
  11
  12 #include "../../stdafx.h"
  13 #include "script_airport.hpp"
  14 #include "script_station.hpp"
  15 #include "../../station_base.h"
  16 #include "../../town.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         uint p2 = station_id == ScriptStation::STATION_JOIN_ADJACENT ? 0 : 1;
  81         p2 |= (ScriptStation::IsValidStation(station_id) ? station_id : INVALID_STATION) << 16;
  82         return ScriptObject::DoCommand(tile, type, p2, CMD_BUILD_AIRPORT);
  83 }
  84
  85 /* static */ bool ScriptAirport::RemoveAirport(TileIndex tile)
  86 {
  87         EnforcePrecondition(false, ScriptObject::GetCompany() != OWNER_DEITY);
  88         EnforcePrecondition(false, ::IsValidTile(tile))
  89         EnforcePrecondition(false, IsAirportTile(tile) || IsHangarTile(tile));
  90
  91         return ScriptObject::DoCommand(tile, 0, 0, CMD_LANDSCAPE_CLEAR);
  92 }
  93
  94 /* static */ int32 ScriptAirport::GetNumHangars(TileIndex tile)
  95 {
  96         if (!::IsValidTile(tile)) return -1;
  97         if (!::IsTileType(tile, MP_STATION)) return -1;
  98
  99         const Station *st = ::Station::GetByTile(tile);
 100         if (st->owner != ScriptObject::GetCompany() && ScriptObject::GetCompany() != OWNER_DEITY) return -1;
 101         if ((st->facilities & FACIL_AIRPORT) == 0) return -1;
 102
 103         return st->airport.GetNumHangars();
 104 }
 105
 106 /* static */ TileIndex ScriptAirport::GetHangarOfAirport(TileIndex tile)
 107 {
 108         if (!::IsValidTile(tile)) return INVALID_TILE;
 109         if (!::IsTileType(tile, MP_STATION)) return INVALID_TILE;
 110         if (GetNumHangars(tile) < 1) return INVALID_TILE;
 111
 112         const Station *st = ::Station::GetByTile(tile);
 113         if (st->owner != ScriptObject::GetCompany() && ScriptObject::GetCompany() != OWNER_DEITY) return INVALID_TILE;
 114         if ((st->facilities & FACIL_AIRPORT) == 0) return INVALID_TILE;
 115
 116         return st->airport.GetHangarTile(0);
 117 }
 118
 119 /* static */ ScriptAirport::AirportType ScriptAirport::GetAirportType(TileIndex tile)
 120 {
 121         if (!ScriptTile::IsStationTile(tile)) return AT_INVALID;
 122
 123         StationID station_id = ::GetStationIndex(tile);
 124
 125         if (!ScriptStation::HasStationType(station_id, ScriptStation::STATION_AIRPORT)) return AT_INVALID;
 126
 127         return (AirportType)::Station::Get(station_id)->airport.type;
 128 }
 129
 130
 131 /* static */ int ScriptAirport::GetNoiseLevelIncrease(TileIndex tile, AirportType type)
 132 {
 133         extern Town *AirportGetNearestTown(const AirportSpec *as, const TileIterator &it);
 134         extern uint8 GetAirportNoiseLevelForTown(const AirportSpec *as, TileIterator &it, TileIndex town_tile);
 135
 136         if (!::IsValidTile(tile)) return -1;
 137         if (!IsAirportInformationAvailable(type)) return -1;
 138
 139         if (_settings_game.economy.station_noise_level) {
 140                 const AirportSpec *as = ::AirportSpec::Get(type);
 141                 AirportTileTableIterator it(as->table[0], tile);
 142                 const Town *t = AirportGetNearestTown(as, it);
 143                 return GetAirportNoiseLevelForTown(as, it, t->xy);
 144         }
 145
 146         return 1;
 147 }
 148
 149 /* static */ TownID ScriptAirport::GetNearestTown(TileIndex tile, AirportType type)
 150 {
 151         extern Town *AirportGetNearestTown(const AirportSpec *as, const TileIterator &it);
 152
 153         if (!::IsValidTile(tile)) return INVALID_TOWN;
 154         if (!IsAirportInformationAvailable(type)) return INVALID_TOWN;
 155
 156         const AirportSpec *as = AirportSpec::Get(type);
 157         return AirportGetNearestTown(as, AirportTileTableIterator(as->table[0], tile))->index;
 158 }
 159
 160 /* static */ uint16 ScriptAirport::GetMaintenanceCostFactor(AirportType type)
 161 {
 162         if (!IsAirportInformationAvailable(type)) return INVALID_TOWN;
 163
 164         return AirportSpec::Get(type)->maintenance_cost;
 165 }