1

/* $Id$ */

     2

     3

#ifndef VEHICLE_H

     4

#define VEHICLE_H

     5

     6

#include "pool.h"

     7

#include "order.h"

     8

#include "rail.h"

     9

    10

enum {

    11

	VEH_Train = 0x10,

    12

	VEH_Road = 0x11,

    13

	VEH_Ship = 0x12,

    14

	VEH_Aircraft = 0x13,

    15

	VEH_Special = 0x14,

    16

	VEH_Disaster = 0x15,

    17

} ;

    18

    19

enum VehStatus {

    20

	VS_HIDDEN = 1,

    21

	VS_STOPPED = 2,

    22

	VS_UNCLICKABLE = 4,

    23

	VS_DEFPAL = 0x8,

    24

	VS_TRAIN_SLOWING = 0x10,

    25

	VS_DISASTER = 0x20,

    26

	VS_AIRCRAFT_BROKEN = 0x40,

    27

	VS_CRASHED = 0x80,

    28

};

    29

    30

/* Effect vehicle types */

    31

typedef enum EffectVehicle {

    32

	EV_CHIMNEY_SMOKE   = 0,

    33

	EV_STEAM_SMOKE     = 1,

    34

	EV_DIESEL_SMOKE    = 2,

    35

	EV_ELECTRIC_SPARK  = 3,

    36

	EV_SMOKE           = 4,

    37

	EV_EXPLOSION_LARGE = 5,

    38

	EV_BREAKDOWN_SMOKE = 6,

    39

	EV_EXPLOSION_SMALL = 7,

    40

	EV_BULLDOZER       = 8,

    41

	EV_BUBBLE          = 9

    42

} EffectVehicle;

    43

    44

typedef struct VehicleRail {

    45

	uint16 last_speed;		// NOSAVE: only used in UI

    46

	uint16 crash_anim_pos;

    47

	uint16 days_since_order_progr;

    48

    49

	// cached values, recalculated on load and each time a vehicle is added to/removed from the consist.

    50

	uint16 cached_max_speed;  // max speed of the consist. (minimum of the max speed of all vehicles in the consist)

    51

	uint32 cached_power;      // total power of the consist.

    52

	uint8 cached_veh_length;  // length of this vehicle in units of 1/8 of normal length, cached because this can be set by a callback

    53

	uint16 cached_total_length; ///< Length of the whole train, valid only for first engine.

    54

    55

	// cached values, recalculated when the cargo on a train changes (in addition to the conditions above)

    56

	uint16 cached_weight;     // total weight of the consist.

    57

	uint16 cached_veh_weight; // weight of the vehicle.

    58

	/**

    59

	 * Position/type of visual effect.

    60

	 * bit 0 - 3 = position of effect relative to vehicle. (0 = front, 8 = centre, 15 = rear)

    61

	 * bit 4 - 5 = type of effect. (0 = default for engine class, 1 = steam, 2 = diesel, 3 = electric)

    62

	 * bit     6 = disable visual effect.

    63

	 * bit     7 = disable powered wagons.

    64

	 */

    65

	byte cached_vis_effect;

    66

    67

	// NOSAVE: for wagon override - id of the first engine in train

    68

	// 0xffff == not in train

    69

	EngineID first_engine;

    70

    71

	byte track;

    72

	byte force_proceed;

    73

	byte railtype;

    74

    75

	byte flags;

    76

    77

	byte pbs_status;

    78

	TileIndex pbs_end_tile;

    79

	Trackdir pbs_end_trackdir;

    80

    81

	/**

    82

	  * stuff to figure out how long a train should be. Used by autoreplace

    83

	  * first byte holds the length of the shortest station. Updated each time order 0 is reached

    84

	  * last byte is the shortest station reached this round though the orders. It can be invalidated by

    85

	  *   skip station and alike by setting it to 0. That way we will ensure that a complete loop is used to find the shortest station

    86

	  */

    87

	byte shortest_platform[2];

    88

    89

	// Link between the two ends of a multiheaded engine

    90

	Vehicle *other_multiheaded_part;

    91

} VehicleRail;

    92

    93

enum {

    94

	VRF_REVERSING = 0,

    95

    96

	// used to calculate if train is going up or down

    97

	VRF_GOINGUP   = 1,

    98

	VRF_GOINGDOWN = 2,

    99

   100

	// used to store if a wagon is powered or not

   101

	VRF_POWEREDWAGON = 3,

   102

};

   103

   104

typedef struct VehicleAir {

   105

	uint16 crashed_counter;

   106

	byte pos;

   107

  byte previous_pos;

   108

	uint16 targetairport;

   109

	byte state;

   110

} VehicleAir;

   111

   112

typedef struct VehicleRoad {

   113

	byte state;

   114

	byte frame;

   115

	uint16 unk2;

   116

	byte overtaking;

   117

	byte overtaking_ctr;

   118

	uint16 crashed_ctr;

   119

	byte reverse_ctr;

   120

	struct RoadStop *slot;

   121

	byte slotindex;

   122

	byte slot_age;

   123

} VehicleRoad;

   124

   125

typedef struct VehicleSpecial {

   126

	uint16 unk0;

   127

	byte unk2;

   128

} VehicleSpecial;

   129

   130

typedef struct VehicleDisaster {

   131

	uint16 image_override;

   132

	uint16 unk2;

   133

} VehicleDisaster;

   134

   135

typedef struct VehicleShip {

   136

	byte state;

   137

} VehicleShip;

   138

   139

   140

struct Vehicle {

   141

	byte type;	// type, ie roadven,train,ship,aircraft,special

   142

	byte subtype;     // subtype (Filled with values from EffectVehicles or TrainSubTypes)

   143

   144

	VehicleID index;	// NOSAVE: Index in vehicle array

   145

   146

	Vehicle *next;		// next

   147

	Vehicle *first;   // NOSAVE: pointer to the first vehicle in the chain

   148

	Vehicle *depot_list;	//NOSAVE: linked list to tell what vehicles entered a depot during the last tick. Used by autoreplace

   149

   150

	StringID string_id; // Displayed string

   151

   152

	UnitID unitnumber;	// unit number, for display purposes only

   153

	PlayerID owner;				// which player owns the vehicle?

   154

   155

	TileIndex tile;		// Current tile index

   156

	TileIndex dest_tile; // Heading for this tile

   157

   158

	int32 x_pos;			// coordinates

   159

	int32 y_pos;

   160

	byte z_pos;

   161

	byte direction;		// facing

   162

   163

	byte spritenum; // currently displayed sprite index

   164

	                // 0xfd == custom sprite, 0xfe == custom second head sprite

   165

	                // 0xff == reserved for another custom sprite

   166

	uint16 cur_image; // sprite number for this vehicle

   167

	byte sprite_width;// width of vehicle sprite

   168

	byte sprite_height;// height of vehicle sprite

   169

	byte z_height;		// z-height of vehicle sprite

   170

	int8 x_offs;			// x offset for vehicle sprite

   171

	int8 y_offs;			// y offset for vehicle sprite

   172

	EngineID engine_type;

   173

   174

	// for randomized variational spritegroups

   175

	// bitmask used to resolve them; parts of it get reseeded when triggers

   176

	// of corresponding spritegroups get matched

   177

	byte random_bits;

   178

	byte waiting_triggers; // triggers to be yet matched

   179

   180

	uint16 max_speed;	// maximum speed

   181

	uint16 cur_speed;	// current speed

   182

	byte subspeed;		// fractional speed

   183

	byte acceleration; // used by train & aircraft

   184

	byte progress;

   185

   186

	byte vehstatus;		// Status

   187

	uint16 last_station_visited;

   188

   189

	byte cargo_type;	// type of cargo this vehicle is carrying

   190

	byte cargo_days; // how many days have the pieces been in transit

   191

	uint16 cargo_source;// source of cargo

   192

	uint16 cargo_cap;	// total capacity

   193

	uint16 cargo_count;// how many pieces are used

   194

   195

	byte day_counter; // increased by one for each day

   196

	byte tick_counter;// increased by one for each tick

   197

   198

	/* Begin Order-stuff */

   199

	Order current_order;     //! The current order (+ status, like: loading)

   200

	OrderID cur_order_index; //! The index to the current order

   201

   202

	Order *orders;           //! Pointer to the first order for this vehicle

   203

	OrderID num_orders;      //! How many orders there are in the list

   204

   205

	Vehicle *next_shared;    //! If not NULL, this points to the next vehicle that shared the order

   206

	Vehicle *prev_shared;    //! If not NULL, this points to the prev vehicle that shared the order

   207

	/* End Order-stuff */

   208

   209

	// Boundaries for the current position in the world and a next hash link.

   210

	// NOSAVE: All of those can be updated with VehiclePositionChanged()

   211

	int32 left_coord;

   212

	int32 top_coord;

   213

	int32 right_coord;

   214

	int32 bottom_coord;

   215

	VehicleID next_hash;

   216

   217

	// Related to age and service time

   218

	uint16 age;				// Age in days

   219

	uint16 max_age;		// Maximum age

   220

	uint16 date_of_last_service;

   221

	uint16 service_interval;

   222

	uint16 reliability;

   223

	uint16 reliability_spd_dec;

   224

	byte breakdown_ctr;

   225

	byte breakdown_delay;

   226

	byte breakdowns_since_last_service;

   227

	byte breakdown_chance;

   228

	byte build_year;

   229

   230

	bool leave_depot_instantly;	// NOSAVE: stores if the vehicle needs to leave the depot it just entered. Used by autoreplace

   231

   232

	uint16 load_unload_time_rem;

   233

   234

	int32 profit_this_year;

   235

	int32 profit_last_year;

   236

	uint32 value;

   237

   238

	union {

   239

		VehicleRail rail;

   240

		VehicleAir air;

   241

		VehicleRoad road;

   242

		VehicleSpecial special;

   243

		VehicleDisaster disaster;

   244

		VehicleShip ship;

   245

	} u;

   246

};

   247

   248

#define is_custom_sprite(x) (x >= 0xFD)

   249

#define IS_CUSTOM_FIRSTHEAD_SPRITE(x) (x == 0xFD)

   250

#define IS_CUSTOM_SECONDHEAD_SPRITE(x) (x == 0xFE)

   251

   252

typedef void VehicleTickProc(Vehicle *v);

   253

typedef void *VehicleFromPosProc(Vehicle *v, void *data);

   254

   255

void VehicleServiceInDepot(Vehicle *v);

   256

Vehicle *AllocateVehicle(void);

   257

bool AllocateVehicles(Vehicle **vl, int num);

   258

Vehicle *ForceAllocateVehicle(void);

   259

Vehicle *ForceAllocateSpecialVehicle(void);

   260

void UpdateVehiclePosHash(Vehicle *v, int x, int y);

   261

void VehiclePositionChanged(Vehicle *v);

   262

void AfterLoadVehicles(void);

   263

Vehicle *GetLastVehicleInChain(Vehicle *v);

   264

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   265

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   266

uint CountVehiclesInChain(const Vehicle* v);

   267

void DeleteVehicle(Vehicle *v);

   268

void DeleteVehicleChain(Vehicle *v);

   269

void *VehicleFromPos(TileIndex tile, void *data, VehicleFromPosProc *proc);

   270

void CallVehicleTicks(void);

   271

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   272

   273

void InitializeTrains(void);

   274

   275

bool CanFillVehicle(Vehicle *v);

   276

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

   277

   278

void ViewportAddVehicles(DrawPixelInfo *dpi);

   279

   280

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   281

   282

void AddRearEngineToMultiheadedTrain(Vehicle *v, Vehicle *u, bool building) ;

   283

   284

/* train_cmd.h */

   285

int GetTrainImage(const Vehicle *v, byte direction);

   286

int GetAircraftImage(const Vehicle *v, byte direction);

   287

int GetRoadVehImage(const Vehicle *v, byte direction);

   288

int GetShipImage(const Vehicle *v, byte direction);

   289

   290

Vehicle *CreateEffectVehicle(int x, int y, int z, EffectVehicle type);

   291

Vehicle *CreateEffectVehicleAbove(int x, int y, int z, EffectVehicle type);

   292

Vehicle *CreateEffectVehicleRel(const Vehicle *v, int x, int y, int z, EffectVehicle type);

   293

   294

uint32 VehicleEnterTile(Vehicle *v, TileIndex tile, int x, int y);

   295

   296

void VehicleInTheWayErrMsg(const Vehicle* v);

   297

Vehicle *FindVehicleBetween(TileIndex from, TileIndex to, byte z);

   298

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   299

   300

bool UpdateSignalsOnSegment(TileIndex tile, byte direction);

   301

void SetSignalsOnBothDir(TileIndex tile, byte track);

   302

   303

Vehicle *CheckClickOnVehicle(const ViewPort *vp, int x, int y);

   304

   305

void DecreaseVehicleValue(Vehicle *v);

   306

void CheckVehicleBreakdown(Vehicle *v);

   307

void AgeVehicle(Vehicle *v);

   308

void VehicleEnteredDepotThisTick(Vehicle *v);

   309

   310

void BeginVehicleMove(Vehicle *v);

   311

void EndVehicleMove(Vehicle *v);

   312

   313

bool IsAircraftHangarTile(TileIndex tile);

   314

void ShowAircraftViewWindow(const Vehicle* v);

   315

   316

UnitID GetFreeUnitNumber(byte type);

   317

   318

int LoadUnloadVehicle(Vehicle *v);

   319

   320

void TrainConsistChanged(Vehicle *v);

   321

void UpdateTrainAcceleration(Vehicle *v);

   322

int32 GetTrainRunningCost(const Vehicle *v);

   323

   324

int CheckTrainStoppedInDepot(const Vehicle *v);

   325

   326

bool VehicleNeedsService(const Vehicle *v);

   327

   328

typedef struct GetNewVehiclePosResult {

   329

	int x,y;

   330

	TileIndex old_tile;

   331

	TileIndex new_tile;

   332

} GetNewVehiclePosResult;

   333

   334

/**

   335

 * Returns the Trackdir on which the vehicle is currently located.

   336

 * Works for trains and ships.

   337

 * Currently works only sortof for road vehicles, since they have a fuzzy

   338

 * concept of being "on" a trackdir. Dunno really what it returns for a road

   339

 * vehicle that is halfway a tile, never really understood that part. For road

   340

 * vehicles that are at the beginning or end of the tile, should just return

   341

 * the diagonal trackdir on which they are driving. I _think_.

   342

 * For other vehicles types, or vehicles with no clear trackdir (such as those

   343

 * in depots), returns 0xFF.

   344

 */

   345

Trackdir GetVehicleTrackdir(const Vehicle* v);

   346

   347

/* returns true if staying in the same tile */

   348

bool GetNewVehiclePos(const Vehicle *v, GetNewVehiclePosResult *gp);

   349

byte GetDirectionTowards(const Vehicle *v, int x, int y);

   350

   351

#define BEGIN_ENUM_WAGONS(v) do {

   352

#define END_ENUM_WAGONS(v) } while ( (v=v->next) != NULL);

   353

   354

/* vehicle.c */

   355

VARDEF SortStruct *_vehicle_sort;

   356

   357

extern MemoryPool _vehicle_pool;

   358

   359

/**

   360

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

   361

 */

   362

static inline Vehicle *GetVehicle(VehicleID index)

   363

{

   364

	return (Vehicle*)GetItemFromPool(&_vehicle_pool, index);

   365

}

   366

   367

/**

   368

 * Get the current size of the VehiclePool

   369

 */

   370

static inline uint16 GetVehiclePoolSize(void)

   371

{

   372

	return _vehicle_pool.total_items;

   373

}

   374

   375

#define FOR_ALL_VEHICLES_FROM(v, start) for (v = GetVehicle(start); v != NULL; v = (v->index + 1 < GetVehiclePoolSize()) ? GetVehicle(v->index + 1) : NULL)

   376

#define FOR_ALL_VEHICLES(v) FOR_ALL_VEHICLES_FROM(v, 0)

   377

   378

/**

   379

 * Check if a Vehicle really exists.

   380

 */

   381

static inline bool IsValidVehicle(const Vehicle *v)

   382

{

   383

	return v->type != 0;

   384

}

   385

   386

/**

   387

 * Check if an index is a vehicle-index (so between 0 and max-vehicles)

   388

 *

   389

 * @return Returns true if the vehicle-id is in range

   390

 */

   391

static inline bool IsVehicleIndex(uint index)

   392

{

   393

	return index < GetVehiclePoolSize();

   394

}

   395

   396

/* Returns order 'index' of a vehicle or NULL when it doesn't exists */

   397

static inline Order *GetVehicleOrder(const Vehicle *v, int index)

   398

{

   399

	Order *order = v->orders;

   400

   401

	if (index < 0) return NULL;

   402

   403

	while (order != NULL && index-- > 0)

   404

		order = order->next;

   405

   406

	return order;

   407

}

   408

   409

/* Returns the last order of a vehicle, or NULL if it doesn't exists */

   410

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   411

{

   412

	Order *order = v->orders;

   413

   414

	if (order == NULL) return NULL;

   415

   416

	while (order->next != NULL)

   417

		order = order->next;

   418

   419

	return order;

   420

}

   421

   422

/* Get the first vehicle of a shared-list, so we only have to walk forwards */

   423

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   424

{

   425

	Vehicle *u = v;

   426

	while (u->prev_shared != NULL)

   427

		u = u->prev_shared;

   428

   429

	return u;

   430

}

   431

   432

// NOSAVE: Return values from various commands.

   433

VARDEF VehicleID _new_train_id;

   434

VARDEF VehicleID _new_wagon_id;

   435

VARDEF VehicleID _new_aircraft_id;

   436

VARDEF VehicleID _new_ship_id;

   437

VARDEF VehicleID _new_roadveh_id;

   438

VARDEF VehicleID _new_vehicle_id;

   439

VARDEF uint16 _aircraft_refit_capacity;

   440

VARDEF byte _cmd_build_rail_veh_score;

   441

   442

#define INVALID_VEHICLE 0xFFFF

   443

#define INVALID_ENGINE 0xFFFF

   444

   445

/* A lot of code calls for the invalidation of the status bar, which is widget 5.

   446

 * Best is to have a virtual value for it when it needs to change again */

   447

#define STATUS_BAR 5

   448

   449

#endif /* VEHICLE_H */