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

};

    30

    31

typedef uint16 StationID;

    32

    33

typedef struct RoadStop {

    34

	TileIndex xy;

    35

	bool used;

    36

	byte status;

    37

	uint32 index;

    38

	uint16 slot[NUM_SLOTS];

    39

	StationID station;

    40

	uint8 type;

    41

	struct RoadStop *next;

    42

	struct RoadStop *prev;

    43

} RoadStop;

    44

    45

struct Station {

    46

	TileIndex xy;

    47

	RoadStop *bus_stops;

    48

	RoadStop *truck_stops;

    49

	TileIndex train_tile;

    50

	TileIndex airport_tile;

    51

	TileIndex dock_tile;

    52

	Town *town;

    53

	// alpha_order is obsolete since savegame format 4

    54

	byte alpha_order_obsolete;

    55

	uint16 string_id;

    56

    57

	ViewportSign sign;

    58

    59

	uint16 had_vehicle_of_type;

    60

    61

	byte time_since_load;

    62

	byte time_since_unload;

    63

	byte delete_ctr;

    64

	byte owner;

    65

	byte facilities;

    66

	byte airport_type;

    67

    68

	// trainstation width/height

    69

	byte trainst_w, trainst_h;

    70

    71

	byte class_id; // custom graphics station class

    72

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

    73

	uint16 build_date;

    74

    75

	//uint16 airport_flags;

    76

	uint32 airport_flags;

    77

	StationID index;

    78

    79

	VehicleID last_vehicle;

    80

	GoodsEntry goods[NUM_CARGO];

    81

    82

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

    83

	TileIndex bus_tile_obsolete;

    84

	TileIndex lorry_tile_obsolete;

    85

    86

	byte truck_stop_status_obsolete;

    87

	byte bus_stop_status_obsolete;

    88

	byte blocked_months_obsolete;

    89

};

    90

    91

enum {

    92

	FACIL_TRAIN = 1,

    93

	FACIL_TRUCK_STOP = 2,

    94

	FACIL_BUS_STOP = 4,

    95

	FACIL_AIRPORT = 8,

    96

	FACIL_DOCK = 0x10,

    97

};

    98

    99

enum {

   100

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

   101

	HVOT_TRAIN = 1<<1,

   102

	HVOT_BUS = 1 << 2,

   103

	HVOT_TRUCK = 1 << 3,

   104

	HVOT_AIRCRAFT = 1 << 4,

   105

	HVOT_SHIP = 1 << 5,

   108

	HVOT_BUOY = 1 << 6

   109

};

   110

   111

enum {

   112

	CA_BUS = 3,

   113

	CA_TRUCK = 3,

   114

	CA_AIR_OILPAD = 3,

   115

	CA_TRAIN = 4,

   116

	CA_AIR_HELIPORT = 4,

   117

	CA_AIR_SMALL = 4,

   118

	CA_AIR_LARGE = 5,

   119

	CA_DOCK = 5,

   120

	CA_AIR_METRO = 6,

   121

	CA_AIR_INTER = 8,

   122

};

   123

   124

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

   125

   126

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

   127

   128

void ShowStationViewWindow(int station);

   129

void UpdateAllStationVirtCoord(void);

   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(StationID 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

static inline bool IsStationIndex(uint index)

   152

{

   153

	return index < GetStationPoolSize();

   154

}

   155

   156

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

   157

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

   158

   159

   160

/* Stuff for ROADSTOPS */

   161

   162

extern MemoryPool _roadstop_pool;

   163

   164

/**

   165

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

   166

 */

   167

static inline RoadStop *GetRoadStop(uint index)

   168

{

   169

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

   170

}

   171

   172

/**

   173

 * Get the current size of the RoadStoptPool

   174

 */

   175

static inline uint16 GetRoadStopPoolSize(void)

   176

{

   177

	return _roadstop_pool.total_items;

   178

}

   179

   180

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

   181

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

   182

   183

/* End of stuff for ROADSTOPS */

   184

   185

   186

VARDEF bool _station_sort_dirty[MAX_PLAYERS];

   187

VARDEF bool _global_station_sort_dirty;

   188

   189

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

   190

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

   191

uint GetStationPlatforms(Station *st, uint tile);

   192

   193

   194

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

   195

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

   196

typedef byte *StationLayout;

   197

   198

typedef enum StationClass {

   199

	STAT_CLASS_NONE, // unused station slot or so

   200

	STAT_CLASS_DFLT, // default station class

   201

	STAT_CLASS_WAYP, // waypoints

   202

   203

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

   204

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

   205

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

   206

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

   207

	 * STAT_CLASS_CUSTOM. --pasky */

   208

	STAT_CLASS_CUSTOM, // some custom class

   209

} StationClass;

   210

   211

typedef struct StationSpec {

   212

	uint32 grfid;

   213

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

   214

   215

	StationClass sclass;

   216

   217

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

   218

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

   219

	 * lenght. */

   220

	byte allowed_platforms;

   221

	byte allowed_lengths;

   222

   223

	/* Custom sprites */

   224

	byte tiles;

   225

	/* 00 = plain platform

   226

	 * 02 = platform with building

   227

	 * 04 = platform with roof, left side

   228

	 * 06 = platform with roof, right side

   229

	 *

   230

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

   231

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

   232

	DrawTileSprites renderdata[8];

   233

   234

	/* Custom layouts */

   235

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

   236

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

   237

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

   238

	 * station tile. */

   239

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

   240

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

   241

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

   242

	byte lengths;

   243

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

   244

	 * Zero means no platforms defined. */

   245

	byte *platforms;

   246

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

   247

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

   248

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

   249

	 * dimensions. */

   250

	StationLayout **layouts;

   251

   252

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

   253

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

   254

	SpriteGroup spritegroup[2];

   255

} StationSpec;

   256

   257

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

   258

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

   259

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

   260

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

   261

void SetCustomStation(byte stid, StationSpec *spec);

   262

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

   263

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

   264

StationSpec *GetCustomStation(StationClass sclass, byte stid);

   265

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

   266

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

   267

 * structure is used for variational sprite groups. */

   268

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

   269

int GetCustomStationsCount(StationClass sclass);

   270

   271

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStopType type);

   272

static inline int GetRoadStopType(TileIndex tile)

   273

{

   274

	return (_map5[tile] < 0x47) ? RS_TRUCK : RS_BUS;

   275

}

   276

   277

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

   278

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

   279

RoadStop * AllocateRoadStop( void );

   280

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

   281

   282

static inline bool IsTrainStationTile(uint tile) {

   283

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

   284

}

   285

   286

static inline bool IsCompatibleTrainStationTile(TileIndex tile, TileIndex ref)

   287

{

   288

	assert(IsTrainStationTile(ref));

   289

	return

   290

		IsTrainStationTile(tile) &&

   291

		(_map3_lo[tile] & 0x0F) == (_map3_lo[ref] & 0x0F) && // same rail type?

   292

		(_map5[tile] & 0x01) == (_map5[ref] & 0x01); // same direction?

   293

}

   294

   296

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

   297

}

   298

   299

/**

   300

 * Check if a station really exists.

   301

 */

   302

static inline bool IsValidStation(const Station *st)

   303

{

   304

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

   305

}

   306

   316

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

   317

 * station with the exit NE. */

   318

static inline byte GetRoadStationDir(uint tile) {

   319

	assert(IsRoadStationTile(tile));

   320

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

   321

}

   322

   323

#endif /* STATION_H */