1

/* $Id$ */

     2

     3

#ifndef VEHICLE_H

     4

#define VEHICLE_H

     5

     6

#include "oldpool.h"

     7

#include "order.h"

     8

#include "rail.h"

     9

    10

enum {

    11

	VEH_Invalid  = 0x00,

    12

	VEH_Train    = 0x10,

    13

	VEH_Road     = 0x11,

    14

	VEH_Ship     = 0x12,

    15

	VEH_Aircraft = 0x13,

    16

	VEH_Special  = 0x14,

    17

	VEH_Disaster = 0x15,

    18

} ;

    19

    20

enum VehStatus {

    21

	VS_HIDDEN          = 0x01,

    22

	VS_STOPPED         = 0x02,

    23

	VS_UNCLICKABLE     = 0x04,

    24

	VS_DEFPAL          = 0x08,

    25

	VS_TRAIN_SLOWING   = 0x10,

    26

	VS_SHADOW          = 0x20,

    27

	VS_AIRCRAFT_BROKEN = 0x40,

    28

	VS_CRASHED         = 0x80,

    29

};

    30

    31

enum LoadStatus {

    32

	LS_LOADING_FINISHED,

    33

	LS_CARGO_UNLOADING,

    34

	/* LS_CARGO_PAID_FOR was here until savegame version 45. */

    35

};

    36

    37

/* Effect vehicle types */

    38

typedef enum EffectVehicle {

    39

	EV_CHIMNEY_SMOKE   = 0,

    40

	EV_STEAM_SMOKE     = 1,

    41

	EV_DIESEL_SMOKE    = 2,

    42

	EV_ELECTRIC_SPARK  = 3,

    43

	EV_SMOKE           = 4,

    44

	EV_EXPLOSION_LARGE = 5,

    45

	EV_BREAKDOWN_SMOKE = 6,

    46

	EV_EXPLOSION_SMALL = 7,

    47

	EV_BULLDOZER       = 8,

    48

	EV_BUBBLE          = 9

    49

} EffectVehicle;

    50

    51

typedef struct VehicleRail {

    52

	uint16 last_speed; // NOSAVE: only used in UI

    53

	uint16 crash_anim_pos;

    54

	uint16 days_since_order_progr;

    55

    56

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

    57

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

    58

	uint32 cached_power;      // total power of the consist.

    59

	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

    60

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

    61

    62

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

    63

	uint32 cached_weight;     // total weight of the consist.

    64

	uint32 cached_veh_weight; // weight of the vehicle.

    65

	uint32 cached_max_te;     // max tractive effort of consist

    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

	TrackBitsByte track;

    80

	byte force_proceed;

    81

	RailTypeByte railtype;

    82

	RailTypeMask compatible_railtypes;

    83

    84

	byte flags;

    85

    86

	// Link between the two ends of a multiheaded engine

    87

	Vehicle *other_multiheaded_part;

    88

} VehicleRail;

    89

    90

enum {

    91

	VRF_REVERSING         = 0,

    92

    93

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

    94

	VRF_GOINGUP           = 1,

    95

	VRF_GOINGDOWN         = 2,

    96

    97

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

    98

	VRF_POWEREDWAGON      = 3,

    99

   100

	// used to reverse the visible direction of the vehicle

   101

	VRF_REVERSE_DIRECTION = 4,

   102

   103

	// used to mark train as lost because PF can't find the route

   104

	VRF_NO_PATH_TO_DESTINATION = 5,

   105

   106

	// used to mark that electric train engine is allowed to run on normal rail

   107

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   108

};

   109

   110

typedef struct VehicleAir {

   111

	uint16 crashed_counter;

   112

	byte pos;

   113

	byte previous_pos;

   114

	StationID targetairport;

   115

	byte state;

   116

} VehicleAir;

   117

   118

typedef struct VehicleRoad {

   119

	byte state;

   120

	byte frame;

   121

	uint16 blocked_ctr;

   122

	byte overtaking;

   123

	byte overtaking_ctr;

   124

	uint16 crashed_ctr;

   125

	byte reverse_ctr;

   126

	struct RoadStop *slot;

   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

	TrackBitsByte state;

   142

} VehicleShip;

   143

   144

   145

struct Vehicle {

   146

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

   147

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

   148

   149

	VehicleID index;         // NOSAVE: Index in vehicle array

   150

   151

	Vehicle *next;           // next

   152

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

   153

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

   154

   155

	StringID string_id;      // Displayed string

   156

   157

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

   158

	PlayerByte owner;          // which player owns the vehicle?

   159

   160

	TileIndex tile;          // Current tile index

   161

	TileIndex dest_tile;     // Heading for this tile

   162

   163

	int32 x_pos;             // coordinates

   164

	int32 y_pos;

   165

	byte z_pos;

   166

	DirectionByte direction; // facing

   167

   168

	byte spritenum;          // currently displayed sprite index

   169

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

   170

	                         // 0xff == reserved for another custom sprite

   171

	uint16 cur_image;        // sprite number for this vehicle

   172

	byte sprite_width;       // width of vehicle sprite

   173

	byte sprite_height;      // height of vehicle sprite

   174

	byte z_height;           // z-height of vehicle sprite

   175

	int8 x_offs;             // x offset for vehicle sprite

   176

	int8 y_offs;             // y offset for vehicle sprite

   177

	EngineID engine_type;

   178

   179

	// for randomized variational spritegroups

   180

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

   181

	// of corresponding spritegroups get matched

   182

	byte random_bits;

   183

	byte waiting_triggers;   // triggers to be yet matched

   184

   185

	uint16 max_speed;        // maximum speed

   186

	uint16 cur_speed;        // current speed

   187

	byte subspeed;           // fractional speed

   188

	byte acceleration;       // used by train & aircraft

   189

	byte progress;

   190

	uint32 motion_counter;

   191

   192

	byte vehstatus;          // Status

   193

	StationID last_station_visited;

   194

   195

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

   196

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

   197

	StationID cargo_source;  // source of cargo

   198

	TileIndex cargo_source_xy; //< stores the Tile where the source station is located, in case it is removed

   199

	uint16 cargo_cap;        // total capacity

   200

	uint16 cargo_count;      // how many pieces are used

   201

	byte cargo_subtype;      ///< Used for livery refits (NewGRF variations)

   202

   203

	byte day_counter;        // increased by one for each day

   204

	byte tick_counter;       // increased by one for each tick

   205

   206

	/* Begin Order-stuff */

   207

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

   208

	VehicleOrderID cur_order_index; ///< The index to the current order

   209

   210

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

   211

	VehicleOrderID num_orders;      ///< How many orders there are in the list

   212

   213

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

   214

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

   215

	/* End Order-stuff */

   216

   217

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

   218

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

   219

	int32 left_coord;

   220

	int32 top_coord;

   221

	int32 right_coord;

   222

	int32 bottom_coord;

   223

	Vehicle *next_hash;

   224

   225

	// Related to age and service time

   226

	Date age;     // Age in days

   227

	Date max_age; // Maximum age

   228

	Date date_of_last_service;

   229

	Date service_interval;

   230

	uint16 reliability;

   231

	uint16 reliability_spd_dec;

   232

	byte breakdown_ctr;

   233

	byte breakdown_delay;

   234

	byte breakdowns_since_last_service;

   235

	byte breakdown_chance;

   236

	Year build_year;

   237

   238

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

   239

   240

	uint16 load_unload_time_rem;

   241

	uint16 cargo_paid_for;      // How much of the cargo currently on board has been paid for.

   242

	byte load_status;

   243

   244

	int32 profit_this_year;

   245

	int32 profit_last_year;

   246

	uint32 value;

   247

   248

	union {

   249

		VehicleRail rail;

   250

		VehicleAir air;

   251

		VehicleRoad road;

   252

		VehicleSpecial special;

   253

		VehicleDisaster disaster;

   254

		VehicleShip ship;

   255

	} u;

   256

   257

	void BeginLoading();

   258

	void LeaveStation();

   259

};

   260

   261

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

   262

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

   263

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

   264

   265

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

   266

   267

void VehicleServiceInDepot(Vehicle *v);

   268

Vehicle *AllocateVehicle(void);

   269

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

   270

Vehicle *ForceAllocateVehicle(void);

   271

Vehicle *ForceAllocateSpecialVehicle(void);

   272

void VehiclePositionChanged(Vehicle *v);

   273

void AfterLoadVehicles(void);

   274

Vehicle *GetLastVehicleInChain(Vehicle *v);

   275

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   276

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   277

uint CountVehiclesInChain(const Vehicle* v);

   278

bool IsEngineCountable(const Vehicle *v);

   279

void DeleteVehicleChain(Vehicle *v);

   280

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

   281

void CallVehicleTicks(void);

   282

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   283

   284

void InitializeTrains(void);

   285

byte VehicleRandomBits(void);

   286

void ResetVehiclePosHash(void);

   287

   288

bool CanFillVehicle(Vehicle *v);

   289

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

   290

CargoID FindFirstRefittableCargo(EngineID engine_type);

   291

int32 GetRefitCost(EngineID engine_type);

   292

   293

void ViewportAddVehicles(DrawPixelInfo *dpi);

   294

   295

/* train_cmd.h */

   296

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

   297

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

   298

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

   299

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

   300

SpriteID GetRotorImage(const Vehicle *v);

   301

   302

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

   303

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

   304

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

   305

   306

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

   307

   308

StringID VehicleInTheWayErrMsg(const Vehicle* v);

   309

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

   310

   311

bool UpdateSignalsOnSegment(TileIndex tile, DiagDirection direction);

   312

void SetSignalsOnBothDir(TileIndex tile, byte track);

   313

   314

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

   315

   316

void DecreaseVehicleValue(Vehicle *v);

   317

void CheckVehicleBreakdown(Vehicle *v);

   318

void AgeVehicle(Vehicle *v);

   319

void VehicleEnteredDepotThisTick(Vehicle *v);

   320

   321

void BeginVehicleMove(Vehicle *v);

   322

void EndVehicleMove(Vehicle *v);

   323

   324

void ShowAircraftViewWindow(const Vehicle* v);

   325

   326

UnitID GetFreeUnitNumber(byte type);

   327

   328

int LoadUnloadVehicle(Vehicle *v, bool just_arrived);

   329

   330

void TrainConsistChanged(Vehicle *v);

   331

void TrainPowerChanged(Vehicle *v);

   332

int32 GetTrainRunningCost(const Vehicle *v);

   333

   334

int CheckTrainStoppedInDepot(const Vehicle *v);

   335

   336

bool VehicleNeedsService(const Vehicle *v);

   337

   338

uint GenerateVehicleSortList(const Vehicle*** sort_list, uint16 *length_of_array, byte type, PlayerID owner, uint32 index, uint16 window_type);

   339

void BuildDepotVehicleList(byte type, TileIndex tile, Vehicle ***engine_list, uint16 *engine_list_length, uint16 *engine_count, Vehicle ***wagon_list, uint16 *wagon_list_length, uint16 *wagon_count);

   340

int32 SendAllVehiclesToDepot(byte type, uint32 flags, bool service, PlayerID owner, uint16 vlw_flag, uint32 id);

   341

bool IsVehicleInDepot(const Vehicle *v);

   342

void VehicleEnterDepot(Vehicle *v);

   343

   344

/* Flags to add to p2 for goto depot commands */

   345

/* Note: bits 8-10 are used for VLW flags */

   346

enum {

   347

	DEPOT_SERVICE       = (1 << 0),	// The vehicle will leave the depot right after arrival (serivce only)

   348

	DEPOT_MASS_SEND     = (1 << 1), // Tells that it's a mass send to depot command (type in VLW flag)

   349

	DEPOT_DONT_CANCEL   = (1 << 2), // Don't cancel current goto depot command if any

   350

	DEPOT_LOCATE_HANGAR = (1 << 3), // Find another airport if the target one lacks a hangar

   351

};

   352

   353

typedef struct GetNewVehiclePosResult {

   354

	int x,y;

   355

	TileIndex old_tile;

   356

	TileIndex new_tile;

   357

} GetNewVehiclePosResult;

   358

   359

/**

   360

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

   361

 * Works for trains and ships.

   362

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

   363

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

   364

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

   365

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

   366

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

   367

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

   368

 * in depots), returns 0xFF.

   369

 */

   370

Trackdir GetVehicleTrackdir(const Vehicle* v);

   371

   372

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

   373

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

   374

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

   375

   376

#define BEGIN_ENUM_WAGONS(v) do {

   377

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

   378

   379

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   380

   381

static inline VehicleID GetMaxVehicleIndex(void)

   382

{

   383

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

   384

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

   385

	 *  _really_ returns the highest index. Now it just returns

   386

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

   387

	 */

   388

	return GetVehiclePoolSize() - 1;

   389

}

   390

   391

static inline uint GetNumVehicles(void)

   392

{

   393

	return GetVehiclePoolSize();

   394

}

   395

   396

/**

   397

 * Check if a Vehicle really exists.

   398

 */

   399

static inline bool IsValidVehicle(const Vehicle *v)

   400

{

   401

	return v->type != 0;

   402

}

   403

   404

void DestroyVehicle(Vehicle *v);

   405

   406

static inline void DeleteVehicle(Vehicle *v)

   407

{

   408

	DestroyVehicle(v);

   409

	v->type = 0;

   410

}

   411

   412

static inline bool IsPlayerBuildableVehicleType(byte type)

   413

{

   414

	switch (type) {

   415

		case VEH_Train:

   416

		case VEH_Road:

   417

		case VEH_Ship:

   418

		case VEH_Aircraft:

   419

			return true;

   420

	}

   421

	return false;

   422

}

   423

   424

static inline bool IsPlayerBuildableVehicleType(const Vehicle *v)

   425

{

   426

	return IsPlayerBuildableVehicleType(v->type);

   427

}

   428

   429

/** Function to give index of a vehicle type

   430

 *  Since the return value is 0 for VEH_train, it's perfect for index to arrays

   431

 */

   432

static inline byte VehTypeToIndex(byte type)

   433

{

   434

	assert(IsPlayerBuildableVehicleType(type));

   435

	return type - VEH_Train;

   436

}

   437

   438

static inline byte VehTypeToIndex(const Vehicle *v)

   439

{

   440

	return VehTypeToIndex(v->type);

   441

}

   442

   443

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

   444

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

   445

   446

/**

   447

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

   448

 *

   449

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

   450

 */

   451

static inline bool IsValidVehicleID(uint index)

   452

{

   453

	return index < GetVehiclePoolSize() && IsValidVehicle(GetVehicle(index));

   454

}

   455

   456

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

   457

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

   458

{

   459

	Order *order = v->orders;

   460

   461

	if (index < 0) return NULL;

   462

   463

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

   464

		order = order->next;

   465

   466

	return order;

   467

}

   468

   469

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

   470

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   471

{

   472

	Order *order = v->orders;

   473

   474

	if (order == NULL) return NULL;

   475

   476

	while (order->next != NULL)

   477

		order = order->next;

   478

   479

	return order;

   480

}

   481

   482

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

   483

static inline Vehicle *GetFirstVehicleFromSharedList(const Vehicle *v)

   484

{

   485

	Vehicle *u = (Vehicle *)v;

   486

	while (u->prev_shared != NULL) u = u->prev_shared;

   487

   488

	return u;

   489

}

   490