1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "pool.h"

     5

#include "order.h"

     6

#include "rail.h"

     7

#include "variables.h"

     8

     9

enum {

    10

	VEH_Train = 0x10,

    11

	VEH_Road = 0x11,

    12

	VEH_Ship = 0x12,

    13

	VEH_Aircraft = 0x13,

    14

	VEH_Special = 0x14,

    15

	VEH_Disaster = 0x15,

    16

} ;

    17

    18

enum VehStatus {

    19

	VS_HIDDEN = 1,

    20

	VS_STOPPED = 2,

    21

	VS_UNCLICKABLE = 4,

    22

	VS_DEFPAL = 0x8,

    23

	VS_TRAIN_SLOWING = 0x10,

    24

	VS_DISASTER = 0x20,

    25

	VS_AIRCRAFT_BROKEN = 0x40,

    26

	VS_CRASHED = 0x80,

    27

};

    28

    29

// 1 and 3 do not appear to be used

    30

typedef enum TrainSubtypes {

    31

	TS_Front_Engine = 0, // Leading engine of a train

    32

	TS_Not_First = 2,    // Wagon or additional engine

    33

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

    34

} TrainSubtype;

    35

    36

/* Effect vehicle types */

    37

typedef enum EffectVehicle {

    38

	EV_CHIMNEY_SMOKE   = 0,

    39

	EV_STEAM_SMOKE     = 1,

    40

	EV_DIESEL_SMOKE    = 2,

    41

	EV_ELECTRIC_SPARK  = 3,

    42

	EV_SMOKE           = 4,

    43

	EV_EXPLOSION_LARGE = 5,

    44

	EV_BREAKDOWN_SMOKE = 6,

    45

	EV_EXPLOSION_SMALL = 7,

    46

	EV_BULLDOZER       = 8,

    47

	EV_BUBBLE          = 9

    48

} EffectVehicle;

    49

    50

typedef struct VehicleRail {

    51

	uint16 last_speed;		// NOSAVE: only used in UI

    52

	uint16 crash_anim_pos;

    53

	uint16 days_since_order_progr;

    54

    55

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

    56

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

    57

	uint32 cached_power;      // total power of the consist.

    58

	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

    59

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

    60

	uint16 cached_weight;     // total weight of the consist.

    61

	uint16 cached_veh_weight; // weight of the vehicle.

    62

    63

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

    64

	// 0xffff == not in train

    65

	EngineID first_engine;

    66

    67

	byte track;

    68

	byte force_proceed;

    69

	byte railtype;

    70

    71

	byte flags;

    72

    73

	byte pbs_status;

    74

	TileIndex pbs_end_tile;

    75

	Trackdir pbs_end_trackdir;

    76

} VehicleRail;

    77

    78

enum {

    79

	VRF_REVERSING = 0,

    80

    81

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

    82

	VRF_GOINGUP   = 1,

    83

	VRF_GOINGDOWN = 2,

    84

    85

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

    86

	VRF_POWEREDWAGON = 3,

    87

};

    88

    89

typedef struct VehicleAir {

    90

	uint16 crashed_counter;

    91

	byte pos;

    92

  byte previous_pos;

    93

	uint16 targetairport;

    94

	byte state;

    95

} VehicleAir;

    96

    97

typedef struct VehicleRoad {

    98

	byte state;

    99

	byte frame;

   100

	uint16 unk2;

   101

	byte overtaking;

   102

	byte overtaking_ctr;

   103

	uint16 crashed_ctr;

   104

	byte reverse_ctr;

   105

	struct RoadStop *slot;

   106

	byte slotindex;

   107

	byte slot_age;

   108

} VehicleRoad;

   109

   110

typedef struct VehicleSpecial {

   111

	uint16 unk0;

   112

	byte unk2;

   113

} VehicleSpecial;

   114

   115

typedef struct VehicleDisaster {

   116

	uint16 image_override;

   117

	uint16 unk2;

   118

} VehicleDisaster;

   119

   120

typedef struct VehicleShip {

   121

	byte state;

   122

} VehicleShip;

   123

   124

// not used ATM

   125

struct WorldSprite {

   126

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

   127

	uint16 image;			// sprite number for this vehicle

   128

   129

	// screen coordinates

   130

	int16 left, top, right, bottom;

   131

   132

	// world coordinates

   133

	int16 x;

   134

	int16 y;

   135

	byte z;

   136

   137

	int8 x_offs;			// x offset for vehicle sprite

   138

	int8 y_offs;			// y offset for vehicle sprite

   139

   140

	byte width;				// width of vehicle sprite

   141

	byte height;			// height of vehicle sprite

   142

	byte depth;				// depth of vehicle sprite

   143

   144

	byte flags;				// draw flags

   145

};

   146

   147

struct Vehicle {

   148

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

   149

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

   150

   151

	VehicleID index;	// NOSAVE: Index in vehicle array

   152

   153

	Vehicle *next;		// next

   154

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

   155

   156

	StringID string_id; // Displayed string

   157

   158

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

   159

	PlayerID owner;				// which player owns the vehicle?

   160

   161

	TileIndex tile;		// Current tile index

   162

	TileIndex dest_tile; // Heading for this tile

   163

   164

	int32 x_pos;			// coordinates

   165

	int32 y_pos;

   166

	byte z_pos;

   167

	byte direction;		// facing

   168

   169

	byte spritenum; // currently displayed sprite index

   170

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

   171

	                // 0xff == reserved for another custom sprite

   172

	uint16 cur_image; // sprite number for this vehicle

   173

	byte sprite_width;// width of vehicle sprite

   174

	byte sprite_height;// height of vehicle sprite

   175

	byte z_height;		// z-height of vehicle sprite

   176

	int8 x_offs;			// x offset for vehicle sprite

   177

	int8 y_offs;			// y offset for vehicle sprite

   178

	EngineID engine_type;

   179

   180

	// for randomized variational spritegroups

   181

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

   182

	// of corresponding spritegroups get matched

   183

	byte random_bits;

   184

	byte waiting_triggers; // triggers to be yet matched

   185

   186

	uint16 max_speed;	// maximum speed

   187

	uint16 cur_speed;	// current speed

   188

	byte subspeed;		// fractional speed

   189

	byte acceleration; // used by train & aircraft

   190

	byte progress;

   191

   192

	byte vehstatus;		// Status

   193

	uint16 last_station_visited;

   194

   195

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

   196

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

   197

	uint16 cargo_source;// source of cargo

   198

	uint16 cargo_cap;	// total capacity

   199

	uint16 cargo_count;// how many pieces are used

   200

   201

	byte day_counter; // increased by one for each day

   202

	byte tick_counter;// increased by one for each tick

   203

   204

	/* Begin Order-stuff */

   205

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

   206

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

   207

   208

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

   209

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

   210

   211

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

   212

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

   213

	/* End Order-stuff */

   214

   215

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

   216

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

   217

	int32 left_coord;

   218

	int32 top_coord;

   219

	int32 right_coord;

   220

	int32 bottom_coord;

   221

	uint16 next_hash;

   222

   223

	// Related to age and service time

   224

	uint16 age;				// Age in days

   225

	uint16 max_age;		// Maximum age

   226

	uint16 date_of_last_service;

   227

	uint16 service_interval;

   228

	uint16 reliability;

   229

	uint16 reliability_spd_dec;

   230

	byte breakdown_ctr;

   231

	byte breakdown_delay;

   232

	byte breakdowns_since_last_service;

   233

	byte breakdown_chance;

   234

	byte build_year;

   235

   236

	uint16 load_unload_time_rem;

   237

   238

	int32 profit_this_year;

   239

	int32 profit_last_year;

   240

	uint32 value;

   241

   242

	union {

   243

		VehicleRail rail;

   244

		VehicleAir air;

   245

		VehicleRoad road;

   246

		VehicleSpecial special;

   247

		VehicleDisaster disaster;

   248

		VehicleShip ship;

   249

	} u;

   250

};

   251

   252

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

   253

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

   254

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

   255

   256

typedef void VehicleTickProc(Vehicle *v);

   257

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

   258

   259

void VehicleServiceInDepot(Vehicle *v);

   260

Vehicle *AllocateVehicle(void);

   261

Vehicle *ForceAllocateVehicle(void);

   262

Vehicle *ForceAllocateSpecialVehicle(void);

   263

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

   264

void VehiclePositionChanged(Vehicle *v);

   265

void AfterLoadVehicles(void);

   266

Vehicle *GetLastVehicleInChain(Vehicle *v);

   267

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   268

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   269

int CountVehiclesInChain(Vehicle *v);

   270

void DeleteVehicle(Vehicle *v);

   271

void DeleteVehicleChain(Vehicle *v);

   272

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

   273

void CallVehicleTicks(void);

   274

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   275

   276

void InitializeTrains(void);

   277

   278

bool CanFillVehicle(Vehicle *v);

   279

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

   280

   281

void ViewportAddVehicles(DrawPixelInfo *dpi);

   282

   283

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   284

   285

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

   286

   287

/* train_cmd.h */

   288

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

   289

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

   290

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

   291

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

   292

   293

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

   294

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

   295

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

   296

   297

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

   298

   299

void VehicleInTheWayErrMsg(Vehicle *v);

   300

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

   301

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   302

   303

bool UpdateSignalsOnSegment(TileIndex tile, byte direction);

   304

void SetSignalsOnBothDir(TileIndex tile, byte track);

   305

   306

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

   307

//uint GetVehicleWeight(Vehicle *v);

   308

   309

void DecreaseVehicleValue(Vehicle *v);

   310

void CheckVehicleBreakdown(Vehicle *v);

   311

void AgeVehicle(Vehicle *v);

   312

void MaybeReplaceVehicle(Vehicle *v);

   313

   314

void BeginVehicleMove(Vehicle *v);

   315

void EndVehicleMove(Vehicle *v);

   316

   317

bool IsAircraftHangarTile(TileIndex tile);

   318

void ShowAircraftViewWindow(Vehicle *v);

   319

   320

UnitID GetFreeUnitNumber(byte type);

   321

   322

int LoadUnloadVehicle(Vehicle *v);

   323

   324

void TrainConsistChanged(Vehicle *v);

   325

void UpdateTrainAcceleration(Vehicle *v);

   326

int32 GetTrainRunningCost(const Vehicle *v);

   327

   328

int CheckTrainStoppedInDepot(const Vehicle *v);

   329

   330

bool VehicleNeedsService(const Vehicle *v);

   331

   332

typedef struct GetNewVehiclePosResult {

   333

	int x,y;

   334

	TileIndex old_tile;

   335

	TileIndex new_tile;

   336

} GetNewVehiclePosResult;

   337

   338

/**

   339

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

   340

 * Works for trains and ships.

   341

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

   342

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

   343

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

   344

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

   345

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

   346

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

   347

 * in depots), returns 0xFF.

   348

 */

   349

Trackdir GetVehicleTrackdir(const Vehicle* v);

   350

   351

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

   352

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

   353

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

   354

   355

#define BEGIN_ENUM_WAGONS(v) do {

   356

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

   357

   358

/* vehicle.c */

   359

VARDEF SortStruct *_vehicle_sort;

   360

   361

extern MemoryPool _vehicle_pool;

   362

   363

/**

   364

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

   365

 */

   366

static inline Vehicle *GetVehicle(VehicleID index)

   367

{

   368

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

   369

}

   370

   371

/**

   372

 * Get the current size of the VehiclePool

   373

 */

   374

static inline uint16 GetVehiclePoolSize(void)

   375

{

   376

	return _vehicle_pool.total_items;

   377

}

   378

   379

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

   380

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

   381

   382

/**

   383

 * Check if a Vehicle really exists.

   384

 */

   385

static inline bool IsValidVehicle(const Vehicle *v)

   386

{

   387

	return v->type != 0;

   388

}

   389

   390

/**

   391

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

   392

 *

   393

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

   394

 */

   395

static inline bool IsVehicleIndex(uint index)

   396

{

   397

	if (index < GetVehiclePoolSize()) return true;

   398

   399

	return false;

   400

}

   401

   402

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

   403

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

   404

{

   405

	Order *order = v->orders;

   406

   407

	if (index < 0) return NULL;

   408

   409

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

   410

		order = order->next;

   411

   412

	return order;

   413

}

   414

   415

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

   416

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   417

{

   418

	Order *order = v->orders;

   419

   420

	if (order == NULL) return NULL;

   421

   422

	while (order->next != NULL)

   423

		order = order->next;

   424

   425

	return order;

   426

}

   427

   428

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

   429

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   430

{

   431

	Vehicle *u = v;

   432

	while (u->prev_shared != NULL)

   433

		u = u->prev_shared;

   434

   435

	return u;

   436

}

   437

   438

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

   439

VARDEF VehicleID _vehicle_position_hash[0x1000];

   440

   441

// NOSAVE: Return values from various commands.

   442

VARDEF VehicleID _new_train_id;

   443

VARDEF VehicleID _new_wagon_id;

   444

VARDEF VehicleID _new_aircraft_id;

   445

VARDEF VehicleID _new_ship_id;

   446

VARDEF VehicleID _new_roadveh_id;

   447

VARDEF uint16 _aircraft_refit_capacity;

   448

VARDEF byte _cmd_build_rail_veh_score;

   449

VARDEF byte _cmd_build_rail_veh_var1;

   450

   451

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

   452

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

   453

   454

#define INVALID_VEHICLE 0xFFFF

   455

   456

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

   457

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

   458

#define STATUS_BAR 5

   459

   460

#endif /* VEHICLE_H */