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

    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

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

    67

	// 0xffff == not in train

    68

	EngineID first_engine;

    69

    70

	byte track;

    71

	byte force_proceed;

    72

	byte railtype;

    73

    74

	byte flags;

    75

    76

	byte pbs_status;

    77

	TileIndex pbs_end_tile;

    78

	Trackdir pbs_end_trackdir;

    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

// not used ATM

   128

struct WorldSprite {

   129

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

   130

	uint16 image;			// sprite number for this vehicle

   131

   132

	// screen coordinates

   133

	int16 left, top, right, bottom;

   134

   135

	// world coordinates

   136

	int16 x;

   137

	int16 y;

   138

	byte z;

   139

   140

	int8 x_offs;			// x offset for vehicle sprite

   141

	int8 y_offs;			// y offset for vehicle sprite

   142

   143

	byte width;				// width of vehicle sprite

   144

	byte height;			// height of vehicle sprite

   145

	byte depth;				// depth of vehicle sprite

   146

   147

	byte flags;				// draw flags

   148

};

   149

   150

struct Vehicle {

   151

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

   152

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

   153

   154

	VehicleID index;	// NOSAVE: Index in vehicle array

   155

   156

	Vehicle *next;		// next

   157

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

   158

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

   159

   160

	StringID string_id; // Displayed string

   161

   162

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

   163

	PlayerID owner;				// which player owns the vehicle?

   164

   165

	TileIndex tile;		// Current tile index

   166

	TileIndex dest_tile; // Heading for this tile

   167

   168

	int32 x_pos;			// coordinates

   169

	int32 y_pos;

   170

   171

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

   172

	byte z_pos;

   173

	byte direction;		// facing

   174

   175

	byte spritenum; // currently displayed sprite index

   176

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

   177

	                // 0xff == reserved for another custom sprite

   178

	uint16 cur_image; // sprite number for this vehicle

   179

	byte sprite_width;// width of vehicle sprite

   180

	byte sprite_height;// height of vehicle sprite

   181

	byte z_height;		// z-height of vehicle sprite

   182

	int8 x_offs;			// x offset for vehicle sprite

   183

	int8 y_offs;			// y offset for vehicle sprite

   184

	EngineID engine_type;

   185

   186

	// for randomized variational spritegroups

   187

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

   188

	// of corresponding spritegroups get matched

   189

	byte random_bits;

   190

	byte waiting_triggers; // triggers to be yet matched

   191

   192

	uint16 max_speed;	// maximum speed

   193

	uint16 cur_speed;	// current speed

   194

	byte subspeed;		// fractional speed

   195

	byte acceleration; // used by train & aircraft

   196

	byte progress;

   197

   198

	byte vehstatus;		// Status

   199

	uint16 last_station_visited;

   200

   201

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

   202

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

   203

	uint16 cargo_source;// source of cargo

   204

	uint16 cargo_cap;	// total capacity

   205

	uint16 cargo_count;// how many pieces are used

   206

   207

	byte day_counter; // increased by one for each day

   208

	byte tick_counter;// increased by one for each tick

   209

   210

	/* Begin Order-stuff */

   211

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

   212

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

   213

   214

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

   215

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

   216

   217

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

   218

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

   219

	/* End Order-stuff */

   220

   221

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

   222

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

   223

	int32 left_coord;

   224

	int32 top_coord;

   225

	int32 right_coord;

   226

	int32 bottom_coord;

   227

	uint16 next_hash;

   228

   229

	// Related to age and service time

   230

	uint16 age;				// Age in days

   231

	uint16 max_age;		// Maximum age

   232

	uint16 date_of_last_service;

   233

	uint16 service_interval;

   234

	uint16 reliability;

   235

	uint16 reliability_spd_dec;

   236

	byte breakdown_ctr;

   237

	byte breakdown_delay;

   238

	byte breakdowns_since_last_service;

   239

	byte breakdown_chance;

   240

	byte build_year;

   241

   242

	uint16 load_unload_time_rem;

   243

   244

	int32 profit_this_year;

   245

	int32 profit_last_year;

   246

	uint32 value;

   247

   248

   249

   250

	union {

   251

		VehicleRail rail;

   252

		VehicleAir air;

   253

		VehicleRoad road;

   254

		VehicleSpecial special;

   255

		VehicleDisaster disaster;

   256

		VehicleShip ship;

   257

	} u;

   258

};

   259

   260

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

   261

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

   262

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

   263

   264

typedef void VehicleTickProc(Vehicle *v);

   265

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

   266

   267

void VehicleServiceInDepot(Vehicle *v);

   268

Vehicle *AllocateVehicle(void);

   269

Vehicle *ForceAllocateVehicle(void);

   270

Vehicle *ForceAllocateSpecialVehicle(void);

   271

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

   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

int CountVehiclesInChain(Vehicle *v);

   278

void DeleteVehicle(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

   286

bool CanFillVehicle(Vehicle *v);

   287

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

   288

   289

void ViewportAddVehicles(DrawPixelInfo *dpi);

   290

   291

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   292

   293

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

   294

   295

/* train_cmd.h */

   296

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

   297

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

   298

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

   299

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

   300

   301

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

   302

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

   303

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

   304

   305

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

   306

   307

void VehicleInTheWayErrMsg(Vehicle *v);

   308

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

   309

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   310

   311

bool UpdateSignalsOnSegment(TileIndex tile, byte 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

bool IsAircraftHangarTile(TileIndex tile);

   325

void ShowAircraftViewWindow(const Vehicle* v);

   326

   327

UnitID GetFreeUnitNumber(byte type);

   328

   329

int LoadUnloadVehicle(Vehicle *v);

   330

   331

void TrainConsistChanged(Vehicle *v);

   332

void UpdateTrainAcceleration(Vehicle *v);

   333

int32 GetTrainRunningCost(const Vehicle *v);

   334

   335

int CheckTrainStoppedInDepot(const Vehicle *v);

   336

   337

bool VehicleNeedsService(const Vehicle *v);

   338

   339

typedef struct GetNewVehiclePosResult {

   340

	int x,y;

   341

	TileIndex old_tile;

   342

	TileIndex new_tile;

   343

} GetNewVehiclePosResult;

   344

   345

/**

   346

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

   347

 * Works for trains and ships.

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

 * in depots), returns 0xFF.

   355

 */

   356

Trackdir GetVehicleTrackdir(const Vehicle* v);

   357

   358

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

   359

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

   360

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

   361

   362

#define BEGIN_ENUM_WAGONS(v) do {

   363

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

   364

   365

/* vehicle.c */

   366

VARDEF SortStruct *_vehicle_sort;

   367

   368

extern MemoryPool _vehicle_pool;

   369

   370

/**

   371

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

   372

 */

   373

static inline Vehicle *GetVehicle(VehicleID index)

   374

{

   375

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

   376

}

   377

   378

/**

   379

 * Get the current size of the VehiclePool

   380

 */

   381

static inline uint16 GetVehiclePoolSize(void)

   382

{

   383

	return _vehicle_pool.total_items;

   384

}

   385

   386

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

   387

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

   388

   389

/**

   390

 * Check if a Vehicle really exists.

   391

 */

   392

static inline bool IsValidVehicle(const Vehicle *v)

   393

{

   394

	return v->type != 0;

   395

}

   396

   397

/**

   398

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

   399

 *

   400

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

   401

 */

   402

static inline bool IsVehicleIndex(uint index)

   403

{

   404

	return index < GetVehiclePoolSize();

   405

}

   406

   407

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

   408

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

   409

{

   410

	Order *order = v->orders;

   411

   412

	if (index < 0) return NULL;

   413

   414

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

   415

		order = order->next;

   416

   417

	return order;

   418

}

   419

   420

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

   421

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   422

{

   423

	Order *order = v->orders;

   424

   425

	if (order == NULL) return NULL;

   426

   427

	while (order->next != NULL)

   428

		order = order->next;

   429

   430

	return order;

   431

}

   432

   433

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

   434

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   435

{

   436

	Vehicle *u = v;

   437

	while (u->prev_shared != NULL)

   438

		u = u->prev_shared;

   439

   440

	return u;

   441

}

   442

   443

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

   444

VARDEF VehicleID _vehicle_position_hash[0x1000];

   445

   446

// NOSAVE: Return values from various commands.

   447

VARDEF VehicleID _new_train_id;

   448

VARDEF VehicleID _new_wagon_id;

   449

VARDEF VehicleID _new_aircraft_id;

   450

VARDEF VehicleID _new_ship_id;

   451

VARDEF VehicleID _new_roadveh_id;

   452

VARDEF VehicleID _new_vehicle_id;

   453

VARDEF uint16 _aircraft_refit_capacity;

   454

VARDEF byte _cmd_build_rail_veh_score;

   455

   456

#define INVALID_VEHICLE 0xFFFF

   457

#define INVALID_ENGINE 0xFFFF

   458

   459

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

   460

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

   461

#define STATUS_BAR 5

   462

   463

#endif /* VEHICLE_H */