1

/* $Id$ */

     2

     3

#ifndef STATION_H

     4

#define STATION_H

     5

     6

#include "player.h"

     7

#include "pool.h"

     8

#include "sprite.h"

     9

#include "tile.h"

    10

#include "vehicle.h"

    11

#include "station_newgrf.h"

    12

    13

typedef struct GoodsEntry {

    14

	uint16 waiting_acceptance;

    15

	byte days_since_pickup;

    16

	byte rating;

    17

	uint16 enroute_from;

    18

	byte enroute_time;

    19

	byte last_speed;

    20

	byte last_age;

    21

	int32 feeder_profit;

    22

} GoodsEntry;

    23

    24

typedef enum RoadStopType {

    25

	RS_BUS,

    26

	RS_TRUCK

    27

} RoadStopType;

    28

    29

enum {

    30

	INVALID_STATION = 0xFFFF,

    31

	INVALID_SLOT = 0xFFFF,

    32

	NUM_SLOTS = 2,

    33

	ROAD_STOP_LIMIT = 8,

    34

};

    35

    36

typedef uint16 StationID;

    37

    38

typedef struct RoadStop {

    39

	TileIndex xy;

    40

	bool used;

    41

	byte status;

    42

	uint32 index;

    43

	uint16 slot[NUM_SLOTS];

    44

	StationID station;

    45

	uint8 type;

    46

	struct RoadStop *next;

    47

	struct RoadStop *prev;

    48

} RoadStop;

    49

    50

struct Station {

    51

	TileIndex xy;

    52

	RoadStop *bus_stops;

    53

	RoadStop *truck_stops;

    54

	TileIndex train_tile;

    55

	TileIndex airport_tile;

    56

	TileIndex dock_tile;

    57

	Town *town;

    58

	uint16 string_id;

    59

    60

	ViewportSign sign;

    61

    62

	uint16 had_vehicle_of_type;

    63

    64

	byte time_since_load;

    65

	byte time_since_unload;

    66

	byte delete_ctr;

    67

	PlayerID owner;

    68

	byte facilities;

    69

	byte airport_type;

    70

    71

	// trainstation width/height

    72

	byte trainst_w, trainst_h;

    73

    74

	byte class_id; // custom graphics station class

    75

	byte stat_id; // custom graphics station id in the @class_id class

    76

	uint16 build_date;

    77

    78

	//uint16 airport_flags;

    79

	uint32 airport_flags;

    80

	StationID index;

    81

    82

	VehicleID last_vehicle;

    83

	GoodsEntry goods[NUM_CARGO];

    84

    85

	/* Stuff that is no longer used, but needed for conversion */

    86

	TileIndex bus_tile_obsolete;

    87

	TileIndex lorry_tile_obsolete;

    88

    89

	byte truck_stop_status_obsolete;

    90

	byte bus_stop_status_obsolete;

    91

	byte blocked_months_obsolete;

    92

};

    93

    94

enum {

    95

	FACIL_TRAIN = 1,

    96

	FACIL_TRUCK_STOP = 2,

    97

	FACIL_BUS_STOP = 4,

    98

	FACIL_AIRPORT = 8,

    99

	FACIL_DOCK = 0x10,

   100

};

   101

   102

enum {

   103

//	HVOT_PENDING_DELETE = 1<<0, // not needed anymore

   104

	HVOT_TRAIN = 1<<1,

   105

	HVOT_BUS = 1 << 2,

   106

	HVOT_TRUCK = 1 << 3,

   107

	HVOT_AIRCRAFT = 1 << 4,

   108

	HVOT_SHIP = 1 << 5,

   109

	/* This bit is used to mark stations. No, it does not belong here, but what

   110

	 * can we do? ;-) */

   111

	HVOT_BUOY = 1 << 6

   112

};

   113

   114

enum {

   115

	CA_BUS = 3,

   116

	CA_TRUCK = 3,

   117

	CA_AIR_OILPAD = 3,

   118

	CA_TRAIN = 4,

   119

	CA_AIR_HELIPORT = 4,

   120

	CA_AIR_SMALL = 4,

   121

	CA_AIR_LARGE = 5,

   122

	CA_DOCK = 5,

   123

	CA_AIR_METRO = 6,

   124

	CA_AIR_INTER = 8,

   125

};

   126

   127

void ModifyStationRatingAround(TileIndex tile, PlayerID owner, int amount, uint radius);

   128

   129

TileIndex GetStationTileForVehicle(const Vehicle *v, const Station *st);

   130

   131

void ShowStationViewWindow(StationID station);

   132

void UpdateAllStationVirtCoord(void);

   133

   134

VARDEF SortStruct *_station_sort;

   135

   136

extern MemoryPool _station_pool;

   137

   138

/**

   139

 * Get the pointer to the station with index 'index'

   140

 */

   141

static inline Station *GetStation(StationID index)

   142

{

   143

	return (Station*)GetItemFromPool(&_station_pool, index);

   144

}

   145

   146

/**

   147

 * Get the current size of the StationPool

   148

 */

   149

static inline uint16 GetStationPoolSize(void)

   150

{

   151

	return _station_pool.total_items;

   152

}

   153

   154

static inline bool IsStationIndex(uint index)

   155

{

   156

	return index < GetStationPoolSize();

   157

}

   158

   159

#define FOR_ALL_STATIONS_FROM(st, start) for (st = GetStation(start); st != NULL; st = (st->index + 1 < GetStationPoolSize()) ? GetStation(st->index + 1) : NULL)

   160

#define FOR_ALL_STATIONS(st) FOR_ALL_STATIONS_FROM(st, 0)

   161

   162

   163

/* Stuff for ROADSTOPS */

   164

   165

extern MemoryPool _roadstop_pool;

   166

   167

/**

   168

 * Get the pointer to the roadstop with index 'index'

   169

 */

   170

static inline RoadStop *GetRoadStop(uint index)

   171

{

   172

	return (RoadStop*)GetItemFromPool(&_roadstop_pool, index);

   173

}

   174

   175

/**

   176

 * Get the current size of the RoadStoptPool

   177

 */

   178

static inline uint16 GetRoadStopPoolSize(void)

   179

{

   180

	return _roadstop_pool.total_items;

   181

}

   182

   183

#define FOR_ALL_ROADSTOPS_FROM(rs, start) for (rs = GetRoadStop(start); rs != NULL; rs = (rs->index + 1 < GetRoadStopPoolSize()) ? GetRoadStop(rs->index + 1) : NULL)

   184

#define FOR_ALL_ROADSTOPS(rs) FOR_ALL_ROADSTOPS_FROM(rs, 0)

   185

   186

/* End of stuff for ROADSTOPS */

   187

   188

   189

VARDEF bool _station_sort_dirty[MAX_PLAYERS];

   190

VARDEF bool _global_station_sort_dirty;

   191

   192

void GetProductionAroundTiles(AcceptedCargo produced, TileIndex tile, int w, int h, int rad);

   193

void GetAcceptanceAroundTiles(AcceptedCargo accepts, TileIndex tile, int w, int h, int rad);

   194

uint GetStationPlatforms(const Station *st, TileIndex tile);

   195

   196

   197

void StationPickerDrawSprite(int x, int y, RailType railtype, int image);

   198

   199

/* Get sprite offset for a given custom station and station structure (may be

   200

 * NULL if ctype is set - that means we are in a build dialog). The station

   201

 * structure is used for variational sprite groups. */

   202

uint32 GetCustomStationRelocation(const StationSpec *spec, const Station *st, byte ctype);

   203

   204

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStopType type);

   205

static inline RoadStopType GetRoadStopType(TileIndex tile)

   206

{

   207

	return (_m[tile].m5 < 0x47) ? RS_TRUCK : RS_BUS;

   208

}

   209

   210

RoadStop * GetPrimaryRoadStop(const Station *st, RoadStopType type);

   211

RoadStop * AllocateRoadStop( void );

   212

void ClearSlot(Vehicle *v, RoadStop *rs);

   213

   214

static inline bool IsTrainStationTile(TileIndex tile)

   215

{

   216

	return IsTileType(tile, MP_STATION) && IS_BYTE_INSIDE(_m[tile].m5, 0, 8);

   217

}

   218

   219

static inline bool IsCompatibleTrainStationTile(TileIndex tile, TileIndex ref)

   220

{

   221

	assert(IsTrainStationTile(ref));

   222

	return

   223

		IsTrainStationTile(tile) &&

   224

		GB(_m[tile].m3, 0, 4) == GB(_m[ref].m3, 0, 4) && // same rail type?

   225

		GB(_m[tile].m5, 0, 1) == GB(_m[ref].m5, 0, 1);   // same direction?

   226

}

   227

   228

static inline bool IsRoadStationTile(TileIndex tile) {

   229

	return IsTileType(tile, MP_STATION) && IS_BYTE_INSIDE(_m[tile].m5, 0x43, 0x4B);

   230

}

   231

   232

/**

   233

 * Check if a station really exists.

   234

 */

   235

static inline bool IsValidStation(const Station *st)

   236

{

   237

	return st->xy != 0; /* XXX: Replace by INVALID_TILE someday */

   238

}

   239

   240

static inline bool IsBuoy(const Station* st)

   241

{

   242

	return st->had_vehicle_of_type & HVOT_BUOY; /* XXX: We should really ditch this ugly coding and switch to something sane... */

   243

}

   244

   245

static inline bool IsBuoyTile(TileIndex tile)

   246

{

   247

	return IsTileType(tile, MP_STATION) && _m[tile].m5 == 0x52;

   248

}

   249

   250

/* Get's the direction the station exit points towards. Ie, returns 0 for a

   251

 * station with the exit NE. */

   252

static inline byte GetRoadStationDir(TileIndex tile)

   253

{

   254

	assert(IsRoadStationTile(tile));

   255

	return (_m[tile].m5 - 0x43) & 3;

   256

}

   257

   258

#endif /* STATION_H */