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 RoadStop _roadstops[NUM_ROAD_STOPS * 2];

   129

VARDEF uint _roadstops_size;

   130

   131

VARDEF SortStruct *_station_sort;

   132

   133

extern MemoryPool _station_pool;

   134

   135

/**

   136

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

   137

 */

   138

static inline Station *GetStation(uint index)

   139

{

   140

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

   141

}

   142

   143

/**

   144

 * Get the current size of the StationPool

   145

 */

   146

static inline uint16 GetStationPoolSize(void)

   147

{

   148

	return _station_pool.total_items;

   149

}

   150

   151

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

   152

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

   153

   154

VARDEF bool _station_sort_dirty[MAX_PLAYERS];

   155

VARDEF bool _global_station_sort_dirty;

   156

   157

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

   158

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

   159

uint GetStationPlatforms(Station *st, uint tile);

   160

   161

   162

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

   163

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

   164

typedef byte *StationLayout;

   165

   166

struct StationSpec {

   167

	uint32 grfid;

   168

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

   169

   170

	enum StationClass {

   171

		STAT_CLASS_NONE, // unused station slot or so

   172

		STAT_CLASS_DFLT, // default station class

   173

		STAT_CLASS_WAYP, // waypoints

   174

   175

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

   176

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

   177

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

   178

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

   179

		 * STAT_CLASS_CUSTOM. --pasky */

   180

		STAT_CLASS_CUSTOM, // some custom class

   181

	} sclass;

   182

   183

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

   184

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

   185

	 * lenght. */

   186

	byte allowed_platforms;

   187

	byte allowed_lengths;

   188

   189

	/* Custom sprites */

   190

	byte tiles;

   191

	/* 00 = plain platform

   192

	 * 02 = platform with building

   193

	 * 04 = platform with roof, left side

   194

	 * 06 = platform with roof, right side

   195

	 *

   196

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

   197

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

   198

	DrawTileSprites renderdata[8];

   199

   200

	/* Custom layouts */

   201

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

   202

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

   203

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

   204

	 * station tile. */

   205

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

   206

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

   207

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

   208

	byte lengths;

   209

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

   210

	 * Zero means no platforms defined. */

   211

	byte *platforms;

   212

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

   213

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

   214

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

   215

	 * dimensions. */

   216

	StationLayout **layouts;

   217

   218

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

   219

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

   220

	struct SpriteGroup spritegroup[2];

   221

};

   222

   223

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

   224

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

   225

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

   226

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

   227

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

   228

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

   229

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

   230

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

   231

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

   232

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

   233

 * structure is used for variational sprite groups. */

   234

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

   235

int GetCustomStationsCount(enum StationClass sclass);

   236

   237

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStopType type);

   238

inline int GetRoadStopType(TileIndex tile);

   239

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

   240

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

   241

RoadStop * GetFirstFreeRoadStop( void );

   242

   243

static inline bool IsTrainStationTile(uint tile) {

   244

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

   245

}

   246

   247

static inline bool IsRoadStationTile(uint tile) {

   248

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

   249

}

   250

   251

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

   252

 * station with the exit NE. */

   253

static inline byte GetRoadStationDir(uint tile) {

   254

	assert(IsRoadStationTile(tile));

   255

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

   256

}

   257

   258

#endif /* STATION_H */