1

/* $Id$ */

     2

     3

/** @file station.h */

     4

     5

#ifndef STATION_H

     6

#define STATION_H

     7

     8

#include "airport.h"

     9

#include "player.h"

    10

#include "oldpool.h"

    11

#include "sprite.h"

    12

#include "tile.h"

    13

#include "road.h"

    14

#include "newgrf_station.h"

    15

#include "cargopacket.h"

    16

#include <list>

    17

    18

struct Station;

    19

struct RoadStop;

    20

    21

DECLARE_OLD_POOL(Station, Station, 6, 1000)

    22

DECLARE_OLD_POOL(RoadStop, RoadStop, 5, 2000)

    23

    24

static const byte INITIAL_STATION_RATING = 175;

    25

    26

struct GoodsEntry {

    27

	GoodsEntry() :

    28

		acceptance(false),

    29

		days_since_pickup(255),

    30

		rating(INITIAL_STATION_RATING),

    31

		last_speed(0),

    32

		last_age(255)

    33

	{}

    34

    35

	bool acceptance;

    36

	byte days_since_pickup;

    37

	byte rating;

    38

	byte last_speed;

    39

	byte last_age;

    40

	CargoList cargo; ///< The cargo packets of cargo waiting in this station

    41

};

    42

    43

/** A Stop for a Road Vehicle */

    44

struct RoadStop : PoolItem<RoadStop, RoadStopID, &_RoadStop_pool> {

    45

	/** Types of RoadStops */

    46

	enum Type {

    47

		BUS,                                ///< A standard stop for buses

    48

		TRUCK                               ///< A standard stop for trucks

    49

	};

    50

    52

	static const uint LIMIT           = 16;  ///< The maximum amount of roadstops that are allowed at a single station

    53

	static const uint MAX_BAY_COUNT   =  2;  ///< The maximum number of loading bays

    54

    55

	TileIndex        xy;                    ///< Position on the map

    56

	byte             status;                ///< Current status of the Stop. Like which spot is taken. Access using *Bay and *Busy functions.

    57

	byte             num_vehicles;          ///< Number of vehicles currently slotted to this stop

    58

	struct RoadStop  *next;                 ///< Next stop of the given type at this station

    59

    60

	RoadStop(TileIndex tile = 0);

    61

	virtual ~RoadStop();

    62

    63

	bool IsValid() const;

    64

    65

	/* For accessing status */

    66

	bool HasFreeBay() const;

    67

	bool IsFreeBay(uint nr) const;

    68

	uint AllocateBay();

    69

	void AllocateDriveThroughBay(uint nr);

    70

	void FreeBay(uint nr);

    71

	bool IsEntranceBusy() const;

    72

	void SetEntranceBusy(bool busy);

    73

};

    74

    75

struct StationSpecList {

    76

	const StationSpec *spec;

    77

	uint32 grfid;      ///< GRF ID of this custom station

    78

	uint8  localidx;   ///< Station ID within GRF of station

    79

};

    80

    81

/** StationRect - used to track station spread out rectangle - cheaper than scanning whole map */

    82

struct StationRect : public Rect {

    83

	enum StationRectMode

    84

	{

    85

		ADD_TEST = 0,

    86

		ADD_TRY,

    87

		ADD_FORCE

    88

	};

    89

    90

	StationRect();

    91

	void MakeEmpty();

    92

	bool PtInExtendedRect(int x, int y, int distance = 0) const;

    93

	bool IsEmpty() const;

    94

	bool BeforeAddTile(TileIndex tile, StationRectMode mode);

    95

	bool BeforeAddRect(TileIndex tile, int w, int h, StationRectMode mode);

    96

	bool AfterRemoveTile(Station *st, TileIndex tile);

    97

	bool AfterRemoveRect(Station *st, TileIndex tile, int w, int h);

    98

    99

	static bool ScanForStationTiles(StationID st_id, int left_a, int top_a, int right_a, int bottom_a);

   100

   101

	StationRect& operator = (Rect src);

   102

};

   103

   104

struct Station : PoolItem<Station, StationID, &_Station_pool> {

   105

	public:

   106

		RoadStop *GetPrimaryRoadStop(RoadStop::Type type) const

   107

		{

   108

			return type == RoadStop::BUS ? bus_stops : truck_stops;

   109

		}

   110

   111

		const AirportFTAClass *Airport() const

   112

		{

   113

			if (airport_tile == 0) return GetAirport(AT_DUMMY);

   114

			return GetAirport(airport_type);

   115

		}

   116

   117

	TileIndex xy;

   118

	RoadStop *bus_stops;

   119

	RoadStop *truck_stops;

   120

	TileIndex train_tile;

   121

	TileIndex airport_tile;

   122

	TileIndex dock_tile;

   123

	Town *town;

   124

	uint16 string_id;

   125

   126

	ViewportSign sign;

   127

   128

	uint16 had_vehicle_of_type;

   129

   130

	byte time_since_load;

   131

	byte time_since_unload;

   132

	byte delete_ctr;

   133

	PlayerByte owner;

   134

	byte facilities;

   135

	byte airport_type;

   136

   137

	/* trainstation width/height */

   138

	byte trainst_w, trainst_h;

   139

   140

	/** List of custom stations (StationSpecs) allocated to the station */

   141

	uint8 num_specs;

   142

	StationSpecList *speclist;

   143

   144

	Date build_date;

   145

   146

	uint64 airport_flags;   ///< stores which blocks on the airport are taken. was 16 bit earlier on, then 32

   147

   148

	byte last_vehicle_type;

   149

	std::list<Vehicle *> loading_vehicles;

   150

	GoodsEntry goods[NUM_CARGO];

   151

   152

	uint16 random_bits;

   153

	byte waiting_triggers;

   154

   155

	StationRect rect; ///< Station spread out rectangle (not saved) maintained by StationRect_xxx() functions

   156

   158

   159

	Station(TileIndex tile = 0);

   160

	virtual ~Station();

   161

   162

	void QuickFree();

   163

   164

	void AddFacility(byte new_facility_bit, TileIndex facil_xy);

   165

	void MarkDirty() const;

   166

	void MarkTilesDirty(bool cargo_change) const;

   167

	bool TileBelongsToRailStation(TileIndex tile) const;

   168

	uint GetPlatformLength(TileIndex tile, DiagDirection dir) const;

   169

	uint GetPlatformLength(TileIndex tile) const;

   170

	bool IsBuoy() const;

   171

	bool IsValid() const;

   172

};

   173

   174

enum StationType {

   175

	STATION_RAIL,

   176

	STATION_AIRPORT,

   177

	STATION_TRUCK,

   178

	STATION_BUS,

   179

	STATION_OILRIG,

   180

	STATION_DOCK,

   181

	STATION_BUOY

   182

};

   183

   184

enum {

   185

	FACIL_TRAIN      = 0x01,

   186

	FACIL_TRUCK_STOP = 0x02,

   187

	FACIL_BUS_STOP   = 0x04,

   188

	FACIL_AIRPORT    = 0x08,

   189

	FACIL_DOCK       = 0x10,

   190

};

   191

   192

enum {

   193

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

   194

	HVOT_TRAIN    = 1 << 1,

   195

	HVOT_BUS      = 1 << 2,

   196

	HVOT_TRUCK    = 1 << 3,

   197

	HVOT_AIRCRAFT = 1 << 4,

   198

	HVOT_SHIP     = 1 << 5,

   199

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

   200

	 * can we do? ;-) */

   201

	HVOT_BUOY     = 1 << 6

   202

};

   203

   204

enum CatchmentArea {

   205

	CA_NONE            =  0,

   206

	CA_BUS             =  3,

   207

	CA_TRUCK           =  3,

   208

	CA_TRAIN           =  4,

   209

	CA_DOCK            =  5

   210

};

   211

   212

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

   213

   214

void ShowStationViewWindow(StationID station);

   215

void UpdateAllStationVirtCoord();

   216

   217

/* sorter stuff */

   218

void RebuildStationLists();

   219

void ResortStationLists();

   220

   221

static inline StationID GetMaxStationIndex()

   222

{

   223

	/* TODO - This isn't the real content of the function, but

   224

	 *  with the new pool-system this will be replaced with one that

   225

	 *  _really_ returns the highest index. Now it just returns

   226

	 *  the next safe value we are sure about everything is below.

   227

	 */

   228

	return GetStationPoolSize() - 1;

   229

}

   230

   231

static inline uint GetNumStations()

   232

{

   233

	return GetStationPoolSize();

   234

}

   235

   236

static inline bool IsValidStationID(StationID index)

   237

{

   238

	return index < GetStationPoolSize() && GetStation(index)->IsValid();

   239

}

   240

   241

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

   242

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

   243

   244

   245

/* Stuff for ROADSTOPS */

   246

   247

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

   248

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

   249

   250

/* End of stuff for ROADSTOPS */

   251

   252

   253

void AfterLoadStations();

   254

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

   255

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

   256

   257

   258

const DrawTileSprites *GetStationTileLayout(StationType st, byte gfx);

   259

void StationPickerDrawSprite(int x, int y, StationType st, RailType railtype, RoadType roadtype, int image);

   260

   261

RoadStop * GetRoadStopByTile(TileIndex tile, RoadStop::Type type);

   262

uint GetNumRoadStops(const Station* st, RoadStop::Type type);

   263

RoadStop * AllocateRoadStop();

   264

void ClearSlot(Vehicle *v);

   265

   266

void DeleteOilRig(TileIndex t);

   267

   268

#endif /* STATION_H */