OpenTTD: src/newgrf_airport.cpp Source File

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

newgrf_airport.cpp
Go to the documentation of this file.
1 /* $Id: newgrf_airport.cpp 27984 2018-03-11 13:19:41Z frosch $ */
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
12 #include "stdafx.h"
13 #include "debug.h"
14 #include "date_func.h"
15 #include "newgrf_spritegroup.h"
16 #include "newgrf_text.h"
17 #include "station_base.h"
18 #include "newgrf_class_func.h"
19
20 #include "safeguards.h"
21
23 struct AirportScopeResolver : public ScopeResolver {
24 struct Station *st;
25 byte airport_id;
26 byte layout;
27 TileIndex tile;
28
37 AirportScopeResolver(ResolverObject &ro, TileIndex tile, Station *st, byte airport_id, byte layout)
38 : ScopeResolver(ro), st(st), airport_id(airport_id), layout(layout), tile(tile)
39 {
40 }
41
42 /* virtual */ uint32 GetRandomBits() const;
43 /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
44 /* virtual */ void StorePSA(uint pos, int32 value);
45 };
46
48 struct AirportResolverObject : public ResolverObject {
49 AirportScopeResolver airport_scope;
50
51 AirportResolverObject(TileIndex tile, Station *st, byte airport_id, byte layout,
52 CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
53
54 /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
55 {
56 switch (scope) {
57 case VSG_SCOPE_SELF: return &this->airport_scope;
58 default: return ResolverObject::GetScope(scope, relative);
59 }
60 }
61
62 /* virtual */ const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
63 };
64
70 template <typename Tspec, typename Tid, Tid Tmax>
71 /* static */ void NewGRFClass<Tspec, Tid, Tmax>::InsertDefaults()
72 {
73 AirportClass::Get(AirportClass::Allocate('SMAL'))->name = STR_AIRPORT_CLASS_SMALL;
74 AirportClass::Get(AirportClass::Allocate('LARG'))->name = STR_AIRPORT_CLASS_LARGE;
75 AirportClass::Get(AirportClass::Allocate('HUB_'))->name = STR_AIRPORT_CLASS_HUB;
76 AirportClass::Get(AirportClass::Allocate('HELI'))->name = STR_AIRPORT_CLASS_HELIPORTS;
77 }
78
79 template <typename Tspec, typename Tid, Tid Tmax>
80 bool NewGRFClass<Tspec, Tid, Tmax>::IsUIAvailable(uint index) const
81 {
82 return true;
83 }
84
85 INSTANTIATE_NEWGRF_CLASS_METHODS(AirportClass, AirportSpec, AirportClassID, APC_MAX)
86
87
88 AirportOverrideManager _airport_mngr(NEW_AIRPORT_OFFSET, NUM_AIRPORTS, AT_INVALID);
89
90 AirportSpec AirportSpec::specs[NUM_AIRPORTS];
91
98 /* static */ const AirportSpec *AirportSpec::Get(byte type)
99 {
100 assert(type < lengthof(AirportSpec::specs));
101 const AirportSpec *as = &AirportSpec::specs[type];
102 if (type >= NEW_AIRPORT_OFFSET && !as->enabled) {
103 byte subst_id = _airport_mngr.GetSubstituteID(type);
104 if (subst_id == AT_INVALID) return as;
105 as = &AirportSpec::specs[subst_id];
106 }
107 if (as->grf_prop.override != AT_INVALID) return &AirportSpec::specs[as->grf_prop.override];
108 return as;
109 }
110
117 /* static */ AirportSpec *AirportSpec::GetWithoutOverride(byte type)
118 {
119 assert(type < lengthof(AirportSpec::specs));
120 return &AirportSpec::specs[type];
121 }
122
124 bool AirportSpec::IsAvailable() const
125 {
126 if (!this->enabled) return false;
127 if (_cur_year < this->min_year) return false;
128 if (_settings_game.station.never_expire_airports) return true;
129 return _cur_year <= this->max_year;
130 }
131
135 void AirportSpec::ResetAirports()
136 {
137 extern const AirportSpec _origin_airport_specs[];
138 memset(&AirportSpec::specs, 0, sizeof(AirportSpec::specs));
139 memcpy(&AirportSpec::specs, &_origin_airport_specs, sizeof(AirportSpec) * NEW_AIRPORT_OFFSET);
140
141 _airport_mngr.ResetOverride();
142 }
143
147 void BindAirportSpecs()
148 {
149 for (int i = 0; i < NUM_AIRPORTS; i++) {
150 AirportSpec *as = AirportSpec::GetWithoutOverride(i);
151 if (as->enabled) AirportClass::Assign(as);
152 }
153 }
154
155
156 void AirportOverrideManager::SetEntitySpec(AirportSpec *as)
157 {
158 byte airport_id = this->AddEntityID(as->grf_prop.local_id, as->grf_prop.grffile->grfid, as->grf_prop.subst_id);
159
160 if (airport_id == invalid_ID) {
161 grfmsg(1, "Airport.SetEntitySpec: Too many airports allocated. Ignoring.");
162 return;
163 }
164
165 memcpy(AirportSpec::GetWithoutOverride(airport_id), as, sizeof(*as));
166
167 /* Now add the overrides. */
168 for (int i = 0; i < max_offset; i++) {
169 AirportSpec *overridden_as = AirportSpec::GetWithoutOverride(i);
170
171 if (entity_overrides[i] != as->grf_prop.local_id || grfid_overrides[i] != as->grf_prop.grffile->grfid) continue;
172
173 overridden_as->grf_prop.override = airport_id;
174 overridden_as->enabled = false;
175 entity_overrides[i] = invalid_ID;
176 grfid_overrides[i] = 0;
177 }
178 }
179
180 /* virtual */ uint32 AirportScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
181 {
182 switch (variable) {
183 case 0x40: return this->layout;
184 }
185
186 if (this->st == NULL) {
187 *available = false;
188 return UINT_MAX;
189 }
190
191 switch (variable) {
192 /* Get a variable from the persistent storage */
193 case 0x7C: return (this->st->airport.psa != NULL) ? this->st->airport.psa->GetValue(parameter) : 0;
194
195 case 0xF0: return this->st->facilities;
196 case 0xFA: return Clamp(this->st->build_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535);
197 }
198
199 return this->st->GetNewGRFVariable(this->ro, variable, parameter, available);
200 }
201
202 /* virtual */ const SpriteGroup *AirportResolverObject::ResolveReal(const RealSpriteGroup *group) const
203 {
204 /* Airport action 2s should always have only 1 "loaded" state, but some
205 * times things don't follow the spec... */
206 if (group->num_loaded > 0) return group->loaded[0];
207 if (group->num_loading > 0) return group->loading[0];
208
209 return NULL;
210 }
211
212 /* virtual */ uint32 AirportScopeResolver::GetRandomBits() const
213 {
214 return this->st == NULL ? 0 : this->st->random_bits;
215 }
216
223 /* virtual */ void AirportScopeResolver::StorePSA(uint pos, int32 value)
224 {
225 if (this->st == NULL) return;
226
227 if (this->st->airport.psa == NULL) {
228 /* There is no need to create a storage if the value is zero. */
229 if (value == 0) return;
230
231 /* Create storage on first modification. */
232 uint32 grfid = (this->ro.grffile != NULL) ? this->ro.grffile->grfid : 0;
233 assert(PersistentStorage::CanAllocateItem());
234 this->st->airport.psa = new PersistentStorage(grfid, GSF_AIRPORTS, this->st->airport.tile);
235 }
236 this->st->airport.psa->StoreValue(pos, value);
237 }
238
249 AirportResolverObject::AirportResolverObject(TileIndex tile, Station *st, byte airport_id, byte layout,
250 CallbackID callback, uint32 param1, uint32 param2)
251 : ResolverObject(AirportSpec::Get(airport_id)->grf_prop.grffile, callback, param1, param2), airport_scope(*this, tile, st, airport_id, layout)
252 {
253 this->root_spritegroup = AirportSpec::Get(airport_id)->grf_prop.spritegroup[0];
254 }
255
256 SpriteID GetCustomAirportSprite(const AirportSpec *as, byte layout)
257 {
258 AirportResolverObject object(INVALID_TILE, NULL, as->GetIndex(), layout);
259 const SpriteGroup *group = object.Resolve();
260 if (group == NULL) return as->preview_sprite;
261
262 return group->GetResult();
263 }
264
265 uint16 GetAirportCallback(CallbackID callback, uint32 param1, uint32 param2, Station *st, TileIndex tile)
266 {
267 AirportResolverObject object(tile, st, st->airport.type, st->airport.layout, callback, param1, param2);
268 return object.ResolveCallback();
269 }
270
278 StringID GetAirportTextCallback(const AirportSpec *as, byte layout, uint16 callback)
279 {
280 AirportResolverObject object(INVALID_TILE, NULL, as->GetIndex(), layout, (CallbackID)callback);
281 uint16 cb_res = object.ResolveCallback();
282 if (cb_res == CALLBACK_FAILED || cb_res == 0x400) return STR_UNDEFINED;
283 if (cb_res > 0x400) {
284 ErrorUnknownCallbackResult(as->grf_prop.grffile->grfid, callback, cb_res);
285 return STR_UNDEFINED;
286 }
287
288 return GetGRFStringID(as->grf_prop.grffile->grfid, 0xD000 + cb_res);
289 }