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

    12

typedef struct GoodsEntry {

    13

	uint16 waiting_acceptance;

    14

	byte days_since_pickup;

    15

	byte rating;

    16

	uint16 enroute_from;

    17

	byte enroute_time;

    18

	byte last_speed;

    19

	byte last_age;

    20

	int32 feeder_profit;

    21

} GoodsEntry;

    22

    23

typedef enum RoadStopType {

    24

	RS_BUS,

    25

	RS_TRUCK

    26

} RoadStopType;

    27

    28

enum {

    29

	INVALID_STATION = 0xFFFF,

    30

	INVALID_SLOT = 0xFFFF,

    31

	NUM_SLOTS = 2,

    32

	ROAD_STOP_LIMIT = 8,

    33

};

    34

    35

typedef uint16 StationID;

    36

    37

typedef struct RoadStop {

    38

	TileIndex xy;

    39

	bool used;

    40

	byte status;

    41

	uint32 index;

    42

	uint16 slot[NUM_SLOTS];

    43

	StationID station;

    44

	uint8 type;

    45

	struct RoadStop *next;

    46

	struct RoadStop *prev;

    47

} RoadStop;

    48

    49

struct Station {

    50

	TileIndex xy;

    51

	RoadStop *bus_stops;

    52

	RoadStop *truck_stops;

    53

	TileIndex train_tile;

    54

	TileIndex airport_tile;

    55

	TileIndex dock_tile;

    56

	Town *town;

    57

	uint16 string_id;

    58

    59

	ViewportSign sign;

    60

    61

	uint16 had_vehicle_of_type;

    62

    63

	byte time_since_load;

    64

	byte time_since_unload;

    65

	byte delete_ctr;

    66

	PlayerID owner;

    67

	byte facilities;

    68

	byte airport_type;

    69

    70

	// trainstation width/height

    71

	byte trainst_w, trainst_h;

    72

    73

	byte class_id; // custom graphics station class

    74

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

    75

	uint16 build_date;

    76

    77

	//uint16 airport_flags;

    78

	uint32 airport_flags;

    79

	StationID index;

    80

    81

	VehicleID last_vehicle;

    82

	GoodsEntry goods[NUM_CARGO];

    83

    84

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

    85

	TileIndex bus_tile_obsolete;

    86

	TileIndex lorry_tile_obsolete;

    87

    88

	byte truck_stop_status_obsolete;

    89

	byte bus_stop_status_obsolete;

    90

	byte blocked_months_obsolete;

    91

};

    92

    93

enum {

    94

	FACIL_TRAIN = 1,

    95

	FACIL_TRUCK_STOP = 2,

    96

	FACIL_BUS_STOP = 4,

    97

	FACIL_AIRPORT = 8,

    98

	FACIL_DOCK = 0x10,

    99

};

   100

   101

enum {

   102

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

   103

	HVOT_TRAIN = 1<<1,

   104

	HVOT_BUS = 1 << 2,

   105

	HVOT_TRUCK = 1 << 3,

   106

	HVOT_AIRCRAFT = 1 << 4,

   107

	HVOT_SHIP = 1 << 5,

   108

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

   109

	 * can we do? ;-) */

   110

	HVOT_BUOY = 1 << 6

   111

};

   112

   113

enum {

   114

	CA_BUS = 3,

   115

	CA_TRUCK = 3,

   116

	CA_AIR_OILPAD = 3,

   117

	CA_TRAIN = 4,

   118

	CA_AIR_HELIPORT = 4,

   119

	CA_AIR_SMALL = 4,

   120

	CA_AIR_LARGE = 5,

   121

	CA_DOCK = 5,

   122

	CA_AIR_METRO = 6,

   123

	CA_AIR_INTER = 8,

   124

};

   125

   126

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

   127

   128

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

   129

   130

void ShowStationViewWindow(StationID station);

   131

void UpdateAllStationVirtCoord(void);

   132

   133

VARDEF SortStruct *_station_sort;

   134

   135

extern MemoryPool _station_pool;

   136

   137

/**

   138

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

   139

 */

   140

static inline Station *GetStation(StationID index)

   141

{

   142

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

   143

}

   144

   145

/**

   146

 * Get the current size of the StationPool

   147

 */

   148

static inline uint16 GetStationPoolSize(void)

   149

{

   150

	return _station_pool.total_items;

   151

}

   152

   153

static inline bool IsStationIndex(uint index)

   154

{

   155

	return index < GetStationPoolSize();

   156

}

   157

   158

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

   159

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

   160

   161

   162

/* Stuff for ROADSTOPS */

   163

   164

extern MemoryPool _roadstop_pool;

   165

   166

/**

   167

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

   168

 */

   169

static inline RoadStop *GetRoadStop(uint index)

   170

{

   171

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

   172

}

   173

   174

/**

   175

 * Get the current size of the RoadStoptPool

   176

 */

   177

static inline uint16 GetRoadStopPoolSize(void)

   178

{

   179

	return _roadstop_pool.total_items;

   180

}

   181

   182

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

   183

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

   184

   185

/* End of stuff for ROADSTOPS */

   186

   187

   188

VARDEF bool _station_sort_dirty[MAX_PLAYERS];

   189

VARDEF bool _global_station_sort_dirty;

   190

   191

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

   192

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

   193

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

   194

   195

   199

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

   200

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

   201

typedef byte *StationLayout;

   202

   203

typedef enum StationClass {

   204

	STAT_CLASS_NONE, // unused station slot or so

   205

	STAT_CLASS_DFLT, // default station class

   206

	STAT_CLASS_WAYP, // waypoints

   207

   208

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

   209

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

   210

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

   211

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

   212

	 * STAT_CLASS_CUSTOM. --pasky */

   213

	STAT_CLASS_CUSTOM, // some custom class

   214

} StationClass;

   215

   216

typedef struct StationSpec {

   217

	uint32 grfid;

   218

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

   219

   220

	StationClass sclass;

   221

   222

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

   223

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

   224

	 * lenght. */

   225

	byte allowed_platforms;

   226

	byte allowed_lengths;

   227

   228

	/* Custom sprites */

   229

	byte tiles;

   230

	/* 00 = plain platform

   231

	 * 02 = platform with building

   232

	 * 04 = platform with roof, left side

   233

	 * 06 = platform with roof, right side

   234

	 *

   235

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

   236

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

   237

	DrawTileSprites renderdata[8];

   238

   239

	/* Custom layouts */

   240

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

   241

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

   242

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

   243

	 * station tile. */

   244

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

   245

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

   246

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

   247

	byte lengths;

   248

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

   249

	 * Zero means no platforms defined. */

   250

	byte *platforms;

   251

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

   252

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

   253

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

   254

	 * dimensions. */

   255

	StationLayout **layouts;

   256

   257

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

   258

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

   259

	SpriteGroup *spritegroup[2];

   260

} StationSpec;

   261

   262

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

   263

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

   264

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

   265

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

   266

void SetCustomStation(byte stid, StationSpec *spec);

   267

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

   268

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

   269

StationSpec *GetCustomStation(StationClass sclass, byte stid);

   270

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

   271

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

   272

 * structure is used for variational sprite groups. */

   273

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

   274

int GetCustomStationsCount(StationClass sclass);

   275

   276

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStopType type);

   277

static inline int GetRoadStopType(TileIndex tile)

   278

{

   279

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

   280

}

   281

   282

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

   283

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

   284

RoadStop * AllocateRoadStop( void );

   285

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

   286

   287

static inline bool IsTrainStationTile(TileIndex tile)

   288

{

   289

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

   290

}

   291

   292

static inline bool IsCompatibleTrainStationTile(TileIndex tile, TileIndex ref)

   293

{

   294

	assert(IsTrainStationTile(ref));

   295

	return

   296

		IsTrainStationTile(tile) &&

   297

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

   298

		(_m[tile].m5 & 0x01) == (_m[ref].m5 & 0x01); // same direction?

   299

}

   300

   301

static inline bool IsRoadStationTile(TileIndex tile) {

   302

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

   303

}

   304

   305

/**

   306

 * Check if a station really exists.

   307

 */

   308

static inline bool IsValidStation(const Station *st)

   309

{

   310

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

   311

}

   312

   313

static inline bool IsBuoy(const Station* st)

   314

{

   315

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

   316

}

   317

   318

static inline bool IsBuoyTile(TileIndex tile) {

   319

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

   320

}

   321

   322

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

   323

 * station with the exit NE. */

   324

static inline byte GetRoadStationDir(TileIndex tile)

   325

{

   326

	assert(IsRoadStationTile(tile));

   327

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

   328

}

   329

   330

#endif /* STATION_H */