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

	RailTypeMask compatible_railtypes;

    75

    76

	byte flags;

    77

    78

	// Link between the two ends of a multiheaded engine

    79

	Vehicle *other_multiheaded_part;

    80

} VehicleRail;

    81

    82

enum {

    83

	VRF_REVERSING = 0,

    84

    85

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

    86

	VRF_GOINGUP   = 1,

    87

	VRF_GOINGDOWN = 2,

    88

    89

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

    90

	VRF_POWEREDWAGON = 3,

    91

    92

	// used to reverse the visible direction of the vehicle

    93

	VRF_REVERSE_DIRECTION = 4,

    94

};

    95

    96

typedef struct VehicleAir {

    97

	uint16 crashed_counter;

    98

	byte pos;

    99

  byte previous_pos;

   100

	StationID targetairport;

   101

	byte state;

   102

} VehicleAir;

   103

   104

typedef struct VehicleRoad {

   105

	byte state;

   106

	byte frame;

   107

	uint16 blocked_ctr;

   108

	byte overtaking;

   109

	byte overtaking_ctr;

   110

	uint16 crashed_ctr;

   111

	byte reverse_ctr;

   112

	struct RoadStop *slot;

   113

	byte slot_age;

   114

} VehicleRoad;

   115

   116

typedef struct VehicleSpecial {

   117

	uint16 unk0;

   118

	byte unk2;

   119

} VehicleSpecial;

   120

   121

typedef struct VehicleDisaster {

   122

	uint16 image_override;

   123

	uint16 unk2;

   124

} VehicleDisaster;

   125

   126

typedef struct VehicleShip {

   127

	byte state;

   128

} VehicleShip;

   129

   130

   131

struct Vehicle {

   132

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

   133

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

   134

   135

	VehicleID index;	// NOSAVE: Index in vehicle array

   136

   137

	Vehicle *next;		// next

   138

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

   139

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

   140

   141

	StringID string_id; // Displayed string

   142

   143

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

   144

	PlayerID owner;				// which player owns the vehicle?

   145

   146

	TileIndex tile;		// Current tile index

   147

	TileIndex dest_tile; // Heading for this tile

   148

   149

	int32 x_pos;			// coordinates

   150

	int32 y_pos;

   151

	byte z_pos;

   152

	byte direction;		// facing

   153

   154

	byte spritenum; // currently displayed sprite index

   155

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

   156

	                // 0xff == reserved for another custom sprite

   157

	uint16 cur_image; // sprite number for this vehicle

   158

	byte sprite_width;// width of vehicle sprite

   159

	byte sprite_height;// height of vehicle sprite

   160

	byte z_height;		// z-height of vehicle sprite

   161

	int8 x_offs;			// x offset for vehicle sprite

   162

	int8 y_offs;			// y offset for vehicle sprite

   163

	EngineID engine_type;

   164

   165

	// for randomized variational spritegroups

   166

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

   167

	// of corresponding spritegroups get matched

   168

	byte random_bits;

   169

	byte waiting_triggers; // triggers to be yet matched

   170

   171

	uint16 max_speed;	// maximum speed

   172

	uint16 cur_speed;	// current speed

   173

	byte subspeed;		// fractional speed

   174

	byte acceleration; // used by train & aircraft

   175

	byte progress;

   176

   177

	byte vehstatus;		// Status

   178

	StationID last_station_visited;

   179

   180

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

   181

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

   182

	StationID cargo_source;// source of cargo

   183

	uint16 cargo_cap;	// total capacity

   184

	uint16 cargo_count;// how many pieces are used

   185

   186

	byte day_counter; // increased by one for each day

   187

	byte tick_counter;// increased by one for each tick

   188

   189

	/* Begin Order-stuff */

   190

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

   191

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

   192

   193

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

   194

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

   195

   196

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

   197

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

   198

	/* End Order-stuff */

   199

   200

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

   201

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

   202

	int32 left_coord;

   203

	int32 top_coord;

   204

	int32 right_coord;

   205

	int32 bottom_coord;

   206

	VehicleID next_hash;

   207

   208

	// Related to age and service time

   209

	uint16 age;				// Age in days

   210

	uint16 max_age;		// Maximum age

   211

	uint16 date_of_last_service;

   212

	uint16 service_interval;

   213

	uint16 reliability;

   214

	uint16 reliability_spd_dec;

   215

	byte breakdown_ctr;

   216

	byte breakdown_delay;

   217

	byte breakdowns_since_last_service;

   218

	byte breakdown_chance;

   219

	byte build_year;

   220

   221

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

   222

   223

	uint16 load_unload_time_rem;

   224

   225

	int32 profit_this_year;

   226

	int32 profit_last_year;

   227

	uint32 value;

   228

   229

	union {

   230

		VehicleRail rail;

   231

		VehicleAir air;

   232

		VehicleRoad road;

   233

		VehicleSpecial special;

   234

		VehicleDisaster disaster;

   235

		VehicleShip ship;

   236

	} u;

   237

};

   238

   239

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

   240

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

   241

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

   242

   243

typedef void VehicleTickProc(Vehicle *v);

   244

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

   245

   246

void VehicleServiceInDepot(Vehicle *v);

   247

Vehicle *AllocateVehicle(void);

   248

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

   249

Vehicle *ForceAllocateVehicle(void);

   250

Vehicle *ForceAllocateSpecialVehicle(void);

   251

void VehiclePositionChanged(Vehicle *v);

   252

void AfterLoadVehicles(void);

   253

Vehicle *GetLastVehicleInChain(Vehicle *v);

   254

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   255

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   256

uint CountVehiclesInChain(const Vehicle* v);

   257

void DeleteVehicle(Vehicle *v);

   258

void DeleteVehicleChain(Vehicle *v);

   259

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

   260

void CallVehicleTicks(void);

   261

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   262

   263

void InitializeTrains(void);

   264

byte VehicleRandomBits(void);

   265

   266

bool CanFillVehicle(Vehicle *v);

   267

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

   268

   269

void ViewportAddVehicles(DrawPixelInfo *dpi);

   270

   271

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   272

   273

/* train_cmd.h */

   274

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

   275

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

   276

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

   277

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

   278

   279

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

   280

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

   281

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

   282

   283

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

   284

   285

void VehicleInTheWayErrMsg(const Vehicle* v);

   286

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

   287

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   288

   289

bool UpdateSignalsOnSegment(TileIndex tile, DiagDirection direction);

   290

void SetSignalsOnBothDir(TileIndex tile, byte track);

   291

   292

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

   293

   294

void DecreaseVehicleValue(Vehicle *v);

   295

void CheckVehicleBreakdown(Vehicle *v);

   296

void AgeVehicle(Vehicle *v);

   297

void VehicleEnteredDepotThisTick(Vehicle *v);

   298

   299

void BeginVehicleMove(Vehicle *v);

   300

void EndVehicleMove(Vehicle *v);

   301

   302

void ShowAircraftViewWindow(const Vehicle* v);

   303

   304

UnitID GetFreeUnitNumber(byte type);

   305

   306

int LoadUnloadVehicle(Vehicle *v);

   307

   308

void TrainConsistChanged(Vehicle *v);

   309

void TrainPowerChanged(Vehicle *v);

   310

int32 GetTrainRunningCost(const Vehicle *v);

   311

   312

int CheckTrainStoppedInDepot(const Vehicle *v);

   313

   314

bool VehicleNeedsService(const Vehicle *v);

   315

   316

typedef struct GetNewVehiclePosResult {

   317

	int x,y;

   318

	TileIndex old_tile;

   319

	TileIndex new_tile;

   320

} GetNewVehiclePosResult;

   321

   322

/**

   323

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

   324

 * Works for trains and ships.

   325

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

   326

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

   327

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

   328

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

   329

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

   330

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

   331

 * in depots), returns 0xFF.

   332

 */

   333

Trackdir GetVehicleTrackdir(const Vehicle* v);

   334

   335

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

   336

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

   337

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

   338

   339

#define BEGIN_ENUM_WAGONS(v) do {

   340

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

   341

   342

extern MemoryPool _vehicle_pool;

   343

   344

/**

   345

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

   346

 */

   347

static inline Vehicle *GetVehicle(VehicleID index)

   348

{

   349

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

   350

}

   351

   352

/**

   353

 * Get the current size of the VehiclePool

   354

 */

   355

static inline uint16 GetVehiclePoolSize(void)

   356

{

   357

	return _vehicle_pool.total_items;

   358

}

   359

   360

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

   361

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

   362

   363

/**

   364

 * Check if a Vehicle really exists.

   365

 */

   366

static inline bool IsValidVehicle(const Vehicle *v)

   367

{

   368

	return v->type != 0;

   369

}

   370

   371

/**

   372

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

   373

 *

   374

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

   375

 */

   376

static inline bool IsVehicleIndex(uint index)

   377

{

   378

	return index < GetVehiclePoolSize();

   379

}

   380

   381

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

   382

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

   383

{

   384

	Order *order = v->orders;

   385

   386

	if (index < 0) return NULL;

   387

   388

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

   389

		order = order->next;

   390

   391

	return order;

   392

}

   393

   394

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

   395

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   396

{

   397

	Order *order = v->orders;

   398

   399

	if (order == NULL) return NULL;

   400

   401

	while (order->next != NULL)

   402

		order = order->next;

   403

   404

	return order;

   405

}

   406

   407

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

   408

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   409

{

   410

	Vehicle *u = v;

   411

	while (u->prev_shared != NULL)

   412

		u = u->prev_shared;

   413

   414

	return u;

   415

}

   416

   417

// NOSAVE: Return values from various commands.

   418

VARDEF VehicleID _new_train_id;

   419

VARDEF VehicleID _new_wagon_id;

   420

VARDEF VehicleID _new_aircraft_id;

   421

VARDEF VehicleID _new_ship_id;

   422

VARDEF VehicleID _new_roadveh_id;

   423

VARDEF VehicleID _new_vehicle_id;

   424

VARDEF uint16 _returned_refit_capacity;

   425

   426

#define INVALID_VEHICLE 0xFFFF

   427

   428

/**

   429

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

   430

 * @param engine_type ID of engine

   431

 * @param player ID of player

   432

 * @return A ready-to-use palette modifier

   433

 */

   434

PalSpriteID GetEnginePalette(EngineID engine_type, PlayerID player);

   435

   436

/**

   437

 * Get the colour map for a vehicle.

   438

 * @param v Vehicle to get colour map for

   439

 * @return A ready-to-use palette modifier

   440

 */

   441

PalSpriteID GetVehiclePalette(const Vehicle *v);

   442

   443

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

   444

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

   445

#define STATUS_BAR 5

   446

   447

#endif /* VEHICLE_H */