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

// 1 and 3 do not appear to be used

    31

typedef enum TrainSubtypes {

    32

	TS_Front_Engine = 0, // Leading engine of a train

    33

	TS_Artic_Part = 1,   // Articulated part of an engine

    34

	TS_Not_First = 2,    // Wagon or additional engine

    35

	TS_Free_Car = 4,     // First in a wagon chain (in depot)

    36

} TrainSubtype;

    37

    38

/* Effect vehicle types */

    39

typedef enum EffectVehicle {

    40

	EV_CHIMNEY_SMOKE   = 0,

    41

	EV_STEAM_SMOKE     = 1,

    42

	EV_DIESEL_SMOKE    = 2,

    43

	EV_ELECTRIC_SPARK  = 3,

    44

	EV_SMOKE           = 4,

    45

	EV_EXPLOSION_LARGE = 5,

    46

	EV_BREAKDOWN_SMOKE = 6,

    47

	EV_EXPLOSION_SMALL = 7,

    48

	EV_BULLDOZER       = 8,

    49

	EV_BUBBLE          = 9

    50

} EffectVehicle;

    51

    52

typedef struct VehicleRail {

    53

	uint16 last_speed;		// NOSAVE: only used in UI

    54

	uint16 crash_anim_pos;

    55

	uint16 days_since_order_progr;

    56

    57

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

    58

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

    59

	uint32 cached_power;      // total power of the consist.

    60

	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

    61

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

    62

    63

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

    64

	uint16 cached_weight;     // total weight of the consist.

    65

	uint16 cached_veh_weight; // weight of the vehicle.

    66

	/**

    67

	 * Position/type of visual effect.

    68

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

    69

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

    70

	 * bit     6 = disable visual effect.

    71

	 * bit     7 = disable powered wagons.

    72

	 */

    73

	byte cached_vis_effect;

    74

    75

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

    76

	// 0xffff == not in train

    77

	EngineID first_engine;

    78

    79

	byte track;

    80

	byte force_proceed;

    81

	byte railtype;

    82

    83

	byte flags;

    84

    85

	byte pbs_status;

    86

	TileIndex pbs_end_tile;

    87

	Trackdir pbs_end_trackdir;

    96

} VehicleRail;

    97

    98

enum {

    99

	VRF_REVERSING = 0,

   100

   101

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

   102

	VRF_GOINGUP   = 1,

   103

	VRF_GOINGDOWN = 2,

   104

   105

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

   106

	VRF_POWEREDWAGON = 3,

   107

};

   108

   109

typedef struct VehicleAir {

   110

	uint16 crashed_counter;

   111

	byte pos;

   112

  byte previous_pos;

   113

	uint16 targetairport;

   114

	byte state;

   115

} VehicleAir;

   116

   117

typedef struct VehicleRoad {

   118

	byte state;

   119

	byte frame;

   120

	uint16 unk2;

   121

	byte overtaking;

   122

	byte overtaking_ctr;

   123

	uint16 crashed_ctr;

   124

	byte reverse_ctr;

   125

	struct RoadStop *slot;

   126

	byte slotindex;

   127

	byte slot_age;

   128

} VehicleRoad;

   129

   130

typedef struct VehicleSpecial {

   131

	uint16 unk0;

   132

	byte unk2;

   133

} VehicleSpecial;

   134

   135

typedef struct VehicleDisaster {

   136

	uint16 image_override;

   137

	uint16 unk2;

   138

} VehicleDisaster;

   139

   140

typedef struct VehicleShip {

   141

	byte state;

   142

} VehicleShip;

   143

   144

// not used ATM

   145

struct WorldSprite {

   146

	struct WorldSprite *next;			// next sprite in hash chain

   147

	uint16 image;			// sprite number for this vehicle

   148

   149

	// screen coordinates

   150

	int16 left, top, right, bottom;

   151

   152

	// world coordinates

   153

	int16 x;

   154

	int16 y;

   155

	byte z;

   156

   157

	int8 x_offs;			// x offset for vehicle sprite

   158

	int8 y_offs;			// y offset for vehicle sprite

   159

   160

	byte width;				// width of vehicle sprite

   161

	byte height;			// height of vehicle sprite

   162

	byte depth;				// depth of vehicle sprite

   163

   164

	byte flags;				// draw flags

   165

};

   166

   167

struct Vehicle {

   168

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

   169

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

   170

   171

	VehicleID index;	// NOSAVE: Index in vehicle array

   172

   173

	Vehicle *next;		// next

   174

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

   175

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

   176

   177

	StringID string_id; // Displayed string

   178

   179

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

   180

	PlayerID owner;				// which player owns the vehicle?

   181

   182

	TileIndex tile;		// Current tile index

   183

	TileIndex dest_tile; // Heading for this tile

   184

   185

	int32 x_pos;			// coordinates

   186

	int32 y_pos;

   187

   188

	byte z_pos;

   189

	byte direction;		// facing

   190

   191

	byte spritenum; // currently displayed sprite index

   192

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

   193

	                // 0xff == reserved for another custom sprite

   194

	uint16 cur_image; // sprite number for this vehicle

   195

	byte sprite_width;// width of vehicle sprite

   196

	byte sprite_height;// height of vehicle sprite

   197

	byte z_height;		// z-height of vehicle sprite

   198

	int8 x_offs;			// x offset for vehicle sprite

   199

	int8 y_offs;			// y offset for vehicle sprite

   200

	EngineID engine_type;

   201

   202

	// for randomized variational spritegroups

   203

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

   204

	// of corresponding spritegroups get matched

   205

	byte random_bits;

   206

	byte waiting_triggers; // triggers to be yet matched

   207

   208

	uint16 max_speed;	// maximum speed

   209

	uint16 cur_speed;	// current speed

   210

	byte subspeed;		// fractional speed

   211

	byte acceleration; // used by train & aircraft

   212

	byte progress;

   213

   214

	byte vehstatus;		// Status

   215

	uint16 last_station_visited;

   216

   217

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

   218

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

   219

	uint16 cargo_source;// source of cargo

   220

	uint16 cargo_cap;	// total capacity

   221

	uint16 cargo_count;// how many pieces are used

   222

   223

	byte day_counter; // increased by one for each day

   224

	byte tick_counter;// increased by one for each tick

   225

   226

	/* Begin Order-stuff */

   227

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

   228

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

   229

   230

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

   231

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

   232

   233

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

   234

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

   235

	/* End Order-stuff */

   236

   237

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

   238

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

   239

	int32 left_coord;

   240

	int32 top_coord;

   241

	int32 right_coord;

   242

	int32 bottom_coord;

   243

	uint16 next_hash;

   244

   245

	// Related to age and service time

   246

	uint16 age;				// Age in days

   247

	uint16 max_age;		// Maximum age

   248

	uint16 date_of_last_service;

   249

	uint16 service_interval;

   250

	uint16 reliability;

   251

	uint16 reliability_spd_dec;

   252

	byte breakdown_ctr;

   253

	byte breakdown_delay;

   254

	byte breakdowns_since_last_service;

   255

	byte breakdown_chance;

   256

	byte build_year;

   257

   260

	uint16 load_unload_time_rem;

   261

   262

	int32 profit_this_year;

   263

	int32 profit_last_year;

   264

	uint32 value;

   265

   266

   267

   268

	union {

   269

		VehicleRail rail;

   270

		VehicleAir air;

   271

		VehicleRoad road;

   272

		VehicleSpecial special;

   273

		VehicleDisaster disaster;

   274

		VehicleShip ship;

   275

	} u;

   276

};

   277

   278

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

   279

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

   280

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

   281

   282

typedef void VehicleTickProc(Vehicle *v);

   283

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

   284

   285

void VehicleServiceInDepot(Vehicle *v);

   286

Vehicle *AllocateVehicle(void);

   287

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

   288

Vehicle *ForceAllocateVehicle(void);

   289

Vehicle *ForceAllocateSpecialVehicle(void);

   290

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

   291

void VehiclePositionChanged(Vehicle *v);

   292

void AfterLoadVehicles(void);

   293

Vehicle *GetLastVehicleInChain(Vehicle *v);

   294

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   295

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   296

int CountVehiclesInChain(Vehicle *v);

   297

void DeleteVehicle(Vehicle *v);

   298

void DeleteVehicleChain(Vehicle *v);

   299

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

   300

void CallVehicleTicks(void);

   301

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   302

   303

void InitializeTrains(void);

   304

   305

bool CanFillVehicle(Vehicle *v);

   306

bool CanRefitTo(const Vehicle *v, CargoID cid_to);

   307

   308

void ViewportAddVehicles(DrawPixelInfo *dpi);

   309

   310

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   311

   312

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

   313

   314

/* train_cmd.h */

   315

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

   316

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

   317

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

   318

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

   319

   320

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

   321

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

   322

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

   323

   324

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

   325

   326

void VehicleInTheWayErrMsg(Vehicle *v);

   327

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

   328

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   329

   330

bool UpdateSignalsOnSegment(TileIndex tile, byte direction);

   331

void SetSignalsOnBothDir(TileIndex tile, byte track);

   332

   333

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

   334

   335

void DecreaseVehicleValue(Vehicle *v);

   336

void CheckVehicleBreakdown(Vehicle *v);

   337

void AgeVehicle(Vehicle *v);

   338

void VehicleEnteredDepotThisTick(Vehicle *v);

   339

Vehicle *GetRearEngine(const Vehicle *v, EngineID engine);

   340

   341

void BeginVehicleMove(Vehicle *v);

   342

void EndVehicleMove(Vehicle *v);

   343

   344

bool IsAircraftHangarTile(TileIndex tile);

   345

void ShowAircraftViewWindow(const Vehicle* v);

   346

   347

UnitID GetFreeUnitNumber(byte type);

   348

   349

int LoadUnloadVehicle(Vehicle *v);

   350

   351

void TrainConsistChanged(Vehicle *v);

   352

void UpdateTrainAcceleration(Vehicle *v);

   353

int32 GetTrainRunningCost(const Vehicle *v);

   354

   355

int CheckTrainStoppedInDepot(const Vehicle *v);

   356

   357

bool VehicleNeedsService(const Vehicle *v);

   358

   359

typedef struct GetNewVehiclePosResult {

   360

	int x,y;

   361

	TileIndex old_tile;

   362

	TileIndex new_tile;

   363

} GetNewVehiclePosResult;

   364

   365

/**

   366

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

   367

 * Works for trains and ships.

   368

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

   369

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

   370

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

   371

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

   372

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

   373

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

   374

 * in depots), returns 0xFF.

   375

 */

   376

Trackdir GetVehicleTrackdir(const Vehicle* v);

   377

   378

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

   379

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

   380

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

   381

   382

#define BEGIN_ENUM_WAGONS(v) do {

   383

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

   384

   385

/* vehicle.c */

   386

VARDEF SortStruct *_vehicle_sort;

   387

   388

extern MemoryPool _vehicle_pool;

   389

   390

/**

   391

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

   392

 */

   393

static inline Vehicle *GetVehicle(VehicleID index)

   394

{

   395

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

   396

}

   397

   398

/**

   399

 * Get the current size of the VehiclePool

   400

 */

   401

static inline uint16 GetVehiclePoolSize(void)

   402

{

   403

	return _vehicle_pool.total_items;

   404

}

   405

   406

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

   407

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

   408

   409

/**

   410

 * Check if a Vehicle really exists.

   411

 */

   412

static inline bool IsValidVehicle(const Vehicle *v)

   413

{

   414

	return v->type != 0;

   415

}

   416

   417

/**

   418

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

   419

 *

   420

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

   421

 */

   422

static inline bool IsVehicleIndex(uint index)

   423

{

   424

	return index < GetVehiclePoolSize();

   425

}

   426

   427

/**

   428

 * Get the next real (non-articulated part) vehicle in the consist.

   429

 * @param v Vehicle.

   430

 * @return Next vehicle in the consist.

   431

 */

   432

static inline Vehicle *GetNextVehicle(const Vehicle *v)

   433

{

   434

	Vehicle *u = v->next;

   435

	while (u != NULL && u->subtype == TS_Artic_Part) {

   436

		u = u->next;

   437

	}

   438

	return u;

   439

}

   440

   441

/**

   442

 * Check if an engine has an articulated part.

   443

 * @param v Vehicle.

   444

 * @return True if the engine has an articulated part.

   445

 */

   446

static inline bool EngineHasArticPart(const Vehicle *v)

   447

{

   448

	return (v->next != NULL && v->next->subtype == TS_Artic_Part);

   449

}

   450

   451

/**

   452

 * Get the last part of a multi-part engine.

   453

 * @param v Vehicle.

   454

 * @return Last part of the engine.

   455

 */

   456

static inline Vehicle *GetLastEnginePart(Vehicle *v)

   457

{

   458

	while (EngineHasArticPart(v)) v = v->next;

   459

	return v;

   460

}

   461

   462

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

   463

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

   464

{

   465

	Order *order = v->orders;

   466

   467

	if (index < 0) return NULL;

   468

   469

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

   470

		order = order->next;

   471

   472

	return order;

   473

}

   474

   475

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

   476

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   477

{

   478

	Order *order = v->orders;

   479

   480

	if (order == NULL) return NULL;

   481

   482

	while (order->next != NULL)

   483

		order = order->next;

   484

   485

	return order;

   486

}

   487

   488

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

   489

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   490

{

   491

	Vehicle *u = v;

   492

	while (u->prev_shared != NULL)

   493

		u = u->prev_shared;

   494

   495

	return u;

   496

}

   497

   498

// NOSAVE: Can be regenerated by inspecting the vehicles.

   499