src/newgrf_airport.cpp

   1 /* $Id$ */
   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 newgrf_airport.cpp NewGRF handling of airports. */
  11
  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 /** Resolver for the airport scope. */
  21 struct AirportScopeResolver : public ScopeResolver {
  22         struct Station *st; ///< Station of the airport for which the callback is run, or \c NULL for build gui.
  23         byte airport_id;    ///< Type of airport for which the callback is run.
  24         byte layout;        ///< Layout of the airport to build.
  25         TileIndex tile;     ///< Tile for the callback, only valid for airporttile callbacks.
  26
  27         AirportScopeResolver(ResolverObject &ro, TileIndex tile, Station *st, byte airport_id, byte layout);
  28
  29         /* virtual */ uint32 GetRandomBits() const;
  30         /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
  31         /* virtual */ void StorePSA(uint pos, int32 value);
  32 };
  33
  34 /** Resolver object for airports. */
  35 struct AirportResolverObject : public ResolverObject {
  36         AirportScopeResolver airport_scope;
  37
  38         AirportResolverObject(TileIndex tile, Station *st, byte airport_id, byte layout,
  39                         CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
  40
  41         /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
  42         {
  43                 switch (scope) {
  44                         case VSG_SCOPE_SELF: return &this->airport_scope;
  45                         default: return ResolverObject::GetScope(scope, relative);
  46                 }
  47         }
  48
  49         /* virtual */ const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
  50 };
  51
  52 /**
  53  * Reset airport classes to their default state.
  54  * This includes initialising the defaults classes with an empty
  55  * entry, for standard airports.
  56  */
  57 template <typename Tspec, typename Tid, Tid Tmax>
  58 /* static */ void NewGRFClass<Tspec, Tid, Tmax>::InsertDefaults()
  59 {
  60         AirportClass::Get(AirportClass::Allocate('SMAL'))->name = STR_AIRPORT_CLASS_SMALL;
  61         AirportClass::Get(AirportClass::Allocate('LARG'))->name = STR_AIRPORT_CLASS_LARGE;
  62         AirportClass::Get(AirportClass::Allocate('HUB_'))->name = STR_AIRPORT_CLASS_HUB;
  63         AirportClass::Get(AirportClass::Allocate('HELI'))->name = STR_AIRPORT_CLASS_HELIPORTS;
  64 }
  65
  66 template <typename Tspec, typename Tid, Tid Tmax>
  67 bool NewGRFClass<Tspec, Tid, Tmax>::IsUIAvailable(uint index) const
  68 {
  69         return true;
  70 }
  71
  72 INSTANTIATE_NEWGRF_CLASS_METHODS(AirportClass, AirportSpec, AirportClassID, APC_MAX)
  73
  74
  75 AirportOverrideManager _airport_mngr(NEW_AIRPORT_OFFSET, NUM_AIRPORTS, AT_INVALID);
  76
  77 AirportSpec AirportSpec::specs[NUM_AIRPORTS]; ///< Airport specifications.
  78
  79 /**
  80  * Retrieve airport spec for the given airport. If an override is available
  81  *  it is returned.
  82  * @param type index of airport
  83  * @return A pointer to the corresponding AirportSpec
  84  */
  85 /* static */ const AirportSpec *AirportSpec::Get(byte type)
  86 {
  87         assert(type < lengthof(AirportSpec::specs));
  88         const AirportSpec *as = &AirportSpec::specs[type];
  89         if (type >= NEW_AIRPORT_OFFSET && !as->enabled) {
  90                 byte subst_id = _airport_mngr.GetSubstituteID(type);
  91                 if (subst_id == AT_INVALID) return as;
  92                 as = &AirportSpec::specs[subst_id];
  93         }
  94         if (as->grf_prop.override != AT_INVALID) return &AirportSpec::specs[as->grf_prop.override];
  95         return as;
  96 }
  97
  98 /**
  99  * Retrieve airport spec for the given airport. Even if an override is
 100  *  available the base spec is returned.
 101  * @param type index of airport
 102  * @return A pointer to the corresponding AirportSpec
 103  */
 104 /* static */ AirportSpec *AirportSpec::GetWithoutOverride(byte type)
 105 {
 106         assert(type < lengthof(AirportSpec::specs));
 107         return &AirportSpec::specs[type];
 108 }
 109
 110 /** Check whether this airport is available to build. */
 111 bool AirportSpec::IsAvailable() const
 112 {
 113         if (!this->enabled) return false;
 114         if (_cur_year < this->min_year) return false;
 115         if (_settings_game.station.never_expire_airports) return true;
 116         return _cur_year <= this->max_year;
 117 }
 118
 119 /**
 120  * This function initializes the airportspec array.
 121  */
 122 void AirportSpec::ResetAirports()
 123 {
 124         extern const AirportSpec _origin_airport_specs[];
 125         memset(&AirportSpec::specs, 0, sizeof(AirportSpec::specs));
 126         memcpy(&AirportSpec::specs, &_origin_airport_specs, sizeof(AirportSpec) * NEW_AIRPORT_OFFSET);
 127
 128         _airport_mngr.ResetOverride();
 129 }
 130
 131 /**
 132  * Tie all airportspecs to their class.
 133  */
 134 void BindAirportSpecs()
 135 {
 136         for (int i = 0; i < NUM_AIRPORTS; i++) {
 137                 AirportSpec *as = AirportSpec::GetWithoutOverride(i);
 138                 if (as->enabled) AirportClass::Assign(as);
 139         }
 140 }
 141
 142
 143 void AirportOverrideManager::SetEntitySpec(AirportSpec *as)
 144 {
 145         byte airport_id = this->AddEntityID(as->grf_prop.local_id, as->grf_prop.grffile->grfid, as->grf_prop.subst_id);
 146
 147         if (airport_id == invalid_ID) {
 148                 grfmsg(1, "Airport.SetEntitySpec: Too many airports allocated. Ignoring.");
 149                 return;
 150         }
 151
 152         memcpy(AirportSpec::GetWithoutOverride(airport_id), as, sizeof(*as));
 153
 154         /* Now add the overrides. */
 155         for (int i = 0; i < max_offset; i++) {
 156                 AirportSpec *overridden_as = AirportSpec::GetWithoutOverride(i);
 157
 158                 if (entity_overrides[i] != as->grf_prop.local_id || grfid_overrides[i] != as->grf_prop.grffile->grfid) continue;
 159
 160                 overridden_as->grf_prop.override = airport_id;
 161                 overridden_as->enabled = false;
 162                 entity_overrides[i] = invalid_ID;
 163                 grfid_overrides[i] = 0;
 164         }
 165 }
 166
 167 /* virtual */ uint32 AirportScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
 168 {
 169         switch (variable) {
 170                 case 0x40: return this->layout;
 171         }
 172
 173         if (this->st == NULL) {
 174                 *available = false;
 175                 return UINT_MAX;
 176         }
 177
 178         switch (variable) {
 179                 /* Get a variable from the persistent storage */
 180                 case 0x7C: return (this->st->airport.psa != NULL) ? this->st->airport.psa->GetValue(parameter) : 0;
 181
 182                 case 0xF0: return this->st->facilities;
 183                 case 0xFA: return Clamp(this->st->build_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535);
 184         }
 185
 186         return this->st->GetNewGRFVariable(this->ro, variable, parameter, available);
 187 }
 188
 189 /* virtual */ const SpriteGroup *AirportResolverObject::ResolveReal(const RealSpriteGroup *group) const
 190 {
 191         /* Airport action 2s should always have only 1 "loaded" state, but some
 192          * times things don't follow the spec... */
 193         if (group->num_loaded > 0) return group->loaded[0];
 194         if (group->num_loading > 0) return group->loading[0];
 195
 196         return NULL;
 197 }
 198
 199 /* virtual */ uint32 AirportScopeResolver::GetRandomBits() const
 200 {
 201         return this->st == NULL ? 0 : this->st->random_bits;
 202 }
 203
 204 /**
 205  * Store a value into the object's persistent storage.
 206  * @param object Object that we want to query.
 207  * @param pos Position in the persistent storage to use.
 208  * @param value Value to store.
 209  */
 210 /* virtual */ void AirportScopeResolver::StorePSA(uint pos, int32 value)
 211 {
 212         if (this->st == NULL) return;
 213
 214         if (this->st->airport.psa == NULL) {
 215                 /* There is no need to create a storage if the value is zero. */
 216                 if (value == 0) return;
 217
 218                 /* Create storage on first modification. */
 219                 uint32 grfid = (this->ro.grffile != NULL) ? this->ro.grffile->grfid : 0;
 220                 assert(PersistentStorage::CanAllocateItem());
 221                 this->st->airport.psa = new PersistentStorage(grfid, GSF_AIRPORTS, this->st->airport.tile);
 222         }
 223         this->st->airport.psa->StoreValue(pos, value);
 224 }
 225
 226 /**
 227  * Constructor of the airport resolver.
 228  * @param tile %Tile for the callback, only valid for airporttile callbacks.
 229  * @param st %Station of the airport for which the callback is run, or \c NULL for build gui.
 230  * @param airport_id Type of airport for which the callback is run.
 231  * @param layout Layout of the airport to build.
 232  * @param callback Callback ID.
 233  * @param param1 First parameter (var 10) of the callback.
 234  * @param param2 Second parameter (var 18) of the callback.
 235  */
 236 AirportResolverObject::AirportResolverObject(TileIndex tile, Station *st, byte airport_id, byte layout,
 237                 CallbackID callback, uint32 param1, uint32 param2)
 238         : ResolverObject(AirportSpec::Get(airport_id)->grf_prop.grffile, callback, param1, param2), airport_scope(*this, tile, st, airport_id, layout)
 239 {
 240 }
 241
 242 /**
 243  * Constructor of the scope resolver for an airport.
 244  * @param ro Surrounding resolver.
 245  * @param tile %Tile for the callback, only valid for airporttile callbacks.
 246  * @param st %Station of the airport for which the callback is run, or \c NULL for build gui.
 247  * @param airport_id Type of airport for which the callback is run.
 248  * @param layout Layout of the airport to build.
 249  */
 250 AirportScopeResolver::AirportScopeResolver(ResolverObject &ro, TileIndex tile, Station *st, byte airport_id, byte layout) : ScopeResolver(ro)
 251 {
 252         this->st = st;
 253         this->airport_id = airport_id;
 254         this->layout = layout;
 255         this->tile = tile;
 256 }
 257
 258 SpriteID GetCustomAirportSprite(const AirportSpec *as, byte layout)
 259 {
 260         AirportResolverObject object(INVALID_TILE, NULL, as->GetIndex(), layout);
 261         const SpriteGroup *group = SpriteGroup::Resolve(as->grf_prop.spritegroup[0], object);
 262         if (group == NULL) return as->preview_sprite;
 263
 264         return group->GetResult();
 265 }
 266
 267 uint16 GetAirportCallback(CallbackID callback, uint32 param1, uint32 param2, Station *st, TileIndex tile)
 268 {
 269         AirportResolverObject object(tile, st, st->airport.type, st->airport.layout, callback, param1, param2);
 270         const SpriteGroup *group = SpriteGroup::Resolve(st->airport.GetSpec()->grf_prop.spritegroup[0], object);
 271         if (group == NULL) return CALLBACK_FAILED;
 272
 273         return group->GetCallbackResult();
 274 }
 275
 276 /**
 277  * Get a custom text for the airport.
 278  * @param as The airport type's specification.
 279  * @param layout The layout index.
 280  * @param callback The callback to call.
 281  * @return The custom text.
 282  */
 283 StringID GetAirportTextCallback(const AirportSpec *as, byte layout, uint16 callback)
 284 {
 285         AirportResolverObject object(INVALID_TILE, NULL, as->GetIndex(), layout, (CallbackID)callback);
 286         const SpriteGroup *group = SpriteGroup::Resolve(as->grf_prop.spritegroup[0], object);
 287         uint16 cb_res = (group != NULL) ? group->GetCallbackResult() : CALLBACK_FAILED;
 288         if (cb_res == CALLBACK_FAILED || cb_res == 0x400) return STR_UNDEFINED;
 289         if (cb_res > 0x400) {
 290                 ErrorUnknownCallbackResult(as->grf_prop.grffile->grfid, callback, cb_res);
 291                 return STR_UNDEFINED;
 292         }
 293
 294         return GetGRFStringID(as->grf_prop.grffile->grfid, 0xD000 + cb_res);
 295 }