1

/* $Id$ */

     2

     3

#ifndef AIRPORT_H

     4

#define AIRPORT_H

     5

     6

enum {MAX_TERMINALS = 6};

     7

enum {MAX_HELIPADS  = 2};

     8

enum {MAX_ELEMENTS  = 255};

     9

enum {MAX_HEADINGS  = 18};

    10

    11

// Airport types

    12

enum {

    13

	AT_SMALL         = 0,

    14

	AT_LARGE         = 1,

    15

	AT_HELIPORT      = 2,

    16

	AT_METROPOLITAN  = 3,

    17

	AT_INTERNATIONAL = 4,

    18

	AT_OILRIG        = 15,

    19

};

    20

    21

// do not change unless you change v->subtype too. This aligns perfectly with its current setting

    22

enum {

    23

	AIRCRAFT_ONLY    = 0,

    24

	ALL              = 1,

    25

	HELICOPTERS_ONLY = 2,

    26

};

    27

    28

enum {

    29

	AMED_NOSPDCLAMP = 1<<0,

    30

	AMED_TAKEOFF    = 1<<1,

    31

	AMED_SLOWTURN   = 1<<2,

    32

	AMED_LAND       = 1<<3,

    33

	AMED_EXACTPOS   = 1<<4,

    34

	AMED_BRAKE      = 1<<5,

    35

	AMED_HELI_RAISE = 1<<6,

    36

	AMED_HELI_LOWER = 1<<7,

    37

};

    38

    39

/* Movement States on Airports (headings target) */

    40

enum {

    41

	TO_ALL,

    42

	HANGAR,

    43

	TERM1,

    44

	TERM2,

    45

	TERM3,

    46

	TERM4,

    47

	TERM5,

    48

	TERM6,

    49

	HELIPAD1,

    50

	HELIPAD2,

    51

	TAKEOFF,

    52

	STARTTAKEOFF,

    53

	ENDTAKEOFF,

    54

	HELITAKEOFF,

    55

	FLYING,

    56

	LANDING,

    57

	ENDLANDING,

    58

	HELILANDING,

    59

	HELIENDLANDING,

    60

};

    61

    62

/* Movement Blocks on Airports */

    63

// blocks (eg_airport_flags)

    64

enum {

    65

	TERM1_block              = 1 << 0,

    66

	TERM2_block              = 1 << 1,

    67

	TERM3_block              = 1 << 2,

    68

	TERM4_block              = 1 << 3,

    69

	TERM5_block              = 1 << 4,

    70

	TERM6_block              = 1 << 5,

    71

	HELIPAD1_block           = 1 << 6,

    72

	HELIPAD2_block           = 1 << 7,

    73

	RUNWAY_IN_OUT_block      = 1 << 8,

    74

	RUNWAY_IN_block          = 1 << 8,

    75

	AIRPORT_BUSY_block       = 1 << 8,

    76

	RUNWAY_OUT_block         = 1 << 9,

    77

	TAXIWAY_BUSY_block       = 1 << 10,

    78

	OUT_WAY_block            = 1 << 11,

    79

	IN_WAY_block             = 1 << 12,

    80

	AIRPORT_ENTRANCE_block   = 1 << 13,

    81

	TERM_GROUP1_block        = 1 << 14,

    82

	TERM_GROUP2_block        = 1 << 15,

    83

	HANGAR2_AREA_block       = 1 << 16,

    84

	TERM_GROUP2_ENTER1_block = 1 << 17,

    85

	TERM_GROUP2_ENTER2_block = 1 << 18,

    86

	TERM_GROUP2_EXIT1_block  = 1 << 19,

    87

	TERM_GROUP2_EXIT2_block  = 1 << 20,

    88

	PRE_HELIPAD_block        = 1 << 21,

    89

	NOTHING_block            = 1 << 30,

    90

};

    91

    92

typedef struct AirportMovingData {

    93

	int x,y;

    94

	byte flag;

    95

	byte direction;

    96

} AirportMovingData;

    97

    98

// Finite sTate mAchine --> FTA

    99

typedef struct AirportFTAClass {

   100

	byte nofelements;                     // number of positions the airport consists of

   101

	const byte *terminals;

   102

	const byte *helipads;

   103

	byte entry_point;                     // when an airplane arrives at this airport, enter it at position entry_point

   104

	byte acc_planes;                      // accept airplanes or helicopters or both

   105

	const TileIndexDiffC *airport_depots; // gives the position of the depots on the airports

   106

	byte nof_depots;                      // number of depots this airport has

   107

	struct AirportFTA *layout;            // state machine for airport

   108

} AirportFTAClass;

   109

   110

// internal structure used in openttd - Finite sTate mAchine --> FTA

   111

typedef struct AirportFTA {

   112

	byte position;                    // the position that an airplane is at

   113

	byte next_position;               // next position from this position

   114

	uint32 block;                     // 32 bit blocks (st->airport_flags), should be enough for the most complex airports

   115

	byte heading;                     // heading (current orders), guiding an airplane to its target on an airport

   116

	struct AirportFTA *next_in_chain; // possible extra movement choices from this position

   117

} AirportFTA;

   118

   119

void InitializeAirports(void);

   120

void UnInitializeAirports(void);

   121

const AirportFTAClass* GetAirport(const byte airport_type);

   122

const AirportMovingData *GetAirportMovingData(byte airport_type, byte position);

   123

   124

/** Get buildable airport bitmask.

   125

 * @return get all buildable airports at this given time, bitmasked.

   126

 * Bit 0 means the small airport is buildable, etc.

   127

 * @todo set availability of airports by year, instead of airplane

   128

 */

   129

uint32 GetValidAirports(void);

   130

   131

#endif /* AIRPORT_H */