1

/* $Id$ */

     2

     3

#ifndef AIRPORT_H

     4

#define AIRPORT_H

     5

     6

enum {MAX_TERMINALS =  10};

     7

enum {MAX_HELIPADS  =   4};

     8

enum {MAX_ELEMENTS  = 255};

     9

enum {MAX_HEADINGS  =  22};

    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_COMMUTER      =  5,

    19

	AT_HELIDEPOT     =  6,

    20

	AT_INTERCON      =  7,

    21

	AT_HELISTATION   =  8,

    22

	AT_OILRIG        = 15

    23

};

    24

    25

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

    26

enum {

    27

	AIRCRAFT_ONLY    = 0,

    28

	ALL              = 1,

    29

	HELICOPTERS_ONLY = 2,

    30

};

    31

    32

enum {

    33

	AMED_NOSPDCLAMP = 1 << 0,

    34

	AMED_TAKEOFF    = 1 << 1,

    35

	AMED_SLOWTURN   = 1 << 2,

    36

	AMED_LAND       = 1 << 3,

    37

	AMED_EXACTPOS   = 1 << 4,

    38

	AMED_BRAKE      = 1 << 5,

    39

	AMED_HELI_RAISE = 1 << 6,

    40

	AMED_HELI_LOWER = 1 << 7,

    41

};

    42

    43

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

    44

enum {

    45

	TO_ALL         =  0,

    46

	HANGAR         =  1,

    47

	TERM1          =  2,

    48

	TERM2          =  3,

    49

	TERM3          =  4,

    50

	TERM4          =  5,

    51

	TERM5          =  6,

    52

	TERM6          =  7,

    53

	HELIPAD1       =  8,

    54

	HELIPAD2       =  9,

    55

	TAKEOFF        = 10,

    56

	STARTTAKEOFF   = 11,

    57

	ENDTAKEOFF     = 12,

    58

	HELITAKEOFF    = 13,

    59

	FLYING         = 14,

    60

	LANDING        = 15,

    61

	ENDLANDING     = 16,

    62

	HELILANDING    = 17,

    63

	HELIENDLANDING = 18,

    64

	TERM7          = 19,

    65

	TERM8          = 20,

    66

	HELIPAD3       = 21,

    67

	HELIPAD4       = 22

    68

};

    69

    70

// this maps the terminal to its corresponding state and block flag

    71

// currently set for 10 terms, 4 helipads

    72

static const byte _airport_terminal_state[] = {2, 3, 4, 5, 6, 7, 19, 20, 0, 0, 8, 9, 21, 22};

    73

static const byte _airport_terminal_flag[] =  {0, 1, 2, 3, 4, 5, 22, 23, 0, 0, 6, 7, 24, 25};

    74

    75

/* Movement Blocks on Airports */

    76

// blocks (eg_airport_flags)

    77

enum {

    78

	TERM1_block              = 1 <<  0,

    79

	TERM2_block              = 1 <<  1,

    80

	TERM3_block              = 1 <<  2,

    81

	TERM4_block              = 1 <<  3,

    82

	TERM5_block              = 1 <<  4,

    83

	TERM6_block              = 1 <<  5,

    84

	HELIPAD1_block           = 1 <<  6,

    85

	HELIPAD2_block           = 1 <<  7,

    86

	RUNWAY_IN_OUT_block      = 1 <<  8,

    87

	RUNWAY_IN_block          = 1 <<  8,

    88

	AIRPORT_BUSY_block       = 1 <<  8,

    89

	RUNWAY_OUT_block         = 1 <<  9,

    90

	TAXIWAY_BUSY_block       = 1 << 10,

    91

	OUT_WAY_block            = 1 << 11,

    92

	IN_WAY_block             = 1 << 12,

    93

	AIRPORT_ENTRANCE_block   = 1 << 13,

    94

	TERM_GROUP1_block        = 1 << 14,

    95

	TERM_GROUP2_block        = 1 << 15,

    96

	HANGAR2_AREA_block       = 1 << 16,

    97

	TERM_GROUP2_ENTER1_block = 1 << 17,

    98

	TERM_GROUP2_ENTER2_block = 1 << 18,

    99

	TERM_GROUP2_EXIT1_block  = 1 << 19,

   100

	TERM_GROUP2_EXIT2_block  = 1 << 20,

   101

	PRE_HELIPAD_block        = 1 << 21,

   102

   103

// blocks for new airports

   104

	TERM7_block              = 1 << 22,

   105

	TERM8_block              = 1 << 23,

   106

	TERM9_block              = 1 << 24,

   107

	HELIPAD3_block           = 1 << 24,

   108

	TERM10_block             = 1 << 25,

   109

	HELIPAD4_block           = 1 << 25,

   110

	HANGAR1_AREA_block       = 1 << 26,

   111

	OUT_WAY2_block           = 1 << 27,

   112

	IN_WAY2_block            = 1 << 28,

   113

	RUNWAY_IN2_block         = 1 << 29,

   114

	RUNWAY_OUT2_block        = 1 << 10,   // note re-uses TAXIWAY_BUSY

   115

	HELIPAD_GROUP_block      = 1 << 13,   // note re-uses AIRPORT_ENTRANCE

   116

	OUT_WAY_block2           = 1 << 31,

   117

// end of new blocks

   118

   119

	NOTHING_block            = 1 << 30

   120

};

   121

   122

typedef struct AirportMovingData {

   123

	int x,y;

   124

	byte flag;

   125

	byte direction;

   126

} AirportMovingData;

   127

   128

// Finite sTate mAchine --> FTA

   129

typedef struct AirportFTAClass {

   130

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

   131

	const byte *terminals;

   132

	const byte *helipads;

   133

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

   134

	byte acc_planes;                      // accept airplanes or helicopters or both

   135

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

   136

	byte nof_depots;                      // number of depots this airport has

   137

	struct AirportFTA *layout;            // state machine for airport

   138

	byte size_x;

   139

	byte size_y;

   140

} AirportFTAClass;

   141

   142

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

   143

typedef struct AirportFTA {

   144

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

   145

	byte next_position;      // next position from this position

   146

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

   147

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

   148

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

   149

} AirportFTA;

   150

   151

void InitializeAirports(void);

   152

void UnInitializeAirports(void);

   153

const AirportFTAClass *GetAirport(const byte airport_type);

   154

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

   155

   156

/** Get buildable airport bitmask.

   157

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

   158

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

   159

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

   160

 */

   161

uint32 GetValidAirports(void);

   162

   163

#endif /* AIRPORT_H */