2010-02-22 17:09:26 +01:00
|
|
|
/* $Id$ */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is part of OpenTTD.
|
|
|
|
* 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.
|
|
|
|
* 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.
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** @file newgrf_airport.h NewGRF handling of airports. */
|
|
|
|
|
|
|
|
#ifndef NEWGRF_AIRPORT_H
|
|
|
|
#define NEWGRF_AIRPORT_H
|
|
|
|
|
2010-08-27 00:01:16 +02:00
|
|
|
#include "airport.h"
|
2010-02-22 17:09:26 +01:00
|
|
|
#include "date_type.h"
|
|
|
|
#include "map_type.h"
|
2010-08-08 00:08:20 +02:00
|
|
|
#include "newgrf_class.h"
|
2010-03-19 00:12:38 +01:00
|
|
|
#include "newgrf_commons.h"
|
2010-08-05 14:03:34 +02:00
|
|
|
#include "gfx_type.h"
|
2010-02-22 17:09:26 +01:00
|
|
|
|
2011-05-02 18:14:23 +02:00
|
|
|
/** Copy from station_map.h */
|
2010-02-22 17:09:26 +01:00
|
|
|
typedef byte StationGfx;
|
|
|
|
|
2010-08-03 01:09:38 +02:00
|
|
|
/** Tile-offset / AirportTileID pair. */
|
2010-02-22 17:09:26 +01:00
|
|
|
struct AirportTileTable {
|
2010-08-03 01:09:38 +02:00
|
|
|
TileIndexDiffC ti; ///< Tile offset from the top-most airport tile.
|
|
|
|
StationGfx gfx; ///< AirportTile to use for this tile.
|
2010-02-22 17:09:26 +01:00
|
|
|
};
|
|
|
|
|
2010-03-06 00:21:35 +01:00
|
|
|
/** List of default airport classes. */
|
|
|
|
enum AirportClassID {
|
|
|
|
APC_BEGIN = 0, ///< Lowest valid airport class id
|
|
|
|
APC_SMALL = 0, ///< id for small airports class
|
|
|
|
APC_LARGE, ///< id for large airports class
|
|
|
|
APC_HUB, ///< id for hub airports class
|
|
|
|
APC_HELIPORT, ///< id for heliports
|
|
|
|
APC_MAX = 16, ///< maximum number of airport classes
|
|
|
|
};
|
|
|
|
|
|
|
|
/** Allow incrementing of AirportClassID variables */
|
2010-03-23 23:25:43 +01:00
|
|
|
DECLARE_POSTFIX_INCREMENT(AirportClassID)
|
2010-03-06 00:21:35 +01:00
|
|
|
|
2010-03-01 21:17:21 +01:00
|
|
|
/** TTDP airport types. Used to map our types to TTDPatch's */
|
2010-03-02 21:31:05 +01:00
|
|
|
enum TTDPAirportType {
|
2010-03-01 21:17:21 +01:00
|
|
|
ATP_TTDP_SMALL, ///< Same as AT_SMALL
|
|
|
|
ATP_TTDP_LARGE, ///< Same as AT_LARGE
|
|
|
|
ATP_TTDP_HELIPORT, ///< Same as AT_HELIPORT
|
|
|
|
ATP_TTDP_OILRIG, ///< Same as AT_OILRIG
|
|
|
|
};
|
|
|
|
|
2010-03-19 12:17:52 +01:00
|
|
|
/** A list of all hangar tiles in an airport */
|
|
|
|
struct HangarTileTable {
|
2010-08-03 01:09:38 +02:00
|
|
|
TileIndexDiffC ti; ///< Tile offset from the top-most airport tile.
|
2011-08-13 14:43:05 +02:00
|
|
|
Direction dir; ///< Direction of the exit.
|
2010-08-03 01:09:38 +02:00
|
|
|
byte hangar_num; ///< The hanger to which this tile belongs.
|
2010-03-19 12:17:52 +01:00
|
|
|
};
|
|
|
|
|
2010-02-22 17:09:26 +01:00
|
|
|
/**
|
|
|
|
* Defines the data structure for an airport.
|
|
|
|
*/
|
|
|
|
struct AirportSpec {
|
2010-03-06 16:38:13 +01:00
|
|
|
const struct AirportFTAClass *fsm; ///< the finite statemachine for the default airports
|
2010-02-22 17:09:26 +01:00
|
|
|
const AirportTileTable * const *table; ///< list of the tiles composing the airport
|
2010-08-05 14:00:09 +02:00
|
|
|
Direction *rotation; ///< the rotation of each tiletable
|
2010-03-06 17:02:07 +01:00
|
|
|
byte num_table; ///< number of elements in the table
|
2010-03-19 12:17:52 +01:00
|
|
|
const HangarTileTable *depot_table; ///< gives the position of the depots on the airports
|
|
|
|
byte nof_depots; ///< the number of hangar tiles in this airport
|
2010-02-22 17:09:26 +01:00
|
|
|
byte size_x; ///< size of airport in x direction
|
|
|
|
byte size_y; ///< size of airport in y direction
|
|
|
|
byte noise_level; ///< noise that this airport generates
|
|
|
|
byte catchment; ///< catchment area of this airport
|
|
|
|
Year min_year; ///< first year the airport is available
|
|
|
|
Year max_year; ///< last year the airport is available
|
2010-03-06 00:21:41 +01:00
|
|
|
StringID name; ///< name of this airport
|
2010-03-02 21:31:05 +01:00
|
|
|
TTDPAirportType ttd_airport_type; ///< ttdpatch airport type (Small/Large/Helipad/Oilrig)
|
2010-08-07 23:10:57 +02:00
|
|
|
AirportClassID cls_id; ///< the class to which this airport type belongs
|
2010-08-05 14:03:34 +02:00
|
|
|
SpriteID preview_sprite; ///< preview sprite for this airport
|
2010-03-06 00:21:51 +01:00
|
|
|
/* Newgrf data */
|
|
|
|
bool enabled; ///< entity still avaible (by default true).newgrf can disable it, though
|
2010-08-07 22:51:07 +02:00
|
|
|
struct GRFFileProps grf_prop; ///< properties related the the grf file
|
2010-02-22 17:09:26 +01:00
|
|
|
|
|
|
|
static const AirportSpec *Get(byte type);
|
2010-03-06 00:21:30 +01:00
|
|
|
static AirportSpec *GetWithoutOverride(byte type);
|
2010-02-22 17:09:26 +01:00
|
|
|
|
|
|
|
bool IsAvailable() const;
|
|
|
|
|
2010-03-06 00:21:23 +01:00
|
|
|
static void ResetAirports();
|
|
|
|
|
2010-03-06 00:21:56 +01:00
|
|
|
/** Get the index of this spec. */
|
|
|
|
byte GetIndex() const
|
|
|
|
{
|
|
|
|
assert(this >= specs && this < endof(specs));
|
|
|
|
return (byte)(this - specs);
|
|
|
|
}
|
|
|
|
|
2011-05-02 18:14:23 +02:00
|
|
|
static AirportSpec dummy; ///< The dummy airport.
|
2010-03-06 00:21:23 +01:00
|
|
|
|
|
|
|
private:
|
2011-05-02 18:14:23 +02:00
|
|
|
static AirportSpec specs[NUM_AIRPORTS]; ///< Specs of the airports.
|
2010-02-22 17:09:26 +01:00
|
|
|
};
|
|
|
|
|
2010-03-06 00:21:35 +01:00
|
|
|
/** Information related to airport classes. */
|
2010-08-08 00:08:20 +02:00
|
|
|
typedef NewGRFClass<AirportSpec, AirportClassID, APC_MAX> AirportClass;
|
2010-03-06 00:21:35 +01:00
|
|
|
|
|
|
|
void BindAirportSpecs();
|
2010-02-22 17:09:26 +01:00
|
|
|
|
2010-08-05 14:04:33 +02:00
|
|
|
StringID GetAirportTextCallback(const AirportSpec *as, byte layout, uint16 callback);
|
|
|
|
|
2010-02-22 17:09:26 +01:00
|
|
|
#endif /* NEWGRF_AIRPORT_H */
|