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,

    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

	/**

    66

	 * Position/type of visual effect.

    67

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

    68

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

    69

	 * bit     6 = disable visual effect.

    70

	 * bit     7 = disable powered wagons.

    71

	 */

    72

	byte cached_vis_effect;

    73

    74

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

    75

	// 0xffff == not in train

    76

	EngineID first_engine;

    77

    78

	byte track;

    79

	byte force_proceed;

    80

	byte railtype;

    81

	RailTypeMask compatible_railtypes;

    82

    83

	byte flags;

    84

    85

	// Link between the two ends of a multiheaded engine

    86

	Vehicle *other_multiheaded_part;

    87

} VehicleRail;

    88

    89

enum {

    90

	VRF_REVERSING         = 0,

    91

    92

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

    93

	VRF_GOINGUP           = 1,

    94

	VRF_GOINGDOWN         = 2,

    95

    96

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

    97

	VRF_POWEREDWAGON      = 3,

    98

    99

	// used to reverse the visible direction of the vehicle

   100

	VRF_REVERSE_DIRECTION = 4,

   101

   102

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

   103

	VRF_NO_PATH_TO_DESTINATION = 5,

   104

   105

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

   106

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   107

};

   108

   109

typedef struct VehicleAir {

   110

	uint16 crashed_counter;

   111

	byte pos;

   112

	byte previous_pos;

   113

	StationID targetairport;

   114

	byte state;

   115

} VehicleAir;

   116

   117

typedef struct VehicleRoad {

   118

	byte state;

   119

	byte frame;

   120

	uint16 blocked_ctr;

   121

	byte overtaking;

   122

	byte overtaking_ctr;

   123

	uint16 crashed_ctr;

   124

	byte reverse_ctr;

   125

	struct RoadStop *slot;

   126

	byte slot_age;

   127

} VehicleRoad;

   128

   129

typedef struct VehicleSpecial {

   130

	uint16 unk0;

   131

	byte unk2;

   132

} VehicleSpecial;

   133

   134

typedef struct VehicleDisaster {

   135

	uint16 image_override;

   136

	uint16 unk2;

   137

} VehicleDisaster;

   138

   139

typedef struct VehicleShip {

   140

	byte state;

   141

} VehicleShip;

   142

   143

   144

struct Vehicle {

   145

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

   146

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

   147

   148

	VehicleID index;         // NOSAVE: Index in vehicle array

   149

   150

	Vehicle *next;           // next

   151

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

   152

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

   153

   154

	StringID string_id;      // Displayed string

   155

   156

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

   157

	PlayerID owner;          // which player owns the vehicle?

   158

   159

	TileIndex tile;          // Current tile index

   160

	TileIndex dest_tile;     // Heading for this tile

   161

   162

	int32 x_pos;             // coordinates

   163

	int32 y_pos;

   164

	byte z_pos;

   165

	byte direction;          // facing

   166

   167

	byte spritenum;          // currently displayed sprite index

   168

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

   169

	                         // 0xff == reserved for another custom sprite

   170

	uint16 cur_image;        // sprite number for this vehicle

   171

	byte sprite_width;       // width of vehicle sprite

   172

	byte sprite_height;      // height of vehicle sprite

   173

	byte z_height;           // z-height of vehicle sprite

   174

	int8 x_offs;             // x offset for vehicle sprite

   175

	int8 y_offs;             // y offset for vehicle sprite

   176

	EngineID engine_type;

   177

   178

	// for randomized variational spritegroups

   179

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

   180

	// of corresponding spritegroups get matched

   181

	byte random_bits;

   182

	byte waiting_triggers;   // triggers to be yet matched

   183

   184

	uint16 max_speed;        // maximum speed

   185

	uint16 cur_speed;        // current speed

   186

	byte subspeed;           // fractional speed

   187

	byte acceleration;       // used by train & aircraft

   188

	byte progress;

   189

	uint32 motion_counter;

   190

   191

	byte vehstatus;          // Status

   192

	StationID last_station_visited;

   193

   194

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

   195

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

   196

	StationID cargo_source;  // source of cargo

   197

	uint16 cargo_cap;        // total capacity

   198

	uint16 cargo_count;      // how many pieces are used

   199

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

   200

   201

	byte day_counter;        // increased by one for each day

   202

	byte tick_counter;       // increased by one for each tick

   203

   204

	/* Begin Order-stuff */

   205

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

   206

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

   207

   208

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

   209

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

   210

   211

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

   212

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

   213

	/* End Order-stuff */

   214

   215

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

   216

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

   217

	int32 left_coord;

   218

	int32 top_coord;

   219

	int32 right_coord;

   220

	int32 bottom_coord;

   221

	VehicleID next_hash;

   222

   223

	// Related to age and service time

   224

	Date age;     // Age in days

   225

	Date max_age; // Maximum age

   226

	Date date_of_last_service;

   227

	Date service_interval;

   228

	uint16 reliability;

   229

	uint16 reliability_spd_dec;

   230

	byte breakdown_ctr;

   231

	byte breakdown_delay;

   232

	byte breakdowns_since_last_service;

   233

	byte breakdown_chance;

   234

	Year build_year;

   235

   236

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

   237

   238

	uint16 load_unload_time_rem;

   239

	byte load_status;

   240

   241

	int32 profit_this_year;

   242

	int32 profit_last_year;

   243

	uint32 value;

   244

   245

	union {

   246

		VehicleRail rail;

   247

		VehicleAir air;

   248

		VehicleRoad road;

   249

		VehicleSpecial special;

   250

		VehicleDisaster disaster;

   251

		VehicleShip ship;

   252

	} u;

   253

};

   254

   255

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

   256

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

   257

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

   258

   259

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

   260

   261

void VehicleServiceInDepot(Vehicle *v);

   262

Vehicle *AllocateVehicle(void);

   263

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

   264

Vehicle *ForceAllocateVehicle(void);

   265

Vehicle *ForceAllocateSpecialVehicle(void);

   266

void VehiclePositionChanged(Vehicle *v);

   267

void AfterLoadVehicles(void);

   268

Vehicle *GetLastVehicleInChain(Vehicle *v);

   269

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   270

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   271

uint CountVehiclesInChain(const Vehicle* v);

   272

bool IsEngineCountable(const Vehicle *v);

   273

void DeleteVehicleChain(Vehicle *v);

   274

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

   275

void CallVehicleTicks(void);

   276

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   277

   278

void InitializeTrains(void);

   279

byte VehicleRandomBits(void);

   280

void ResetVehiclePosHash(void);

   281

   282

bool CanFillVehicle(Vehicle *v);

   283

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

   284

CargoID FindFirstRefittableCargo(EngineID engine_type);

   285

int32 GetRefitCost(EngineID engine_type);

   286

   287

void ViewportAddVehicles(DrawPixelInfo *dpi);

   288

   289

/* train_cmd.h */

   290

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

   291

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

   292

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

   293

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

   294

   295

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

   296

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

   297

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

   298

   299

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

   300

   301

StringID VehicleInTheWayErrMsg(const Vehicle* v);

   302

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

   303

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   304

   305

bool UpdateSignalsOnSegment(TileIndex tile, DiagDirection direction);

   306

void SetSignalsOnBothDir(TileIndex tile, byte track);

   307

   308

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

   309

   310

void DecreaseVehicleValue(Vehicle *v);

   311

void CheckVehicleBreakdown(Vehicle *v);

   312

void AgeVehicle(Vehicle *v);

   313

void VehicleEnteredDepotThisTick(Vehicle *v);

   314

   315

void BeginVehicleMove(Vehicle *v);

   316

void EndVehicleMove(Vehicle *v);

   317

   318

void ShowAircraftViewWindow(const Vehicle* v);

   319

   320

UnitID GetFreeUnitNumber(byte type);

   321

   322

int LoadUnloadVehicle(Vehicle *v, bool just_arrived);

   323

   324

void TrainConsistChanged(Vehicle *v);

   325

void TrainPowerChanged(Vehicle *v);

   326

int32 GetTrainRunningCost(const Vehicle *v);

   327

   328

int CheckTrainStoppedInDepot(const Vehicle *v);

   329

   330

bool VehicleNeedsService(const Vehicle *v);

   331

   332

uint GenerateVehicleSortList(const Vehicle*** sort_list, uint16 *length_of_array, byte type, PlayerID owner, StationID station, OrderID order, uint32 depot_airport_index, uint16 window_type);

   333

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);

   334

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

   335

bool IsVehicleInDepot(const Vehicle *v);

   336

void VehicleEnterDepot(Vehicle *v);

   337

   338

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

   339

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

   340

enum {

   341

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

   342

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

   343

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

   344

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

   345

};

   346

   347

typedef struct GetNewVehiclePosResult {

   348

	int x,y;

   349

	TileIndex old_tile;

   350

	TileIndex new_tile;

   351

} GetNewVehiclePosResult;

   352

   353

/**

   354

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

   355

 * Works for trains and ships.

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

 * in depots), returns 0xFF.

   363

 */

   364

Trackdir GetVehicleTrackdir(const Vehicle* v);

   365

   366

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

   367

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

   368

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

   369

   370

#define BEGIN_ENUM_WAGONS(v) do {

   371

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

   372

   373

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   374

   375

static inline VehicleID GetMaxVehicleIndex(void)

   376

{

   377

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

   378

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

   379

	 *  _really_ returns the highest index. Now it just returns

   380

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

   381

	 */

   382

	return GetVehiclePoolSize() - 1;

   383

}

   384

   385

static inline uint GetNumVehicles(void)

   386

{

   387

	return GetVehiclePoolSize();

   388

}

   389

   390

/**

   391

 * Check if a Vehicle really exists.

   392

 */

   393

static inline bool IsValidVehicle(const Vehicle *v)

   394

{

   395

	return v->type != 0;

   396

}

   397

   398

void DestroyVehicle(Vehicle *v);

   399

   400

static inline void DeleteVehicle(Vehicle *v)

   401

{

   402

	DestroyVehicle(v);

   403

	v->type = 0;

   404

}

   405

   406

static inline bool IsPlayerBuildableVehicleType(const Vehicle *v)

   407

{

   408

	switch (v->type) {

   409

		case VEH_Train:

   410

		case VEH_Road:

   411

		case VEH_Ship:

   412

		case VEH_Aircraft:

   413

			return true;

   414

	}

   415

	return false;

   416

}

   417

   418

#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))

   419

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

   420

   421

/**

   422

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

   423

 *

   424

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

   425

 */

   426

static inline bool IsValidVehicleID(uint index)

   427

{

   428

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

   429

}

   430

   431

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

   432

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

   433

{

   434

	Order *order = v->orders;

   435

   436

	if (index < 0) return NULL;

   437

   438

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

   439

		order = order->next;

   440

   441

	return order;

   442

}

   443

   444

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

   445

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   446

{

   447

	Order *order = v->orders;

   448

   449

	if (order == NULL) return NULL;

   450

   451

	while (order->next != NULL)

   452

		order = order->next;

   453

   454

	return order;

   455

}

   456

   457

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

   458

static inline Vehicle *GetFirstVehicleFromSharedList(const Vehicle *v)

   459

{

   460

	Vehicle *u = (Vehicle *)v;

   461

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

   462

   463

	return u;

   464

}

   465

   466

// NOSAVE: Return values from various commands.

   467

VARDEF VehicleID _new_vehicle_id;

   468

VARDEF uint16 _returned_refit_capacity;

   469

   470

enum {

   471

	INVALID_VEHICLE = 0xFFFF,

   472

};

   473

   474

/**

   475

 * Get the colour map for an engine. This used for unbuilt engines in the user interface.

   476

 * @param engine_type ID of engine

   477

 * @param player ID of player

   478

 * @return A ready-to-use palette modifier

   479

 */

   480

PalSpriteID GetEnginePalette(EngineID engine_type, PlayerID player);

   481

   482

/**

   483

 * Get the colour map for a vehicle.

   484

 * @param v Vehicle to get colour map for

   485

 * @return A ready-to-use palette modifier

   486

 */

   487

PalSpriteID GetVehiclePalette(const Vehicle *v);

   488

   489

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

   490

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

   491

#define STATUS_BAR 5