1

#ifndef STATION_H

     2

#define STATION_H

     3

     4

#include "pool.h"

     5

#include "sprite.h"

     6

#include "tile.h"

     7

#include "vehicle.h"

     8

     9

typedef struct GoodsEntry {

    10

	uint16 waiting_acceptance;

    11

	byte days_since_pickup;

    12

	byte rating;

    13

	uint16 enroute_from;

    14

	byte enroute_time;

    15

	byte last_speed;

    16

	byte last_age;

    17

} GoodsEntry;

    18

    19

typedef enum RoadStopType {

    20

	RS_BUS,

    21

	RS_TRUCK

    22

} RoadStopType;

    23

    24

enum {

    25

	INVALID_STATION = 0xFFFF,

    26

	INVALID_SLOT = 0xFFFF,

    27

	NUM_SLOTS = 2,

    28

	ROAD_STOP_LIMIT = 8,

    29

	NUM_ROAD_STOPS = 250,

    30

};

    31

    32

typedef struct RoadStop {

    33

	TileIndex xy;

    34

	bool used;

    35

	byte status;

    36

	uint32 index;

    37

	uint16 slot[NUM_SLOTS];

    38

	uint16 station;		//XXX should be StationIndex

    39

	uint8 type;

    40

	struct RoadStop *next;

    41

	struct RoadStop *prev;

    42

} RoadStop;

    43

    44

struct Station {

    45

	TileIndex xy;

    46

	RoadStop *bus_stops;

    47

	RoadStop *truck_stops;

    48

	TileIndex train_tile;

    49

	TileIndex airport_tile;

    50

	TileIndex dock_tile;

    51

	Town *town;

    52

	// alpha_order is obsolete since savegame format 4

    53

	byte alpha_order_obsolete;

    54

	uint16 string_id;

    55

    56

	ViewportSign sign;

    57

    58

	uint16 had_vehicle_of_type;

    59

    60

	byte time_since_load;

    61

	byte time_since_unload;

    62

	byte delete_ctr;

    63

	byte owner;

    64

	byte facilities;

    65

	byte airport_type;

    66

    67

	// trainstation width/height

    68

	byte trainst_w, trainst_h;

    69

    70

	byte class_id; // custom graphics station class

    71

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

    72

	uint16 build_date;

    73

    74

	//uint16 airport_flags;

    75

	uint32 airport_flags;

    76

	uint16 index;

    77

    78

	VehicleID last_vehicle;

    79

	GoodsEntry goods[NUM_CARGO];

    80

    81

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

    82

	TileIndex bus_tile_obsolete;

    83

	TileIndex lorry_tile_obsolete;

    84

    85

	byte truck_stop_status_obsolete;

    86

	byte bus_stop_status_obsolete;

    87

	byte blocked_months_obsolete;

    88

};

    89

    90

enum {

    91

	FACIL_TRAIN = 1,

    92

	FACIL_TRUCK_STOP = 2,

    93

	FACIL_BUS_STOP = 4,

    94

	FACIL_AIRPORT = 8,

    95

	FACIL_DOCK = 0x10,

    96

};

    97

    98

enum {

    99

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

   100

	HVOT_TRAIN = 1<<1,

   101

	HVOT_BUS = 1 << 2,

   102

	HVOT_TRUCK = 1 << 3,

   103

	HVOT_AIRCRAFT = 1 << 4,

   104

	HVOT_SHIP = 1 << 5,

   105

	HVOT_BUOY = 1 << 6

   106

};

   107

   108

enum {

   109

	CA_BUS = 3,

   110

	CA_TRUCK = 3,

   111

	CA_AIR_OILPAD = 3,

   112

	CA_TRAIN = 4,

   113

	CA_AIR_HELIPORT = 4,

   114

	CA_AIR_SMALL = 4,

   115

	CA_AIR_LARGE = 5,

   116

	CA_DOCK = 5,

   117

	CA_AIR_METRO = 6,

   118

	CA_AIR_INTER = 8,

   119

};

   120

   121

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

   122

   123

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

   124

   125

void ShowStationViewWindow(int station);

   126

void UpdateAllStationVirtCoord(void);

   127

   128

VARDEF SortStruct *_station_sort;

   129

   130

extern MemoryPool _station_pool;

   131

   132

/**

   133

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

   134

 */

   135

static inline Station *GetStation(uint index)

   136

{

   137

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

   138

}

   139

   140

/**

   141

 * Get the current size of the StationPool

   142

 */

   143

static inline uint16 GetStationPoolSize(void)

   144

{

   145

	return _station_pool.total_items;

   146

}

   147

   148

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

   149

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

   150

   178

VARDEF bool _station_sort_dirty[MAX_PLAYERS];

   179

VARDEF bool _global_station_sort_dirty;

   180

   181

void GetProductionAroundTiles(uint *produced, uint tile, int w, int h, int rad);

   182

void GetAcceptanceAroundTiles(uint *accepts, uint tile, int w, int h, int rad);

   183

uint GetStationPlatforms(Station *st, uint tile);

   184

   185

   186

/* Station layout for given dimensions - it is a two-dimensional array

   187

 * where index is computed as (x * platforms) + platform. */

   188

typedef byte *StationLayout;

   189

   190

struct StationSpec {

   191

	uint32 grfid;

   192

	int localidx; // per-GRFFile station index + 1; SetCustomStation() takes care of this

   193

   194

	enum StationClass {

   195

		STAT_CLASS_NONE, // unused station slot or so

   196

		STAT_CLASS_DFLT, // default station class

   197

		STAT_CLASS_WAYP, // waypoints

   198

   199

		/* TODO: When we actually support custom classes, they are

   200

		 * going to be allocated dynamically (with some classid->sclass

   201

		 * mapping, there's a TTDPatch limit on 16 custom classes in

   202

		 * the whole game at the same time) with base at

   203

		 * STAT_CLASS_CUSTOM. --pasky */

   204

		STAT_CLASS_CUSTOM, // some custom class

   205

	} sclass;

   206

   207

	/* Bitmask of platform numbers/lengths available for the station.  Bits

   208

	 * 0..6 correspond to 1..7, while bit 7 corresponds to >7 platforms or

   209

	 * lenght. */

   210

	byte allowed_platforms;

   211

	byte allowed_lengths;

   212

   213

	/* Custom sprites */

   214

	byte tiles;

   215

	/* 00 = plain platform

   216

	 * 02 = platform with building

   217

	 * 04 = platform with roof, left side

   218

	 * 06 = platform with roof, right side

   219

	 *

   220

	 * These numbers are used for stations in NE-SW direction, or these

   221

	 * numbers plus one for stations in the NW-SE direction.  */

   222

	DrawTileSprites renderdata[8];

   223

   224

	/* Custom layouts */

   225

	/* The layout array is organized like [lenghts][platforms], both being

   226

	 * dynamic arrays, the field itself is length*platforms array containing

   227

	 * indexes to @renderdata (only even numbers allowed) for the given

   228

	 * station tile. */

   229

	/* @lengths is length of the @platforms and @layouts arrays, that is

   230

	 * number of maximal length for which the layout is defined (since

   231

	 * arrays are indexed from 0, the length itself is at [length - 1]). */

   232

	byte lengths;

   233

	/* @platforms is array of number of platforms defined for each length.

   234

	 * Zero means no platforms defined. */

   235

	byte *platforms;

   236

	/* @layout is @layouts-sized array of @platforms-sized arrays,

   237

	 * containing pointers to length*platforms-sized arrays or NULL if

   238

	 * default OTTD station layout should be used for stations of these

   239

	 * dimensions. */

   240

	StationLayout **layouts;

   241

   242

	/* Sprite offsets for renderdata->seq->image. spritegroup[0] is default

   243

	 * whilst spritegroup[1] is "CID_PURCHASE". */

   244

	struct SpriteGroup spritegroup[2];

   245

};

   246

   247

/* Here, @stid is local per-GRFFile station index. If spec->localidx is not yet

   248

 * set, it gets new dynamically allocated global index and spec->localidx is

   249

 * set to @stid, otherwise we take it as that we are replacing it and try to

   250

 * search for it first (that isn't much fast but we do it only very seldom). */

   251

void SetCustomStation(byte stid, struct StationSpec *spec);

   252

/* Here, @stid is global station index (in continous range 0..GetCustomStationsCount())

   253

 * (lookup is therefore very fast as we do this very frequently). */

   254

struct StationSpec *GetCustomStation(enum StationClass sclass, byte stid);

   255

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

   256

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

   257

 * structure is used for variational sprite groups. */

   258

uint32 GetCustomStationRelocation(struct StationSpec *spec, struct Station *stat, byte ctype);

   259

int GetCustomStationsCount(enum StationClass sclass);

   260

   261

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStopType type);

   262

inline int GetRoadStopType(TileIndex tile);

   263

uint GetNumRoadStops(const Station *st, RoadStopType type);

   264

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

   266

   267

static inline bool IsTrainStationTile(uint tile) {

   268

	return IsTileType(tile, MP_STATION) && IS_BYTE_INSIDE(_map5[tile], 0, 8);

   269

}

   270

   271

static inline bool IsRoadStationTile(uint tile) {

   272

	return IsTileType(tile, MP_STATION) && IS_BYTE_INSIDE(_map5[tile], 0x43, 0x4B);

   273

}

   274

   275

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

   276

 * station with the exit NE. */

   277

static inline byte GetRoadStationDir(uint tile) {

   278

	assert(IsRoadStationTile(tile));

   279

	return (_map5[tile] - 0x43) & 3;

   280

}

   281

   282

#endif /* STATION_H */