newgrf_airport.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "debug.h"
#include "timer/timer_game_calendar.h"
#include "newgrf_badge.h"
#include "newgrf_spritegroup.h"
#include "newgrf_text.h"
#include "station_base.h"
#include "town.h"
 
#include "table/strings.h"
 
#include "newgrf_class_func.h"
 
#include "safeguards.h"

template <>
/* static */ void AirportClass::InsertDefaults()
{
  AirportClass::Get(AirportClass::Allocate('SMAL'))->name = STR_AIRPORT_CLASS_SMALL;
  AirportClass::Get(AirportClass::Allocate('LARG'))->name = STR_AIRPORT_CLASS_LARGE;
  AirportClass::Get(AirportClass::Allocate('HUB_'))->name = STR_AIRPORT_CLASS_HUB;
  AirportClass::Get(AirportClass::Allocate('HELI'))->name = STR_AIRPORT_CLASS_HELIPORTS;
}
 
template <>
bool AirportClass::IsUIAvailable(uint) const
{
  return true;
}
 
/* Instantiate AirportClass. */
template class NewGRFClass<AirportSpec, AirportClassID>;
 
 
AirportOverrideManager _airport_mngr(NEW_AIRPORT_OFFSET, NUM_AIRPORTS, AT_INVALID);
 
AirportSpec AirportSpec::specs[NUM_AIRPORTS]; 

/* static */ const AirportSpec *AirportSpec::Get(uint8_t type)
{
  assert(type < lengthof(AirportSpec::specs));
  const AirportSpec *as = &AirportSpec::specs[type];
  if (type >= NEW_AIRPORT_OFFSET && !as->enabled) {
    if (_airport_mngr.GetGRFID(type) == 0) return as;
    uint8_t subst_id = _airport_mngr.GetSubstituteID(type);
    if (subst_id == AT_INVALID) return as;
    as = &AirportSpec::specs[subst_id];
  }
  if (as->grf_prop.override_id != AT_INVALID) return &AirportSpec::specs[as->grf_prop.override_id];
  return as;
}

/* static */ AirportSpec *AirportSpec::GetWithoutOverride(uint8_t type)
{
  assert(type < lengthof(AirportSpec::specs));
  return &AirportSpec::specs[type];
}

bool AirportSpec::IsAvailable() const
{
  if (!this->enabled) return false;
  if (TimerGameCalendar::year < this->min_year) return false;
  if (_settings_game.station.never_expire_airports) return true;
  return TimerGameCalendar::year <= this->max_year;
}

bool AirportSpec::IsWithinMapBounds(uint8_t table, TileIndex tile) const
{
  if (table >= this->layouts.size()) return false;
 
  uint8_t w = this->size_x;
  uint8_t h = this->size_y;
  if (this->layouts[table].rotation == DIR_E || this->layouts[table].rotation == DIR_W) std::swap(w, h);
 
  return TileX(tile) + w < Map::SizeX() &&
    TileY(tile) + h < Map::SizeY();
}

void AirportSpec::ResetAirports()
{
  extern const AirportSpec _origin_airport_specs[NEW_AIRPORT_OFFSET];
 
  auto insert = std::copy(std::begin(_origin_airport_specs), std::end(_origin_airport_specs), std::begin(AirportSpec::specs));
  std::fill(insert, std::end(AirportSpec::specs), AirportSpec{});
 
  _airport_mngr.ResetOverride();
}

void BindAirportSpecs()
{
  for (int i = 0; i < NUM_AIRPORTS; i++) {
    AirportSpec *as = AirportSpec::GetWithoutOverride(i);
    if (as->enabled) AirportClass::Assign(as);
  }
}
 
 
void AirportOverrideManager::SetEntitySpec(AirportSpec &&as)
{
  uint8_t airport_id = this->AddEntityID(as.grf_prop.local_id, as.grf_prop.grfid, as.grf_prop.subst_id);
 
  if (airport_id == this->invalid_id) {
    GrfMsg(1, "Airport.SetEntitySpec: Too many airports allocated. Ignoring.");
    return;
  }
 
  AirportSpec::specs[airport_id] = std::move(as);
 
  /* Now add the overrides. */
  for (int i = 0; i < this->max_offset; i++) {
    AirportSpec *overridden_as = AirportSpec::GetWithoutOverride(i);
 
    if (this->entity_overrides[i] != AirportSpec::specs[airport_id].grf_prop.local_id || this->grfid_overrides[i] != AirportSpec::specs[airport_id].grf_prop.grfid) continue;
 
    overridden_as->grf_prop.override_id = airport_id;
    overridden_as->enabled = false;
    this->entity_overrides[i] = this->invalid_id;
    this->grfid_overrides[i] = 0;
  }
}
 
/* virtual */ uint32_t AirportScopeResolver::GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
{
  switch (variable) {
    case 0x40: return this->layout;
 
    case 0x7A: return GetBadgeVariableResult(*this->ro.grffile, this->spec->badges, parameter);
  }
 
  if (this->st == nullptr) {
    available = false;
    return UINT_MAX;
  }
 
  switch (variable) {
    /* Get a variable from the persistent storage */
    case 0x7C: return (this->st->airport.psa != nullptr) ? this->st->airport.psa->GetValue(parameter) : 0;
 
    case 0xF0: return this->st->facilities.base();
    case 0xFA: return ClampTo<uint16_t>(this->st->build_date - CalendarTime::DAYS_TILL_ORIGINAL_BASE_YEAR);
  }
 
  return this->st->GetNewGRFVariable(this->ro, variable, parameter, available);
}
 
GrfSpecFeature AirportResolverObject::GetFeature() const
{
  return GSF_AIRPORTS;
}
 
uint32_t AirportResolverObject::GetDebugID() const
{
  return this->airport_scope.spec->grf_prop.local_id;
}
 
/* virtual */ uint32_t AirportScopeResolver::GetRandomBits() const
{
  return this->st == nullptr ? 0 : this->st->random_bits;
}

/* virtual */ void AirportScopeResolver::StorePSA(uint pos, int32_t value)
{
  if (this->st == nullptr) return;
 
  if (this->st->airport.psa == nullptr) {
    /* There is no need to create a storage if the value is zero. */
    if (value == 0) return;
 
    /* Create storage on first modification. */
    uint32_t grfid = (this->ro.grffile != nullptr) ? this->ro.grffile->grfid : 0;
    assert(PersistentStorage::CanAllocateItem());
    this->st->airport.psa = PersistentStorage::Create(grfid, GSF_AIRPORTS, this->st->airport.tile);
  }
  this->st->airport.psa->StoreValue(pos, value);
}

TownScopeResolver *AirportResolverObject::GetTown()
{
  if (!this->town_scope.has_value()) {
    Town *t = nullptr;
    if (this->airport_scope.st != nullptr) {
      t = this->airport_scope.st->town;
    } else if (this->airport_scope.tile != INVALID_TILE) {
      t = ClosestTownFromTile(this->airport_scope.tile, UINT_MAX);
    }
    if (t == nullptr) return nullptr;
    this->town_scope.emplace(*this, t, this->airport_scope.st == nullptr);
  }
  return &*this->town_scope;
}

AirportResolverObject::AirportResolverObject(TileIndex tile, Station *st, const AirportSpec *spec, uint8_t layout,
    CallbackID callback, uint32_t param1, uint32_t param2)
  : ResolverObject(spec->grf_prop.grffile, callback, param1, param2), airport_scope(*this, tile, st, spec, layout)
{
  this->root_spritegroup = spec->grf_prop.GetSpriteGroup(st != nullptr);
}
 
SpriteID GetCustomAirportSprite(const AirportSpec *as, uint8_t layout)
{
  AirportResolverObject object(INVALID_TILE, nullptr, as, layout);
  const auto *group = object.Resolve<ResultSpriteGroup>();
  if (group == nullptr || group->num_sprites == 0) return as->preview_sprite;
 
  return group->sprite;
}
 
uint16_t GetAirportCallback(CallbackID callback, uint32_t param1, uint32_t param2, Station *st, TileIndex tile, std::span<int32_t> regs100)
{
  AirportResolverObject object(tile, st, AirportSpec::Get(st->airport.type), st->airport.layout, callback, param1, param2);
  return object.ResolveCallback(regs100);
}

StringID GetAirportTextCallback(const AirportSpec *as, uint8_t layout, uint16_t callback)
{
  AirportResolverObject object(INVALID_TILE, nullptr, as, layout, (CallbackID)callback);
  std::array<int32_t, 1> regs100;
  uint16_t cb_res = object.ResolveCallback(regs100);
  if (cb_res == CALLBACK_FAILED || cb_res == 0x400) return STR_UNDEFINED;
  if (cb_res == 0x40F) {
    return GetGRFStringID(as->grf_prop.grfid, static_cast<GRFStringID>(regs100[0]));
  }
  if (cb_res > 0x400) {
    ErrorUnknownCallbackResult(as->grf_prop.grfid, callback, cb_res);
    return STR_UNDEFINED;
  }
 
  return GetGRFStringID(as->grf_prop.grfid, GRFSTR_MISC_GRF_TEXT + cb_res);
}