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_Not_First = 2,    // Wagon or additional engine

    34

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

    35

} TrainSubtype;

    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

	uint16 cached_weight;     // total weight of the consist.

    64

	uint16 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

    82

	byte flags;

    83

    84

	byte pbs_status;

    85

	TileIndex pbs_end_tile;

    86

	Trackdir pbs_end_trackdir;

    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

   100

typedef struct VehicleAir {

   101

	uint16 crashed_counter;

   102

	byte pos;

   103

  byte previous_pos;

   104

	uint16 targetairport;

   105

	byte state;

   106

} VehicleAir;

   107

   108

typedef struct VehicleRoad {

   109

	byte state;

   110

	byte frame;

   111

	uint16 unk2;

   112

	byte overtaking;

   113

	byte overtaking_ctr;

   114

	uint16 crashed_ctr;

   115

	byte reverse_ctr;

   116

	struct RoadStop *slot;

   117

	byte slotindex;

   118

	byte slot_age;

   119

} VehicleRoad;

   120

   121

typedef struct VehicleSpecial {

   122

	uint16 unk0;

   123

	byte unk2;

   124

} VehicleSpecial;

   125

   126

typedef struct VehicleDisaster {

   127

	uint16 image_override;

   128

	uint16 unk2;

   129

} VehicleDisaster;

   130

   131

typedef struct VehicleShip {

   132

	byte state;

   133

} VehicleShip;

   134

   135

// not used ATM

   136

struct WorldSprite {

   137

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

   138

	uint16 image;			// sprite number for this vehicle

   139

   140

	// screen coordinates

   141

	int16 left, top, right, bottom;

   142

   143

	// world coordinates

   144

	int16 x;

   145

	int16 y;

   146

	byte z;

   147

   148

	int8 x_offs;			// x offset for vehicle sprite

   149

	int8 y_offs;			// y offset for vehicle sprite

   150

   151

	byte width;				// width of vehicle sprite

   152

	byte height;			// height of vehicle sprite

   153

	byte depth;				// depth of vehicle sprite

   154

   155

	byte flags;				// draw flags

   156

};

   157

   158

struct Vehicle {

   159

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

   160

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

   161

   162

	VehicleID index;	// NOSAVE: Index in vehicle array

   163

   164

	Vehicle *next;		// next

   165

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

   166

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

   167

   168

	StringID string_id; // Displayed string

   169

   170

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

   171

	PlayerID owner;				// which player owns the vehicle?

   172

   173

	TileIndex tile;		// Current tile index

   174

	TileIndex dest_tile; // Heading for this tile

   175

   176

	int32 x_pos;			// coordinates

   177

	int32 y_pos;

   178

   179

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

   180

	byte z_pos;

   181

	byte direction;		// facing

   182

   183

	byte spritenum; // currently displayed sprite index

   184

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

   185

	                // 0xff == reserved for another custom sprite

   186

	uint16 cur_image; // sprite number for this vehicle

   187

	byte sprite_width;// width of vehicle sprite

   188

	byte sprite_height;// height of vehicle sprite

   189

	byte z_height;		// z-height of vehicle sprite

   190

	int8 x_offs;			// x offset for vehicle sprite

   191

	int8 y_offs;			// y offset for vehicle sprite

   192

	EngineID engine_type;

   193

   194

	// for randomized variational spritegroups

   195

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

   196

	// of corresponding spritegroups get matched

   197

	byte random_bits;

   198

	byte waiting_triggers; // triggers to be yet matched

   199

   200

	uint16 max_speed;	// maximum speed

   201

	uint16 cur_speed;	// current speed

   202

	byte subspeed;		// fractional speed

   203

	byte acceleration; // used by train & aircraft

   204

	byte progress;

   205

   206

	byte vehstatus;		// Status

   207

	uint16 last_station_visited;

   208

   209

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

   210

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

   211

	uint16 cargo_source;// source of cargo

   212

	uint16 cargo_cap;	// total capacity

   213

	uint16 cargo_count;// how many pieces are used

   214

   215

	byte day_counter; // increased by one for each day

   216

	byte tick_counter;// increased by one for each tick

   217

   218

	/* Begin Order-stuff */

   219

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

   220

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

   221

   222

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

   223

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

   224

   225

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

   226

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

   227

	/* End Order-stuff */

   228

   229

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

   230

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

   231

	int32 left_coord;

   232

	int32 top_coord;

   233

	int32 right_coord;

   234

	int32 bottom_coord;

   235

	uint16 next_hash;

   236

   237

	// Related to age and service time

   238

	uint16 age;				// Age in days

   239

	uint16 max_age;		// Maximum age

   240

	uint16 date_of_last_service;

   241

	uint16 service_interval;

   242

	uint16 reliability;

   243

	uint16 reliability_spd_dec;

   244

	byte breakdown_ctr;

   245

	byte breakdown_delay;

   246

	byte breakdowns_since_last_service;

   247

	byte breakdown_chance;

   248

	byte build_year;

   249

   250

	uint16 load_unload_time_rem;

   251

   252

	int32 profit_this_year;

   253

	int32 profit_last_year;

   254

	uint32 value;

   255

   256

   257

   258

	union {

   259

		VehicleRail rail;

   260

		VehicleAir air;

   261

		VehicleRoad road;

   262

		VehicleSpecial special;

   263

		VehicleDisaster disaster;

   264

		VehicleShip ship;

   265

	} u;

   266

};

   267

   268

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

   269

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

   270

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

   271

   272

typedef void VehicleTickProc(Vehicle *v);

   273

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

   274

   275

void VehicleServiceInDepot(Vehicle *v);

   276

Vehicle *AllocateVehicle(void);

   278

Vehicle *ForceAllocateVehicle(void);

   279

Vehicle *ForceAllocateSpecialVehicle(void);

   280

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

   281

void VehiclePositionChanged(Vehicle *v);

   282

void AfterLoadVehicles(void);

   283

Vehicle *GetLastVehicleInChain(Vehicle *v);

   284

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   285

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   286

int CountVehiclesInChain(Vehicle *v);

   287

void DeleteVehicle(Vehicle *v);

   288

void DeleteVehicleChain(Vehicle *v);

   289

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

   290

void CallVehicleTicks(void);

   291

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   292

   293

void InitializeTrains(void);

   294

   295

bool CanFillVehicle(Vehicle *v);

   296

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

   297

   298

void ViewportAddVehicles(DrawPixelInfo *dpi);

   299

   300

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   301

   302

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

   303

   304

/* train_cmd.h */

   305

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

   306

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

   307

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

   308

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

   309

   310

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

   311

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

   312

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

   313

   314

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

   315

   316

void VehicleInTheWayErrMsg(Vehicle *v);

   317

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

   318

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   319

   320

bool UpdateSignalsOnSegment(TileIndex tile, byte direction);

   321

void SetSignalsOnBothDir(TileIndex tile, byte track);

   322

   323

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

   324

   325

void DecreaseVehicleValue(Vehicle *v);

   326

void CheckVehicleBreakdown(Vehicle *v);

   327

void AgeVehicle(Vehicle *v);

   328

void VehicleEnteredDepotThisTick(Vehicle *v);

   329

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

   330

   331

void BeginVehicleMove(Vehicle *v);

   332

void EndVehicleMove(Vehicle *v);

   333

   334

bool IsAircraftHangarTile(TileIndex tile);

   335

void ShowAircraftViewWindow(const Vehicle* v);

   336

   337

UnitID GetFreeUnitNumber(byte type);

   338

   339

int LoadUnloadVehicle(Vehicle *v);

   340

   341

void TrainConsistChanged(Vehicle *v);

   342

void UpdateTrainAcceleration(Vehicle *v);

   343

int32 GetTrainRunningCost(const Vehicle *v);

   344

   345

int CheckTrainStoppedInDepot(const Vehicle *v);

   346

   347

bool VehicleNeedsService(const Vehicle *v);

   348

   349

typedef struct GetNewVehiclePosResult {

   350

	int x,y;

   351

	TileIndex old_tile;

   352

	TileIndex new_tile;

   353

} GetNewVehiclePosResult;

   354

   355

/**

   356

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

   357

 * Works for trains and ships.

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

 * in depots), returns 0xFF.

   365

 */

   366

Trackdir GetVehicleTrackdir(const Vehicle* v);

   367

   368

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

   369

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

   370

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

   371

   372

#define BEGIN_ENUM_WAGONS(v) do {

   373

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

   374

   375

/* vehicle.c */

   376

VARDEF SortStruct *_vehicle_sort;

   377

   378

extern MemoryPool _vehicle_pool;

   379

   380

/**

   381

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

   382

 */

   383

static inline Vehicle *GetVehicle(VehicleID index)

   384

{

   385

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

   386

}

   387

   388

/**

   389

 * Get the current size of the VehiclePool

   390

 */

   391

static inline uint16 GetVehiclePoolSize(void)

   392

{

   393

	return _vehicle_pool.total_items;

   394

}

   395

   396

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

   397

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

   398

   399

/**

   400

 * Check if a Vehicle really exists.

   401

 */

   402

static inline bool IsValidVehicle(const Vehicle *v)

   403

{

   404

	return v->type != 0;

   405

}

   406

   407

/**

   408

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

   409

 *

   410

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

   411

 */

   412

static inline bool IsVehicleIndex(uint index)

   413

{

   414

	return index < GetVehiclePoolSize();

   415

}

   416

   417

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

   418

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

   419

{

   420

	Order *order = v->orders;

   421

   422

	if (index < 0) return NULL;

   423

   424

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

   425

		order = order->next;

   426

   427

	return order;

   428

}

   429

   430

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

   431

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   432

{

   433

	Order *order = v->orders;

   434

   435

	if (order == NULL) return NULL;

   436

   437

	while (order->next != NULL)

   438

		order = order->next;

   439

   440

	return order;

   441

}

   442

   443

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

   444

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   445

{

   446

	Vehicle *u = v;

   447

	while (u->prev_shared != NULL)

   448

		u = u->prev_shared;

   449

   450

	return u;

   451

}

   452

   453

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

   454

VARDEF VehicleID _vehicle_position_hash[0x1000];

   455

   456

// NOSAVE: Return values from various commands.

   457

VARDEF VehicleID _new_train_id;

   458

VARDEF VehicleID _new_wagon_id;

   459

VARDEF VehicleID _new_aircraft_id;

   460

VARDEF VehicleID _new_ship_id;

   461

VARDEF VehicleID _new_roadveh_id;

   462

VARDEF VehicleID _new_vehicle_id;

   463

VARDEF uint16 _aircraft_refit_capacity;

   464

VARDEF byte _cmd_build_rail_veh_score;

   465

   466

#define INVALID_VEHICLE 0xFFFF

   467

#define INVALID_ENGINE 0xFFFF

   468

   469

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

   470

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

   471

#define STATUS_BAR 5

   472

   473

#endif /* VEHICLE_H */