1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "pool.h"

     5

#include "order.h"

     6

#include "rail.h"

     7

     8

enum {

     9

	VEH_Train = 0x10,

    10

	VEH_Road = 0x11,

    11

	VEH_Ship = 0x12,

    12

	VEH_Aircraft = 0x13,

    13

	VEH_Special = 0x14,

    14

	VEH_Disaster = 0x15,

    15

} ;

    16

    17

enum VehStatus {

    18

	VS_HIDDEN = 1,

    19

	VS_STOPPED = 2,

    20

	VS_UNCLICKABLE = 4,

    21

	VS_DEFPAL = 0x8,

    22

	VS_TRAIN_SLOWING = 0x10,

    23

	VS_DISASTER = 0x20,

    24

	VS_AIRCRAFT_BROKEN = 0x40,

    25

	VS_CRASHED = 0x80,

    26

};

    27

    28

// 1 and 3 do not appear to be used

    29

typedef enum TrainSubtypes {

    30

	TS_Front_Engine = 0, // Leading engine of a train

    31

	TS_Not_First = 2,    // Wagon or additional engine

    32

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

    33

} TrainSubtype;

    34

    35

/* Effect vehicle types */

    36

typedef enum EffectVehicle {

    37

	EV_CHIMNEY_SMOKE   = 0,

    38

	EV_STEAM_SMOKE     = 1,

    39

	EV_DIESEL_SMOKE    = 2,

    40

	EV_ELECTRIC_SPARK  = 3,

    41

	EV_SMOKE           = 4,

    42

	EV_EXPLOSION_LARGE = 5,

    43

	EV_BREAKDOWN_SMOKE = 6,

    44

	EV_EXPLOSION_SMALL = 7,

    45

	EV_BULLDOZER       = 8,

    46

	EV_BUBBLE          = 9

    47

} EffectVehicle;

    48

    49

typedef struct VehicleRail {

    50

	uint16 last_speed;		// NOSAVE: only used in UI

    51

	uint16 crash_anim_pos;

    52

	uint16 days_since_order_progr;

    53

    54

	// cached values, recalculated on load and each time a vehicle is added to/removed from the consist.

    55

	uint16 cached_max_speed;  // max speed of the consist. (minimum of the max speed of all vehicles in the consist)

    56

	uint32 cached_power;      // total power of the consist.

    57

	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

    58

	// cached values, recalculated when the cargo on a train changes (in addition to the conditions above)

    59

	uint16 cached_weight;     // total weight of the consist.

    60

	uint16 cached_veh_weight; // weight of the vehicle.

    61

    62

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

    63

	// 0xffff == not in train

    64

	EngineID first_engine;

    65

    66

	byte track;

    67

	byte force_proceed;

    68

	byte railtype;

    69

    70

	byte flags;

    71

    72

	byte pbs_status;

    73

	TileIndex pbs_end_tile;

    74

	Trackdir pbs_end_trackdir;

    75

} VehicleRail;

    76

    77

enum {

    78

	VRF_REVERSING = 0,

    79

    80

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

    81

	VRF_GOINGUP   = 1,

    82

	VRF_GOINGDOWN = 2,

    83

    84

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

    85

	VRF_POWEREDWAGON = 3,

    86

};

    87

    88

typedef struct VehicleAir {

    89

	uint16 crashed_counter;

    90

	byte pos;

    91

  byte previous_pos;

    92

	uint16 targetairport;

    93

	byte state;

    94

} VehicleAir;

    95

    96

typedef struct VehicleRoad {

    97

	byte state;

    98

	byte frame;

    99

	uint16 unk2;

   100

	byte overtaking;

   101

	byte overtaking_ctr;

   102

	uint16 crashed_ctr;

   103

	byte reverse_ctr;

   104

	struct RoadStop *slot;

   105

	byte slotindex;

   106

	byte slot_age;

   107

} VehicleRoad;

   108

   109

typedef struct VehicleSpecial {

   110

	uint16 unk0;

   111

	byte unk2;

   112

} VehicleSpecial;

   113

   114

typedef struct VehicleDisaster {

   115

	uint16 image_override;

   116

	uint16 unk2;

   117

} VehicleDisaster;

   118

   119

typedef struct VehicleShip {

   120

	byte state;

   121

} VehicleShip;

   122

   123

// not used ATM

   124

struct WorldSprite {

   125

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

   126

	uint16 image;			// sprite number for this vehicle

   127

   128

	// screen coordinates

   129

	int16 left, top, right, bottom;

   130

   131

	// world coordinates

   132

	int16 x;

   133

	int16 y;

   134

	byte z;

   135

   136

	int8 x_offs;			// x offset for vehicle sprite

   137

	int8 y_offs;			// y offset for vehicle sprite

   138

   139

	byte width;				// width of vehicle sprite

   140

	byte height;			// height of vehicle sprite

   141

	byte depth;				// depth of vehicle sprite

   142

   143

	byte flags;				// draw flags

   144

};

   145

   146

struct Vehicle {

   147

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

   148

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

   149

   150

	VehicleID index;	// NOSAVE: Index in vehicle array

   151

   152

	Vehicle *next;		// next

   153

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

   154

   155

	StringID string_id; // Displayed string

   156

   157

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

   158

	PlayerID owner;				// which player owns the vehicle?

   159

   160

	TileIndex tile;		// Current tile index

   161

	TileIndex dest_tile; // Heading for this tile

   162

   163

	int32 x_pos;			// coordinates

   164

	int32 y_pos;

   165

	byte z_pos;

   166

	byte direction;		// facing

   167

   168

	byte spritenum; // currently displayed sprite index

   169

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

   170

	                // 0xff == reserved for another custom sprite

   171

	uint16 cur_image; // sprite number for this vehicle

   172

	byte sprite_width;// width of vehicle sprite

   173

	byte sprite_height;// height of vehicle sprite

   174

	byte z_height;		// z-height of vehicle sprite

   175

	int8 x_offs;			// x offset for vehicle sprite

   176

	int8 y_offs;			// y offset for vehicle sprite

   177

	EngineID engine_type;

   178

   179

	// for randomized variational spritegroups

   180

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

   181

	// of corresponding spritegroups get matched

   182

	byte random_bits;

   183

	byte waiting_triggers; // triggers to be yet matched

   184

   185

	uint16 max_speed;	// maximum speed

   186

	uint16 cur_speed;	// current speed

   187

	byte subspeed;		// fractional speed

   188

	byte acceleration; // used by train & aircraft

   189

	byte progress;

   190

   191

	byte vehstatus;		// Status

   192

	uint16 last_station_visited;

   193

   194

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

   195

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

   196

	uint16 cargo_source;// source of cargo

   197

	uint16 cargo_cap;	// total capacity

   198

	uint16 cargo_count;// how many pieces are used

   199

   200

	byte day_counter; // increased by one for each day

   201

	byte tick_counter;// increased by one for each tick

   202

   203

	/* Begin Order-stuff */

   204

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

   205

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

   206

   207

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

   208

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

   209

   210

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

   211

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

   212

	/* End Order-stuff */

   213

   214

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

   215

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

   216

	int32 left_coord;

   217

	int32 top_coord;

   218

	int32 right_coord;

   219

	int32 bottom_coord;

   220

	uint16 next_hash;

   221

   222

	// Related to age and service time

   223

	uint16 age;				// Age in days

   224

	uint16 max_age;		// Maximum age

   225

	uint16 date_of_last_service;

   226

	uint16 service_interval;

   227

	uint16 reliability;

   228

	uint16 reliability_spd_dec;

   229

	byte breakdown_ctr;

   230

	byte breakdown_delay;

   231

	byte breakdowns_since_last_service;

   232

	byte breakdown_chance;

   233

	byte build_year;

   234

   235

	uint16 load_unload_time_rem;

   236

   237

	int32 profit_this_year;

   238

	int32 profit_last_year;

   239

	uint32 value;

   240

   241

	union {

   242

		VehicleRail rail;

   243

		VehicleAir air;

   244

		VehicleRoad road;

   245

		VehicleSpecial special;

   246

		VehicleDisaster disaster;

   247

		VehicleShip ship;

   248

	} u;

   249

};

   250

   251

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

   252

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

   253

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

   254

   255

typedef void VehicleTickProc(Vehicle *v);

   256

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

   257

   258

void VehicleServiceInDepot(Vehicle *v);

   259

Vehicle *AllocateVehicle(void);

   260

Vehicle *ForceAllocateVehicle(void);

   261

Vehicle *ForceAllocateSpecialVehicle(void);

   262

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

   263

void VehiclePositionChanged(Vehicle *v);

   264

void AfterLoadVehicles(void);

   265

Vehicle *GetLastVehicleInChain(Vehicle *v);

   266

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   267

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   268

int CountVehiclesInChain(Vehicle *v);

   269

void DeleteVehicle(Vehicle *v);

   270

void DeleteVehicleChain(Vehicle *v);

   271

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

   272

void CallVehicleTicks(void);

   273

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   274

   275

void InitializeTrains(void);

   276

   277

bool CanFillVehicle(Vehicle *v);

   278

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

   279

   280

void ViewportAddVehicles(DrawPixelInfo *dpi);

   281

   282

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   283

   284

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

   285

   286

/* train_cmd.h */

   287

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

   288

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

   289

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

   290

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

   291

   292

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

   293

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

   294

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

   295

   296

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

   297

   298

void VehicleInTheWayErrMsg(Vehicle *v);

   299

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

   300

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   301

   302

bool UpdateSignalsOnSegment(TileIndex tile, byte direction);

   303

void SetSignalsOnBothDir(TileIndex tile, byte track);

   304

   306

//uint GetVehicleWeight(Vehicle *v);

   307

   308

void DecreaseVehicleValue(Vehicle *v);

   309

void CheckVehicleBreakdown(Vehicle *v);

   310

void AgeVehicle(Vehicle *v);

   311

void MaybeReplaceVehicle(Vehicle *v);

   312

   313

void BeginVehicleMove(Vehicle *v);

   314

void EndVehicleMove(Vehicle *v);

   315

   316

bool IsAircraftHangarTile(TileIndex tile);

   317

void ShowAircraftViewWindow(Vehicle *v);

   318

   319

UnitID GetFreeUnitNumber(byte type);

   320

   321

int LoadUnloadVehicle(Vehicle *v);

   322

   323

void TrainConsistChanged(Vehicle *v);

   324

void UpdateTrainAcceleration(Vehicle *v);

   325

int32 GetTrainRunningCost(const Vehicle *v);

   326

   327

int CheckTrainStoppedInDepot(const Vehicle *v);

   328

   329

bool VehicleNeedsService(const Vehicle *v);

   330

   331

typedef struct GetNewVehiclePosResult {

   332

	int x,y;

   333

	TileIndex old_tile;

   334

	TileIndex new_tile;

   335

} GetNewVehiclePosResult;

   336

   337

/**

   338

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

   339

 * Works for trains and ships.

   340

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

   341

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

   342

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

   343

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

   344

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

   345

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

   346

 * in depots), returns 0xFF.

   347

 */

   348

Trackdir GetVehicleTrackdir(const Vehicle* v);

   349

   350

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

   351

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

   352

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

   353

   354

#define BEGIN_ENUM_WAGONS(v) do {

   355

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

   356

   357

/* vehicle.c */

   358

VARDEF SortStruct *_vehicle_sort;

   359

   360

extern MemoryPool _vehicle_pool;

   361

   362

/**

   363

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

   364

 */

   365

static inline Vehicle *GetVehicle(VehicleID index)

   366

{

   367

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

   368

}

   369

   370

/**

   371

 * Get the current size of the VehiclePool

   372

 */

   373

static inline uint16 GetVehiclePoolSize(void)

   374

{

   375

	return _vehicle_pool.total_items;

   376

}

   377

   378

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

   379

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

   380

   381

/**

   382

 * Check if a Vehicle really exists.

   383

 */

   384

static inline bool IsValidVehicle(const Vehicle *v)

   385

{

   386

	return v->type != 0;

   387

}

   388

   389

/**

   390

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

   391

 *

   392

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

   393

 */

   394

static inline bool IsVehicleIndex(uint index)

   395

{

   396

	if (index < GetVehiclePoolSize()) return true;

   397

   398

	return false;

   399

}

   400

   401

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

   402

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

   403

{

   404

	Order *order = v->orders;

   405

   406

	if (index < 0) return NULL;

   407

   408

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

   409

		order = order->next;

   410

   411

	return order;

   412

}

   413

   414

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

   415

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   416

{

   417

	Order *order = v->orders;

   418

   419

	if (order == NULL) return NULL;

   420

   421

	while (order->next != NULL)

   422

		order = order->next;

   423

   424

	return order;

   425

}

   426

   427

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

   428

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   429

{

   430

	Vehicle *u = v;

   431

	while (u->prev_shared != NULL)

   432

		u = u->prev_shared;

   433

   434

	return u;

   435

}

   436

   437

/* Validate functions for rail building */

   438

static inline bool ValParamRailtype(uint32 rail) { return rail <= GetPlayer(_current_player)->max_railtype;}

   439

   440

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

   441

VARDEF VehicleID _vehicle_position_hash[0x1000];

   442

   443

// NOSAVE: Return values from various commands.

   444

VARDEF VehicleID _new_train_id;

   445

VARDEF VehicleID _new_wagon_id;

   446

VARDEF VehicleID _new_aircraft_id;

   447

VARDEF VehicleID _new_ship_id;

   448

VARDEF VehicleID _new_roadveh_id;

   449

VARDEF uint16 _aircraft_refit_capacity;

   450

VARDEF byte _cmd_build_rail_veh_score;

   451

VARDEF byte _cmd_build_rail_veh_var1;

   452

   453

// for each player, for each vehicle type, keep a list of the vehicles.

   454

//VARDEF Vehicle *_vehicle_arr[8][4];

   455

   456

#define INVALID_VEHICLE 0xFFFF

   457

   458

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

   459

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

   460

#define STATUS_BAR 5

   461

   462

#endif /* VEHICLE_H */