src/newgrf_airport.h

   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.h NewGRF handling of airports. */
  11
  12 #ifndef NEWGRF_AIRPORT_H
  13 #define NEWGRF_AIRPORT_H
  14
  15 #include "airport.h"
  16 #include "date_type.h"
  17 #include "newgrf_class.h"
  18 #include "newgrf_commons.h"
  19 #include "map/tilearea.h"
  20
  21 /** Copy from tile/station.h */
  22 typedef byte StationGfx;
  23
  24 /** Tile-offset / AirportTileID pair. */
  25 struct AirportTileTable {
  26         CoordDiff ti;      ///< Tile offset from  the top-most airport tile.
  27         StationGfx gfx;    ///< AirportTile to use for this tile.
  28 };
  29
  30 /** Iterator to iterate over all tiles belonging to an airport spec. */
  31 class AirportTileTableIterator : public TileIterator {
  32 private:
  33         const AirportTileTable *att; ///< The offsets.
  34         TileIndex base_tile;         ///< The tile we base the offsets off.
  35
  36 protected:
  37         inline void Next() OVERRIDE
  38         {
  39                 this->att++;
  40                 if (this->att->ti.x == -0x80) {
  41                         this->tile = INVALID_TILE;
  42                 } else {
  43                         this->tile = this->base_tile + ToTileIndexDiff(this->att->ti);
  44                 }
  45         }
  46
  47 public:
  48         /**
  49          * Construct the iterator.
  50          * @param att The TileTable we want to iterate over.
  51          * @param base_tile The basetile for all offsets.
  52          */
  53         AirportTileTableIterator(const AirportTileTable *att, TileIndex base_tile) : TileIterator(base_tile + ToTileIndexDiff(att->ti)), att(att), base_tile(base_tile)
  54         {
  55         }
  56
  57         /** Get the StationGfx for the current tile. */
  58         StationGfx GetStationGfx() const
  59         {
  60                 return this->att->gfx;
  61         }
  62 };
  63
  64 /** List of default airport classes. */
  65 enum AirportClassID {
  66         APC_BEGIN     = 0,  ///< Lowest valid airport class id
  67         APC_SMALL     = 0,  ///< id for small airports class
  68         APC_LARGE,          ///< id for large airports class
  69         APC_HUB,            ///< id for hub airports class
  70         APC_HELIPORT,       ///< id for heliports
  71         APC_MAX       = 16, ///< maximum number of airport classes
  72 };
  73
  74 /** Allow incrementing of AirportClassID variables */
  75 DECLARE_POSTFIX_INCREMENT(AirportClassID)
  76
  77 /** TTDP airport types. Used to map our types to TTDPatch's */
  78 enum TTDPAirportType {
  79         ATP_TTDP_SMALL,    ///< Same as AT_SMALL
  80         ATP_TTDP_LARGE,    ///< Same as AT_LARGE
  81         ATP_TTDP_HELIPORT, ///< Same as AT_HELIPORT
  82         ATP_TTDP_OILRIG,   ///< Same as AT_OILRIG
  83 };
  84
  85 /** A list of all hangar tiles in an airport */
  86 struct HangarTileTable {
  87         CoordDiff ti;      ///< Tile offset from the top-most airport tile.
  88         Direction dir;     ///< Direction of the exit.
  89         byte hangar_num;   ///< The hangar to which this tile belongs.
  90 };
  91
  92 /**
  93  * Defines the data structure for an airport.
  94  */
  95 struct AirportSpec {
  96         const struct AirportFTAClass *fsm;     ///< the finite statemachine for the default airports
  97         const AirportTileTable * const *table; ///< list of the tiles composing the airport
  98         Direction *rotation;                   ///< the rotation of each tiletable
  99         byte num_table;                        ///< number of elements in the table
 100         const HangarTileTable *depot_table;    ///< gives the position of the depots on the airports
 101         byte nof_depots;                       ///< the number of hangar tiles in this airport
 102         byte size_x;                           ///< size of airport in x direction
 103         byte size_y;                           ///< size of airport in y direction
 104         byte noise_level;                      ///< noise that this airport generates
 105         byte catchment;                        ///< catchment area of this airport
 106         Year min_year;                         ///< first year the airport is available
 107         Year max_year;                         ///< last year the airport is available
 108         StringID name;                         ///< name of this airport
 109         TTDPAirportType ttd_airport_type;      ///< ttdpatch airport type (Small/Large/Helipad/Oilrig)
 110         AirportClassID cls_id;                 ///< the class to which this airport type belongs
 111         SpriteID preview_sprite;               ///< preview sprite for this airport
 112         uint16 maintenance_cost;               ///< maintenance cost multiplier
 113         /* Newgrf data */
 114         bool enabled;                          ///< Entity still available (by default true). Newgrf can disable it, though.
 115         struct GRFFileProps grf_prop;          ///< Properties related to the grf file.
 116
 117         static const AirportSpec *Get(byte type);
 118         static AirportSpec *GetWithoutOverride(byte type);
 119
 120         bool IsAvailable() const;
 121
 122         static void ResetAirports();
 123
 124         /** Get the index of this spec. */
 125         byte GetIndex() const
 126         {
 127                 assert(this >= specs && this < endof(specs));
 128                 return (byte)(this - specs);
 129         }
 130
 131         static AirportSpec dummy; ///< The dummy airport.
 132
 133 private:
 134         static AirportSpec specs[NUM_AIRPORTS]; ///< Specs of the airports.
 135 };
 136
 137 /** Information related to airport classes. */
 138 typedef NewGRFClass<AirportSpec, AirportClassID, APC_MAX> AirportClass;
 139
 140 void BindAirportSpecs();
 141
 142 StringID GetAirportTextCallback(const AirportSpec *as, byte layout, uint16 callback);
 143
 144 #endif /* NEWGRF_AIRPORT_H */