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

	uint16 string_id;

    54

    55

	ViewportSign sign;

    56

    57

	uint16 had_vehicle_of_type;

    58

    59

	byte time_since_load;

    60

	byte time_since_unload;

    61

	byte delete_ctr;

    62

	byte owner;

    63

	byte facilities;

    64

	byte airport_type;

    65

    66

	// trainstation width/height

    67

	byte trainst_w, trainst_h;

    68

    69

	byte class_id; // custom graphics station class

    70

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

    71

	uint16 build_date;

    72

    73

	//uint16 airport_flags;

    74

	uint32 airport_flags;

    75

	StationID index;

    76

    77

	VehicleID last_vehicle;

    78

	GoodsEntry goods[NUM_CARGO];

    79

    80

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

    81

	TileIndex bus_tile_obsolete;

    82

	TileIndex lorry_tile_obsolete;

    83

    84

	byte truck_stop_status_obsolete;

    85

	byte bus_stop_status_obsolete;

    86

	byte blocked_months_obsolete;

    87

};

    88

    89

enum {

    90

	FACIL_TRAIN = 1,

    91

	FACIL_TRUCK_STOP = 2,

    92

	FACIL_BUS_STOP = 4,

    93

	FACIL_AIRPORT = 8,

    94

	FACIL_DOCK = 0x10,

    95

};

    96

    97

enum {

    98

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

    99

	HVOT_TRAIN = 1<<1,

   100

	HVOT_BUS = 1 << 2,

   101

	HVOT_TRUCK = 1 << 3,

   102

	HVOT_AIRCRAFT = 1 << 4,

   103

	HVOT_SHIP = 1 << 5,

   104

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

   105

	 * can we do? ;-) */

   106

	HVOT_BUOY = 1 << 6

   107

};

   108

   109

enum {

   110

	CA_BUS = 3,

   111

	CA_TRUCK = 3,

   112

	CA_AIR_OILPAD = 3,

   113

	CA_TRAIN = 4,

   114

	CA_AIR_HELIPORT = 4,

   115

	CA_AIR_SMALL = 4,

   116

	CA_AIR_LARGE = 5,

   117

	CA_DOCK = 5,

   118

	CA_AIR_METRO = 6,

   119

	CA_AIR_INTER = 8,

   120

};

   121

   122

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

   123

   124

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

   125

   126

void ShowStationViewWindow(int station);

   127

void UpdateAllStationVirtCoord(void);

   128

   129

VARDEF SortStruct *_station_sort;

   130

   131

extern MemoryPool _station_pool;

   132

   133

/**

   134

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

   135

 */

   136

static inline Station *GetStation(StationID index)

   137

{

   138

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

   139

}

   140

   141

/**

   142

 * Get the current size of the StationPool

   143

 */

   144

static inline uint16 GetStationPoolSize(void)

   145

{

   146

	return _station_pool.total_items;

   147

}

   148

   149

static inline bool IsStationIndex(uint index)

   150

{

   151

	return index < GetStationPoolSize();

   152

}

   153

   154

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

   155

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

   156

   157

   158

/* Stuff for ROADSTOPS */

   159

   160

extern MemoryPool _roadstop_pool;

   161

   162

/**

   163

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

   164

 */

   165

static inline RoadStop *GetRoadStop(uint index)

   166

{

   167

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

   168

}

   169

   170

/**

   171

 * Get the current size of the RoadStoptPool

   172

 */

   173

static inline uint16 GetRoadStopPoolSize(void)

   174

{

   175

	return _roadstop_pool.total_items;

   176

}

   177

   178

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

   179

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

   180

   181

/* End of stuff for ROADSTOPS */

   182

   183

   184

VARDEF bool _station_sort_dirty[MAX_PLAYERS];

   185

VARDEF bool _global_station_sort_dirty;

   186

   187

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

   188

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

   189

uint GetStationPlatforms(Station *st, uint tile);

   190

   191

   192

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

   193

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

   194

typedef byte *StationLayout;

   195

   196

typedef enum StationClass {

   197

	STAT_CLASS_NONE, // unused station slot or so

   198

	STAT_CLASS_DFLT, // default station class

   199

	STAT_CLASS_WAYP, // waypoints

   200

   201

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

   202

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

   203

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

   204

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

   205

	 * STAT_CLASS_CUSTOM. --pasky */

   206

	STAT_CLASS_CUSTOM, // some custom class

   207

} StationClass;

   208

   209

typedef struct StationSpec {

   210

	uint32 grfid;

   211

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

   212

   213

	StationClass sclass;

   214

   215

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

   216

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

   217

	 * lenght. */

   218

	byte allowed_platforms;

   219

	byte allowed_lengths;

   220

   221

	/* Custom sprites */

   222

	byte tiles;

   223

	/* 00 = plain platform

   224

	 * 02 = platform with building

   225

	 * 04 = platform with roof, left side

   226

	 * 06 = platform with roof, right side

   227

	 *

   228

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

   229

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

   230

	DrawTileSprites renderdata[8];

   231

   232

	/* Custom layouts */

   233

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

   234

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

   235

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

   236

	 * station tile. */

   237

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

   238

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

   239

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

   240

	byte lengths;

   241

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

   242

	 * Zero means no platforms defined. */

   243

	byte *platforms;

   244

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

   245

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

   246

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

   247

	 * dimensions. */

   248

	StationLayout **layouts;

   249

   250

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

   251

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

   252

	SpriteGroup spritegroup[2];

   253

} StationSpec;

   254

   255

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

   256

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

   257

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

   258

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

   259

void SetCustomStation(byte stid, StationSpec *spec);

   260

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

   261

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

   262

StationSpec *GetCustomStation(StationClass sclass, byte stid);

   263

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

   264

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

   265

 * structure is used for variational sprite groups. */

   266

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

   267

int GetCustomStationsCount(StationClass sclass);

   268

   269

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStopType type);

   270

static inline int GetRoadStopType(TileIndex tile)

   271

{

   272

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

   273

}

   274

   275

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

   276

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

   277

RoadStop * AllocateRoadStop( void );

   278

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

   279

   280

static inline bool IsTrainStationTile(uint tile) {

   281

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

   282

}

   283

   284

static inline bool IsCompatibleTrainStationTile(TileIndex tile, TileIndex ref)

   285

{

   286

	assert(IsTrainStationTile(ref));

   287

	return

   288

		IsTrainStationTile(tile) &&

   289

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

   290

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

   291

}

   292

   293

static inline bool IsRoadStationTile(TileIndex tile) {

   294

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

   295

}

   296

   297

/**

   298

 * Check if a station really exists.

   299

 */

   300

static inline bool IsValidStation(const Station *st)

   301

{

   302

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

   303

}

   304

   305

static inline bool IsBuoy(const Station* st)

   306

{

   307

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

   308

}

   309

   310

static inline bool IsBuoyTile(TileIndex tile) {

   311

	return IsTileType(tile, MP_STATION) && _map5[tile] == 0x52;

   312

}

   313

   314

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

   315

 * station with the exit NE. */

   316

static inline byte GetRoadStationDir(uint tile) {

   317

	assert(IsRoadStationTile(tile));

   318

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

   319

}

   320

   321

#endif /* STATION_H */