src/newgrf_airporttiles.h

   1 /* $Id: newgrf_airporttiles.h 26085 2013-11-24 14:41:19Z 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
  10 /** @file newgrf_airporttiles.h NewGRF handling of airport tiles. */
  11
  12 #ifndef NEWGRF_AIRPORTTILES_H
  13 #define NEWGRF_AIRPORTTILES_H
  14
  15 #include "airport.h"
  16 #include "station_map.h"
  17 #include "newgrf_animation_type.h"
  18 #include "newgrf_commons.h"
  19 #include "newgrf_spritegroup.h"
  20 #include "station_base.h"
  21
  22 /** Scope resolver for handling the tiles of an airport. */
  23 struct AirportTileScopeResolver : public ScopeResolver {
  24         struct Station *st;  ///< %Station of the airport for which the callback is run, or \c nullptr for build gui.
  25         byte airport_id;     ///< Type of airport for which the callback is run.
  26         TileIndex tile;      ///< Tile for the callback, only valid for airporttile callbacks.
  27
  28         /**
  29          * Constructor of the scope resolver specific for airport tiles.
  30          * @param ats Specification of the airport tiles.
  31          * @param tile %Tile for the callback, only valid for airporttile callbacks.
  32          * @param st Station of the airport for which the callback is run, or \c nullptr for build gui.
  33          */
  34         AirportTileScopeResolver(ResolverObject &ro, const AirportTileSpec *ats, TileIndex tile, Station *st)
  35                 : ScopeResolver(ro), st(st), tile(tile)
  36         {
  37                 assert(st != nullptr);
  38                 this->airport_id = st->airport.type;
  39         }
  40
  41         /* virtual */ uint32 GetRandomBits() const;
  42         /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
  43 };
  44
  45 /** Resolver for tiles of an airport. */
  46 struct AirportTileResolverObject : public ResolverObject {
  47         AirportTileScopeResolver tiles_scope; ///< Scope resolver for the tiles.
  48
  49         AirportTileResolverObject(const AirportTileSpec *ats, TileIndex tile, Station *st,
  50                         CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
  51
  52         /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
  53         {
  54                 switch (scope) {
  55                         case VSG_SCOPE_SELF: return &tiles_scope;
  56                         default: return ResolverObject::GetScope(scope, relative);
  57                 }
  58         }
  59 };
  60
  61 /**
  62  * Defines the data structure of each individual tile of an airport.
  63  */
  64 struct AirportTileSpec {
  65         AnimationInfo animation;              ///< Information about the animation.
  66         StringID name;                        ///< Tile Subname string, land information on this tile will give you "AirportName (TileSubname)"
  67         uint8 callback_mask;                  ///< Bitmask telling which grf callback is set
  68         uint8 animation_special_flags;        ///< Extra flags to influence the animation
  69         bool enabled;                         ///< entity still available (by default true). newgrf can disable it, though
  70         GRFFileProps grf_prop;                ///< properties related the the grf file
  71
  72         static const AirportTileSpec *Get(StationGfx gfx);
  73         static const AirportTileSpec *GetByTile(TileIndex tile);
  74
  75         static void ResetAirportTiles();
  76
  77 private:
  78         static AirportTileSpec tiles[NUM_AIRPORTTILES];
  79
  80         friend void AirportTileOverrideManager::SetEntitySpec(const AirportTileSpec *airpts);
  81 };
  82
  83 StationGfx GetTranslatedAirportTileID(StationGfx gfx);
  84 void AnimateAirportTile(TileIndex tile);
  85 void AirportTileAnimationTrigger(Station *st, TileIndex tile, AirpAnimationTrigger trigger, CargoID cargo_type = CT_INVALID);
  86 void AirportAnimationTrigger(Station *st, AirpAnimationTrigger trigger, CargoID cargo_type = CT_INVALID);
  87 bool DrawNewAirportTile(TileInfo *ti, Station *st, StationGfx gfx, const AirportTileSpec *airts);
  88
  89 #endif /* NEWGRF_AIRPORTTILES_H */