OpenTTD Source: src/newgrf_airport.cpp Source File

OpenTTD Source 15.3

newgrf_airport.cpp
Go to the documentation of this file.
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "stdafx.h"
11#include "debug.h"
12#include "timer/timer_game_calendar.h"
13#include "newgrf_badge.h"
14#include "newgrf_spritegroup.h"
15#include "newgrf_text.h"
16#include "station_base.h"
17#include "town.h"
18
19#include "table/strings.h"
20
21#include "newgrf_class_func.h"
22
23#include "safeguards.h"
24
30template <>
31/* static */ void AirportClass::InsertDefaults()
32{
33 AirportClass::Get(AirportClass::Allocate('SMAL'))->name = STR_AIRPORT_CLASS_SMALL;
34 AirportClass::Get(AirportClass::Allocate('LARG'))->name = STR_AIRPORT_CLASS_LARGE;
35 AirportClass::Get(AirportClass::Allocate('HUB_'))->name = STR_AIRPORT_CLASS_HUB;
36 AirportClass::Get(AirportClass::Allocate('HELI'))->name = STR_AIRPORT_CLASS_HELIPORTS;
37}
38
39template <>
40 bool AirportClass::IsUIAvailable(uint) const
41{
42 return true;
43}
44
45/* Instantiate AirportClass. */
46template class NewGRFClass<AirportSpec, AirportClassID, APC_MAX>;
47
48
49 AirportOverrideManager _airport_mngr(NEW_AIRPORT_OFFSET, NUM_AIRPORTS, AT_INVALID);
50
51 AirportSpec AirportSpec::specs[NUM_AIRPORTS];
52
59/* static */ const AirportSpec *AirportSpec::Get(uint8_t type)
60{
61 assert(type < lengthof(AirportSpec::specs));
62 const AirportSpec *as = &AirportSpec::specs[type];
63 if (type >= NEW_AIRPORT_OFFSET && !as->enabled) {
64 if (_airport_mngr.GetGRFID(type) == 0) return as;
65 uint8_t subst_id = _airport_mngr.GetSubstituteID(type);
66 if (subst_id == AT_INVALID) return as;
67 as = &AirportSpec::specs[subst_id];
68 }
69 if (as->grf_prop.override_id != AT_INVALID) return &AirportSpec::specs[as->grf_prop.override_id];
70 return as;
71}
72
79/* static */ AirportSpec *AirportSpec::GetWithoutOverride(uint8_t type)
80{
81 assert(type < lengthof(AirportSpec::specs));
82 return &AirportSpec::specs[type];
83}
84
86 bool AirportSpec::IsAvailable() const
87{
88 if (!this->enabled) return false;
89 if (TimerGameCalendar::year < this->min_year) return false;
90 if (_settings_game.station.never_expire_airports) return true;
91 return TimerGameCalendar::year <= this->max_year;
92}
93
100 bool AirportSpec::IsWithinMapBounds(uint8_t table, TileIndex tile) const
101{
102 if (table >= this->layouts.size()) return false;
103
104 uint8_t w = this->size_x;
105 uint8_t h = this->size_y;
106 if (this->layouts[table].rotation == DIR_E || this->layouts[table].rotation == DIR_W) std::swap(w, h);
107
108 return TileX(tile) + w < Map::SizeX() &&
109 TileY(tile) + h < Map::SizeY();
110}
111
115 void AirportSpec::ResetAirports()
116{
117 extern const AirportSpec _origin_airport_specs[NEW_AIRPORT_OFFSET];
118
119 auto insert = std::copy(std::begin(_origin_airport_specs), std::end(_origin_airport_specs), std::begin(AirportSpec::specs));
120 std::fill(insert, std::end(AirportSpec::specs), AirportSpec{});
121
122 _airport_mngr.ResetOverride();
123}
124
128 void BindAirportSpecs()
129{
130 for (int i = 0; i < NUM_AIRPORTS; i++) {
131 AirportSpec *as = AirportSpec::GetWithoutOverride(i);
132 if (as->enabled) AirportClass::Assign(as);
133 }
134}
135
136
137void AirportOverrideManager::SetEntitySpec(AirportSpec &&as)
138{
139 uint8_t airport_id = this->AddEntityID(as.grf_prop.local_id, as.grf_prop.grfid, as.grf_prop.subst_id);
140
141 if (airport_id == this->invalid_id) {
142 GrfMsg(1, "Airport.SetEntitySpec: Too many airports allocated. Ignoring.");
143 return;
144 }
145
146 AirportSpec::specs[airport_id] = std::move(as);
147
148 /* Now add the overrides. */
149 for (int i = 0; i < this->max_offset; i++) {
150 AirportSpec *overridden_as = AirportSpec::GetWithoutOverride(i);
151
152 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;
153
154 overridden_as->grf_prop.override_id = airport_id;
155 overridden_as->enabled = false;
156 this->entity_overrides[i] = this->invalid_id;
157 this->grfid_overrides[i] = 0;
158 }
159}
160
161/* virtual */ uint32_t AirportScopeResolver::GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
162{
163 switch (variable) {
164 case 0x40: return this->layout;
165
166 case 0x7A: return GetBadgeVariableResult(*this->ro.grffile, this->spec->badges, parameter);
167 }
168
169 if (this->st == nullptr) {
170 available = false;
171 return UINT_MAX;
172 }
173
174 switch (variable) {
175 /* Get a variable from the persistent storage */
176 case 0x7C: return (this->st->airport.psa != nullptr) ? this->st->airport.psa->GetValue(parameter) : 0;
177
178 case 0xF0: return this->st->facilities.base();
179 case 0xFA: return ClampTo<uint16_t>(this->st->build_date - CalendarTime::DAYS_TILL_ORIGINAL_BASE_YEAR);
180 }
181
182 return this->st->GetNewGRFVariable(this->ro, variable, parameter, available);
183}
184
185 GrfSpecFeature AirportResolverObject::GetFeature() const
186{
187 return GSF_AIRPORTS;
188}
189
190uint32_t AirportResolverObject::GetDebugID() const
191{
192 return this->airport_scope.spec->grf_prop.local_id;
193}
194
195/* virtual */ uint32_t AirportScopeResolver::GetRandomBits() const
196{
197 return this->st == nullptr ? 0 : this->st->random_bits;
198}
199
205/* virtual */ void AirportScopeResolver::StorePSA(uint pos, int32_t value)
206{
207 if (this->st == nullptr) return;
208
209 if (this->st->airport.psa == nullptr) {
210 /* There is no need to create a storage if the value is zero. */
211 if (value == 0) return;
212
213 /* Create storage on first modification. */
214 uint32_t grfid = (this->ro.grffile != nullptr) ? this->ro.grffile->grfid : 0;
215 assert(PersistentStorage::CanAllocateItem());
216 this->st->airport.psa = new PersistentStorage(grfid, GSF_AIRPORTS, this->st->airport.tile);
217 }
218 this->st->airport.psa->StoreValue(pos, value);
219}
220
226 TownScopeResolver *AirportResolverObject::GetTown()
227{
228 if (!this->town_scope.has_value()) {
229 Town *t = nullptr;
230 if (this->airport_scope.st != nullptr) {
231 t = this->airport_scope.st->town;
232 } else if (this->airport_scope.tile != INVALID_TILE) {
233 t = ClosestTownFromTile(this->airport_scope.tile, UINT_MAX);
234 }
235 if (t == nullptr) return nullptr;
236 this->town_scope.emplace(*this, t, this->airport_scope.st == nullptr);
237 }
238 return &*this->town_scope;
239}
240
251AirportResolverObject::AirportResolverObject(TileIndex tile, Station *st, const AirportSpec *spec, uint8_t layout,
252 CallbackID callback, uint32_t param1, uint32_t param2)
253 : ResolverObject(spec->grf_prop.grffile, callback, param1, param2), airport_scope(*this, tile, st, spec, layout)
254{
255 this->root_spritegroup = spec->grf_prop.GetSpriteGroup(st != nullptr);
256}
257
258 SpriteID GetCustomAirportSprite(const AirportSpec *as, uint8_t layout)
259{
260 AirportResolverObject object(INVALID_TILE, nullptr, as, layout);
261 const auto *group = object.Resolve<ResultSpriteGroup>();
262 if (group == nullptr || group->num_sprites == 0) return as->preview_sprite;
263
264 return group->sprite;
265}
266
267uint16_t GetAirportCallback(CallbackID callback, uint32_t param1, uint32_t param2, Station *st, TileIndex tile, std::span<int32_t> regs100)
268{
269 AirportResolverObject object(tile, st, AirportSpec::Get(st->airport.type), st->airport.layout, callback, param1, param2);
270 return object.ResolveCallback(regs100);
271}
272
280 StringID GetAirportTextCallback(const AirportSpec *as, uint8_t layout, uint16_t callback)
281{
282 AirportResolverObject object(INVALID_TILE, nullptr, as, layout, (CallbackID)callback);
283 std::array<int32_t, 1> regs100;
284 uint16_t cb_res = object.ResolveCallback(regs100);
285 if (cb_res == CALLBACK_FAILED || cb_res == 0x400) return STR_UNDEFINED;
286 if (cb_res == 0x40F) {
287 return GetGRFStringID(as->grf_prop.grfid, static_cast<GRFStringID>(regs100[0]));
288 }
289 if (cb_res > 0x400) {
290 ErrorUnknownCallbackResult(as->grf_prop.grfid, callback, cb_res);
291 return STR_UNDEFINED;
292 }
293
294 return GetGRFStringID(as->grf_prop.grfid, GRFSTR_MISC_GRF_TEXT + cb_res);
295}
AT_INVALID
@ AT_INVALID
Invalid airport.
Definition airport.h:42
NUM_AIRPORTS
@ NUM_AIRPORTS
Maximal number of airports in total.
Definition airport.h:41
NEW_AIRPORT_OFFSET
@ NEW_AIRPORT_OFFSET
Number of the first newgrf airport.
Definition airport.h:39
AirportOverrideManager
Definition newgrf_commons.h:265
BaseBitSet::base
constexpr Tstorage base() const noexcept
Retrieve the raw value behind this bit set.
Definition base_bitset_type.hpp:219
NewGRFClass
Struct containing information relating to NewGRF classes for stations and airports.
Definition newgrf_class.h:26
NewGRFClass::Assign
static void Assign(Tspec *spec)
Assign a spec to one of the classes.
Definition newgrf_class_func.h:70
NewGRFClass::name
StringID name
Name of this class.
Definition newgrf_class.h:49
NewGRFClass::IsUIAvailable
bool IsUIAvailable(uint index) const
Check whether the spec will be available to the user at some point in time.
Definition newgrf_airport.cpp:40
NewGRFClass::Get
static NewGRFClass * Get(Tindex class_index)
Get a particular class.
Definition newgrf_class_func.h:82
NewGRFClass::Allocate
static Tindex Allocate(uint32_t global_id)
Allocate a class with a given global class ID.
Definition newgrf_class_func.h:32
NewGRFClass::InsertDefaults
static void InsertDefaults()
Initialise the defaults.
Definition newgrf_airport.cpp:31
OverrideManagerBase::GetGRFID
uint32_t GetGRFID(uint16_t entity_id) const
Gives the GRFID of the file the entity belongs to.
Definition newgrf_commons.cpp:140
OverrideManagerBase::invalid_id
uint16_t invalid_id
ID used to detected invalid entities.
Definition newgrf_commons.h:206
OverrideManagerBase::ResetOverride
void ResetOverride()
Resets the override, which is used while initializing game.
Definition newgrf_commons.cpp:79
OverrideManagerBase::GetSubstituteID
uint16_t GetSubstituteID(uint16_t entity_id) const
Gives the substitute of the entity, as specified by the grf file.
Definition newgrf_commons.cpp:150
OverrideManagerBase::max_offset
uint16_t max_offset
what is the length of the original entity's array of specs
Definition newgrf_commons.h:203
OverrideManagerBase::AddEntityID
virtual uint16_t AddEntityID(uint16_t grf_local_id, uint32_t grfid, uint16_t substitute_id)
Reserves a place in the mapping array for an entity to be installed.
Definition newgrf_commons.cpp:110
TimerGameCalendar::year
static Year year
Current year, starting at 0.
Definition timer_game_calendar.h:31
TimerGameConst< struct Calendar >::DAYS_TILL_ORIGINAL_BASE_YEAR
static constexpr TimerGame< struct Calendar >::Date DAYS_TILL_ORIGINAL_BASE_YEAR
The date of the first day of the original base year.
Definition timer_game_common.h:184
debug.h
Functions related to debugging.
DIR_W
@ DIR_W
West.
Definition direction_type.h:32
DIR_E
@ DIR_E
East.
Definition direction_type.h:28
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:438
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:428
GrfSpecFeature
GrfSpecFeature
Definition newgrf.h:68
BindAirportSpecs
void BindAirportSpecs()
Tie all airportspecs to their class.
Definition newgrf_airport.cpp:128
GetAirportTextCallback
StringID GetAirportTextCallback(const AirportSpec *as, uint8_t layout, uint16_t callback)
Get a custom text for the airport.
Definition newgrf_airport.cpp:280
GetBadgeVariableResult
uint32_t GetBadgeVariableResult(const GRFFile &grffile, std::span< const BadgeID > badges, uint32_t parameter)
Test for a matching badge in a list of badges, returning the number of matching bits.
Definition newgrf_badge.cpp:225
newgrf_badge.h
Functions related to NewGRF badges.
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition newgrf_callbacks.h:22
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition newgrf_callbacks.h:439
newgrf_class_func.h
Implementation of the NewGRF class' functions.
ErrorUnknownCallbackResult
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Definition newgrf_commons.cpp:517
newgrf_spritegroup.h
Action 2 handling.
GetGRFStringID
StringID GetGRFStringID(uint32_t grfid, GRFStringID stringid)
Returns the index for this stringid associated with its grfID.
Definition newgrf_text.cpp:580
newgrf_text.h
Header of Action 04 "universal holder" structure and functions.
GRFSTR_MISC_GRF_TEXT
static constexpr GRFStringID GRFSTR_MISC_GRF_TEXT
Miscellaneous GRF text range.
Definition newgrf_text_type.h:18
safeguards.h
A number of safeguards to prevent using unsafe methods.
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
station_base.h
Base classes/functions for stations.
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
lengthof
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:271
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
AirportResolverObject
Resolver object for airports.
Definition newgrf_airport.h:183
AirportResolverObject::GetFeature
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Definition newgrf_airport.cpp:185
AirportResolverObject::AirportResolverObject
AirportResolverObject(TileIndex tile, Station *st, const AirportSpec *spec, uint8_t layout, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
Constructor of the airport resolver.
Definition newgrf_airport.cpp:251
AirportResolverObject::GetTown
TownScopeResolver * GetTown()
Get the town scope associated with a station, if it exists.
Definition newgrf_airport.cpp:226
AirportResolverObject::GetDebugID
uint32_t GetDebugID() const override
Get an identifier for the item being resolved.
Definition newgrf_airport.cpp:190
AirportResolverObject::town_scope
std::optional< TownScopeResolver > town_scope
The town scope resolver (created on the first call).
Definition newgrf_airport.h:185
AirportScopeResolver::GetRandomBits
uint32_t GetRandomBits() const override
Get a few random bits.
Definition newgrf_airport.cpp:195
AirportScopeResolver::spec
const AirportSpec * spec
AirportSpec for which the callback is run.
Definition newgrf_airport.h:159
AirportScopeResolver::layout
uint8_t layout
Layout of the airport to build.
Definition newgrf_airport.h:160
AirportScopeResolver::StorePSA
void StorePSA(uint pos, int32_t value) override
Store a value into the object's persistent storage.
Definition newgrf_airport.cpp:205
AirportScopeResolver::tile
TileIndex tile
Tile for the callback, only valid for airporttile callbacks.
Definition newgrf_airport.h:161
AirportScopeResolver::GetVariable
uint32_t GetVariable(uint8_t variable, uint32_t parameter, bool &available) const override
Get a variable value.
Definition newgrf_airport.cpp:161
AirportScopeResolver::st
struct Station * st
Station of the airport for which the callback is run, or nullptr for build gui.
Definition newgrf_airport.h:158
AirportSpec
Defines the data structure for an airport.
Definition newgrf_airport.h:109
AirportSpec::grf_prop
SubstituteGRFFileProps grf_prop
Properties related to the grf file.
Definition newgrf_airport.h:125
AirportSpec::preview_sprite
SpriteID preview_sprite
preview sprite for this airport
Definition newgrf_airport.h:121
AirportSpec::min_year
TimerGameCalendar::Year min_year
first year the airport is available
Definition newgrf_airport.h:117
AirportSpec::ResetAirports
static void ResetAirports()
This function initializes the airportspec array.
Definition newgrf_airport.cpp:115
AirportSpec::layouts
std::vector< AirportTileLayout > layouts
List of layouts composing the airport.
Definition newgrf_airport.h:111
AirportSpec::specs
static AirportSpec specs[NUM_AIRPORTS]
Specs of the airports.
Definition newgrf_airport.h:146
AirportSpec::IsWithinMapBounds
bool IsWithinMapBounds(uint8_t table, TileIndex index) const
Check if the airport would be within the map bounds at the given tile.
Definition newgrf_airport.cpp:100
AirportSpec::GetWithoutOverride
static AirportSpec * GetWithoutOverride(uint8_t type)
Retrieve airport spec for the given airport.
Definition newgrf_airport.cpp:79
AirportSpec::max_year
TimerGameCalendar::Year max_year
last year the airport is available
Definition newgrf_airport.h:118
AirportSpec::enabled
bool enabled
Entity still available (by default true). Newgrf can disable it, though.
Definition newgrf_airport.h:124
AirportSpec::size_y
uint8_t size_y
size of airport in y direction
Definition newgrf_airport.h:114
AirportSpec::size_x
uint8_t size_x
size of airport in x direction
Definition newgrf_airport.h:113
AirportSpec::Get
static const AirportSpec * Get(uint8_t type)
Retrieve airport spec for the given airport.
Definition newgrf_airport.cpp:59
AirportSpec::IsAvailable
bool IsAvailable() const
Check whether this airport is available to build.
Definition newgrf_airport.cpp:86
Airport::type
uint8_t type
Type of this airport,.
Definition station_base.h:375
Airport::psa
PersistentStorage * psa
Persistent storage for NewGRF airports.
Definition station_base.h:379
Airport::layout
uint8_t layout
Airport layout number.
Definition station_base.h:376
BaseStation::facilities
StationFacilities facilities
The facilities that this station has.
Definition base_station_base.h:69
BaseStation::town
Town * town
The town this station is associated with.
Definition base_station_base.h:67
BaseStation::random_bits
uint16_t random_bits
Random bits assigned to this station.
Definition base_station_base.h:76
BaseStation::build_date
TimerGameCalendar::Date build_date
Date of construction.
Definition base_station_base.h:74
GRFFilePropsBase::local_id
uint16_t local_id
id defined by the grf file for this entity
Definition newgrf_commons.h:316
GRFFilePropsBase::grfid
uint32_t grfid
grfid that introduced this entity.
Definition newgrf_commons.h:317
GameSettings::station
StationSettings station
settings related to station management
Definition settings_type.h:644
Map::SizeX
static uint SizeX()
Get the size of the map along the X.
Definition map_func.h:272
Map::SizeY
static uint SizeY()
Get the size of the map along the Y.
Definition map_func.h:281
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition tilearea_type.h:19
PersistentStorageArray::GetValue
TYPE GetValue(uint pos) const
Gets the value from a given position.
Definition newgrf_storage.h:108
PersistentStorageArray::StoreValue
void StoreValue(uint pos, int32_t value)
Stores some value at a given position.
Definition newgrf_storage.h:80
PersistentStorage
Class for pooled persistent storage of data.
Definition newgrf_storage.h:199
Pool::PoolItem<&_persistent_storage_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition pool_type.hpp:357
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition newgrf_spritegroup.h:288
ResolverObject::grffile
const GRFFile * grffile
GRFFile the resolved SpriteGroup belongs to.
Definition newgrf_spritegroup.h:352
ResolverObject::root_spritegroup
const SpriteGroup * root_spritegroup
Root SpriteGroup to use for resolving.
Definition newgrf_spritegroup.h:353
ResultSpriteGroup
Definition newgrf_spritegroup.h:217
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition newgrf_spritegroup.h:270
StandardGRFFileProps::GetSpriteGroup
const struct SpriteGroup * GetSpriteGroup(bool entity_exists) const
Get the standard sprite group.
Definition newgrf_commons.h:394
StationSettings::never_expire_airports
bool never_expire_airports
never expire airports
Definition settings_type.h:596
Station
Station data structure.
Definition station_base.h:520
Station::airport
Airport airport
Tile area the airport covers.
Definition station_base.h:534
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
SubstituteGRFFileProps::override_id
uint16_t override_id
id of the entity been replaced by
Definition newgrf_commons.h:469
TownScopeResolver
Scope resolver for a town.
Definition newgrf_town.h:22
Town
Town data structure.
Definition town.h:63
INVALID_TILE
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
timer_game_calendar.h
Definition of the game-calendar-timer.
town.h
Base of the town class.
ClosestTownFromTile
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold.
Definition town_cmd.cpp:3961