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

	// Link between the two ends of a multiheaded engine

    78

	Vehicle *other_multiheaded_part;

    79

} VehicleRail;

    80

    81

enum {

    82

	VRF_REVERSING = 0,

    83

    84

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

    85

	VRF_GOINGUP   = 1,

    86

	VRF_GOINGDOWN = 2,

    87

    88

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

    89

	VRF_POWEREDWAGON = 3,

    90

};

    91

    92

typedef struct VehicleAir {

    93

	uint16 crashed_counter;

    94

	byte pos;

    95

  byte previous_pos;

    96

	uint16 targetairport;

    97

	byte state;

    98

} VehicleAir;

    99

   100

typedef struct VehicleRoad {

   101

	byte state;

   102

	byte frame;

   103

	uint16 unk2;

   104

	byte overtaking;

   105

	byte overtaking_ctr;

   106

	uint16 crashed_ctr;

   107

	byte reverse_ctr;

   108

	struct RoadStop *slot;

   109

	byte slotindex;

   110

	byte slot_age;

   111

} VehicleRoad;

   112

   113

typedef struct VehicleSpecial {

   114

	uint16 unk0;

   115

	byte unk2;

   116

} VehicleSpecial;

   117

   118

typedef struct VehicleDisaster {

   119

	uint16 image_override;

   120

	uint16 unk2;

   121

} VehicleDisaster;

   122

   123

typedef struct VehicleShip {

   124

	byte state;

   125

} VehicleShip;

   126

   127

   128

struct Vehicle {

   129

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

   130

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

   131

   132

	VehicleID index;	// NOSAVE: Index in vehicle array

   133

   134

	Vehicle *next;		// next

   135

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

   136

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

   137

   138

	StringID string_id; // Displayed string

   139

   140

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

   141

	PlayerID owner;				// which player owns the vehicle?

   142

   143

	TileIndex tile;		// Current tile index

   144

	TileIndex dest_tile; // Heading for this tile

   145

   146

	int32 x_pos;			// coordinates

   147

	int32 y_pos;

   148

	byte z_pos;

   149

	byte direction;		// facing

   150

   151

	byte spritenum; // currently displayed sprite index

   152

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

   153

	                // 0xff == reserved for another custom sprite

   154

	uint16 cur_image; // sprite number for this vehicle

   155

	byte sprite_width;// width of vehicle sprite

   156

	byte sprite_height;// height of vehicle sprite

   157

	byte z_height;		// z-height of vehicle sprite

   158

	int8 x_offs;			// x offset for vehicle sprite

   159

	int8 y_offs;			// y offset for vehicle sprite

   160

	EngineID engine_type;

   161

   162

	// for randomized variational spritegroups

   163

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

   164

	// of corresponding spritegroups get matched

   165

	byte random_bits;

   166

	byte waiting_triggers; // triggers to be yet matched

   167

   168

	uint16 max_speed;	// maximum speed

   169

	uint16 cur_speed;	// current speed

   170

	byte subspeed;		// fractional speed

   171

	byte acceleration; // used by train & aircraft

   172

	byte progress;

   173

   174

	byte vehstatus;		// Status

   175

	uint16 last_station_visited;

   176

   177

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

   178

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

   179

	uint16 cargo_source;// source of cargo

   180

	uint16 cargo_cap;	// total capacity

   181

	uint16 cargo_count;// how many pieces are used

   182

   183

	byte day_counter; // increased by one for each day

   184

	byte tick_counter;// increased by one for each tick

   185

   186

	/* Begin Order-stuff */

   187

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

   188

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

   189

   190

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

   191

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

   192

   193

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

   194

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

   195

	/* End Order-stuff */

   196

   197

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

   198

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

   199

	int32 left_coord;

   200

	int32 top_coord;

   201

	int32 right_coord;

   202

	int32 bottom_coord;

   203

	VehicleID next_hash;

   204

   205

	// Related to age and service time

   206

	uint16 age;				// Age in days

   207

	uint16 max_age;		// Maximum age

   208

	uint16 date_of_last_service;

   209

	uint16 service_interval;

   210

	uint16 reliability;

   211

	uint16 reliability_spd_dec;

   212

	byte breakdown_ctr;

   213

	byte breakdown_delay;

   214

	byte breakdowns_since_last_service;

   215

	byte breakdown_chance;

   216

	byte build_year;

   217

   218

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

   219

   220

	uint16 load_unload_time_rem;

   221

   222

	int32 profit_this_year;

   223

	int32 profit_last_year;

   224

	uint32 value;

   225

   226

	union {

   227

		VehicleRail rail;

   228

		VehicleAir air;

   229

		VehicleRoad road;

   230

		VehicleSpecial special;

   231

		VehicleDisaster disaster;

   232

		VehicleShip ship;

   233

	} u;

   234

};

   235

   236

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

   237

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

   238

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

   239

   240

typedef void VehicleTickProc(Vehicle *v);

   241

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

   242

   243

void VehicleServiceInDepot(Vehicle *v);

   244

Vehicle *AllocateVehicle(void);

   245

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

   246

Vehicle *ForceAllocateVehicle(void);

   247

Vehicle *ForceAllocateSpecialVehicle(void);

   248

void VehiclePositionChanged(Vehicle *v);

   249

void AfterLoadVehicles(void);

   250

Vehicle *GetLastVehicleInChain(Vehicle *v);

   251

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   252

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   253

uint CountVehiclesInChain(const Vehicle* v);

   254

void DeleteVehicle(Vehicle *v);

   255

void DeleteVehicleChain(Vehicle *v);

   256

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

   257

void CallVehicleTicks(void);

   258

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   259

   260

void InitializeTrains(void);

   261

byte VehicleRandomBits(void);

   262

   263

bool CanFillVehicle(Vehicle *v);

   264

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

   265

   266

void ViewportAddVehicles(DrawPixelInfo *dpi);

   267

   268

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   269

   270

/* train_cmd.h */

   271

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

   272

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

   273

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

   274

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

   275

   276

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

   277

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

   278

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

   279

   280

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

   281

   282

void VehicleInTheWayErrMsg(const Vehicle* v);

   283

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

   284

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   285

   286

bool UpdateSignalsOnSegment(TileIndex tile, byte direction);

   287

void SetSignalsOnBothDir(TileIndex tile, byte track);

   288

   289

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

   290

   291

void DecreaseVehicleValue(Vehicle *v);

   292

void CheckVehicleBreakdown(Vehicle *v);

   293

void AgeVehicle(Vehicle *v);

   294

void VehicleEnteredDepotThisTick(Vehicle *v);

   295

   296

void BeginVehicleMove(Vehicle *v);

   297

void EndVehicleMove(Vehicle *v);

   298

   299

bool IsAircraftHangarTile(TileIndex tile);

   300

void ShowAircraftViewWindow(const Vehicle* v);

   301

   302

UnitID GetFreeUnitNumber(byte type);

   303

   304

int LoadUnloadVehicle(Vehicle *v);

   305

   306

void TrainConsistChanged(Vehicle *v);

   307

int32 GetTrainRunningCost(const Vehicle *v);

   308

   309

int CheckTrainStoppedInDepot(const Vehicle *v);

   310

   311

bool VehicleNeedsService(const Vehicle *v);

   312

   313

typedef struct GetNewVehiclePosResult {

   314

	int x,y;

   315

	TileIndex old_tile;

   316

	TileIndex new_tile;

   317

} GetNewVehiclePosResult;

   318

   319

/**

   320

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

   321

 * Works for trains and ships.

   322

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

   323

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

   324

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

   325

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

   326

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

   327

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

   328

 * in depots), returns 0xFF.

   329

 */

   330

Trackdir GetVehicleTrackdir(const Vehicle* v);

   331

   332

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

   333

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

   334

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

   335

   336

#define BEGIN_ENUM_WAGONS(v) do {

   337

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

   338

   339

extern MemoryPool _vehicle_pool;

   340

   341

/**

   342

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

   343

 */

   344

static inline Vehicle *GetVehicle(VehicleID index)

   345

{

   346

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

   347

}

   348

   349

/**

   350

 * Get the current size of the VehiclePool

   351

 */

   352

static inline uint16 GetVehiclePoolSize(void)

   353

{

   354

	return _vehicle_pool.total_items;

   355

}

   356

   357

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

   358

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

   359

   360

/**

   361

 * Check if a Vehicle really exists.

   362

 */

   363

static inline bool IsValidVehicle(const Vehicle *v)

   364

{

   365

	return v->type != 0;

   366

}

   367

   368

/**

   369

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

   370

 *

   371

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

   372

 */

   373

static inline bool IsVehicleIndex(uint index)

   374

{

   375

	return index < GetVehiclePoolSize();

   376

}

   377

   378

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

   379

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

   380

{

   381

	Order *order = v->orders;

   382

   383

	if (index < 0) return NULL;

   384

   385

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

   386

		order = order->next;

   387

   388

	return order;

   389

}

   390

   391

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

   392

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   393

{

   394

	Order *order = v->orders;

   395

   396

	if (order == NULL) return NULL;

   397

   398

	while (order->next != NULL)

   399

		order = order->next;

   400

   401

	return order;

   402

}

   403

   404

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

   405

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   406

{

   407

	Vehicle *u = v;

   408

	while (u->prev_shared != NULL)

   409

		u = u->prev_shared;

   410

   411

	return u;

   412

}

   413

   414

// NOSAVE: Return values from various commands.

   415

VARDEF VehicleID _new_train_id;

   416

VARDEF VehicleID _new_wagon_id;

   417

VARDEF VehicleID _new_aircraft_id;

   418

VARDEF VehicleID _new_ship_id;

   419

VARDEF VehicleID _new_roadveh_id;

   420

VARDEF VehicleID _new_vehicle_id;

   421

VARDEF uint16 _aircraft_refit_capacity;

   422

VARDEF byte _cmd_build_rail_veh_score;

   423

   424

#define INVALID_VEHICLE 0xFFFF

   425

   426

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

   427

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

   428

#define STATUS_BAR 5

   429

   430

#endif /* VEHICLE_H */