1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "pool.h"

     5

#include "order.h"

     6

     7

enum {

     8

	VEH_Train = 0x10,

     9

	VEH_Road = 0x11,

    10

	VEH_Ship = 0x12,

    11

	VEH_Aircraft = 0x13,

    12

	VEH_Special = 0x14,

    13

	VEH_Disaster = 0x15,

    14

} ;

    15

    16

enum VehStatus {

    17

	VS_HIDDEN = 1,

    18

	VS_STOPPED = 2,

    19

	VS_UNCLICKABLE = 4,

    20

	VS_DEFPAL = 0x8,

    21

	VS_TRAIN_SLOWING = 0x10,

    22

	VS_DISASTER = 0x20,

    23

	VS_AIRCRAFT_BROKEN = 0x40,

    24

	VS_CRASHED = 0x80,

    25

};

    26

    27

// 1 and 3 do not appear to be used

    28

typedef enum TrainSubtypes {

    29

	TS_Front_Engine = 0, // Leading engine of a train

    30

	TS_Not_First = 2,    // Wagon or additional engine

    31

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

    32

} TrainSubtype;

    33

    34

/* Effect vehicle types */

    35

typedef enum EffectVehicle {

    36

	EV_CHIMNEY_SMOKE   = 0,

    37

	EV_STEAM_SMOKE     = 1,

    38

	EV_DIESEL_SMOKE    = 2,

    39

	EV_ELECTRIC_SPARK  = 3,

    40

	EV_SMOKE           = 4,

    41

	EV_EXPLOSION_LARGE = 5,

    42

	EV_BREAKDOWN_SMOKE = 6,

    43

	EV_EXPLOSION_SMALL = 7,

    44

	EV_BULLDOZER       = 8,

    45

	EV_BUBBLE          = 9

    46

} EffectVehicle;

    47

    48

typedef struct VehicleRail {

    49

	uint16 last_speed;		// NOSAVE: only used in UI

    50

	uint16 crash_anim_pos;

    51

	uint16 days_since_order_progr;

    52

    53

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

    54

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

    55

	uint32 cached_power;      // total power of the consist.

    57

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

    58

	uint16 cached_weight;     // total weight of the consist.

    59

	uint16 cached_veh_weight; // weight of the vehicle.

    60

    61

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

    62

	// 0xffff == not in train

    63

	EngineID first_engine;

    64

    65

	byte track;

    66

	byte force_proceed;

    67

	byte railtype;

    68

    69

	byte flags;

    70

} VehicleRail;

    71

    72

enum {

    73

	VRF_REVERSING = 0,

    74

    75

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

    76

	VRF_GOINGUP   = 1,

    77

	VRF_GOINGDOWN = 2,

    78

    79

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

    80

	VRF_POWEREDWAGON = 3,

    81

};

    82

    83

typedef struct VehicleAir {

    84

	uint16 crashed_counter;

    85

	byte pos;

    86

  byte previous_pos;

    87

	uint16 targetairport;

    88

	byte state;

    89

} VehicleAir;

    90

    91

typedef struct VehicleRoad {

    92

	byte state;

    93

	byte frame;

    94

	uint16 unk2;

    95

	byte overtaking;

    96

	byte overtaking_ctr;

    97

	uint16 crashed_ctr;

    98

	byte reverse_ctr;

    99

	struct RoadStop *slot;

   100

	byte slotindex;

   101

	byte slot_age;

   102

} VehicleRoad;

   103

   104

typedef struct VehicleSpecial {

   105

	uint16 unk0;

   106

	byte unk2;

   107

} VehicleSpecial;

   108

   109

typedef struct VehicleDisaster {

   110

	uint16 image_override;

   111

	uint16 unk2;

   112

} VehicleDisaster;

   113

   114

typedef struct VehicleShip {

   115

	byte state;

   116

} VehicleShip;

   117

   118

// not used ATM

   119

struct WorldSprite {

   120

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

   121

	uint16 image;			// sprite number for this vehicle

   122

   123

	// screen coordinates

   124

	int16 left, top, right, bottom;

   125

   126

	// world coordinates

   127

	int16 x;

   128

	int16 y;

   129

	byte z;

   130

   131

	int8 x_offs;			// x offset for vehicle sprite

   132

	int8 y_offs;			// y offset for vehicle sprite

   133

   134

	byte width;				// width of vehicle sprite

   135

	byte height;			// height of vehicle sprite

   136

	byte depth;				// depth of vehicle sprite

   137

   138

	byte flags;				// draw flags

   139

};

   140

   141

struct Vehicle {

   142

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

   143

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

   144

   145

	VehicleID index;	// NOSAVE: Index in vehicle array

   146

   147

	Vehicle *next;		// next

   148

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

   149

   150

	StringID string_id; // Displayed string

   151

   152

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

   153

	PlayerID owner;				// which player owns the vehicle?

   154

   155

	TileIndex tile;		// Current tile index

   156

	TileIndex dest_tile; // Heading for this tile

   157

   158

	int32 x_pos;			// coordinates

   159

	int32 y_pos;

   160

	byte z_pos;

   161

	byte direction;		// facing

   162

   163

	byte spritenum; // currently displayed sprite index

   164

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

   165

	                // 0xff == reserved for another custom sprite

   166

	uint16 cur_image; // sprite number for this vehicle

   167

	byte sprite_width;// width of vehicle sprite

   168

	byte sprite_height;// height of vehicle sprite

   169

	byte z_height;		// z-height of vehicle sprite

   170

	int8 x_offs;			// x offset for vehicle sprite

   171

	int8 y_offs;			// y offset for vehicle sprite

   172

	EngineID engine_type;

   173

   174

	// for randomized variational spritegroups

   175

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

   176

	// of corresponding spritegroups get matched

   177

	byte random_bits;

   178

	byte waiting_triggers; // triggers to be yet matched

   179

   180

	uint16 max_speed;	// maximum speed

   181

	uint16 cur_speed;	// current speed

   182

	byte subspeed;		// fractional speed

   183

	byte acceleration; // used by train & aircraft

   184

	byte progress;

   185

   186

	byte vehstatus;		// Status

   187

	uint16 last_station_visited;

   188

   189

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

   190

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

   191

	uint16 cargo_source;// source of cargo

   192

	uint16 cargo_cap;	// total capacity

   193

	uint16 cargo_count;// how many pieces are used

   194

   195

	byte day_counter; // increased by one for each day

   196

	byte tick_counter;// increased by one for each tick

   197

   198

	/* Begin Order-stuff */

   199

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

   200

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

   201

   202

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

   203

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

   204

   205

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

   206

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

   207

	/* End Order-stuff */

   208

   209

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

   210

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

   211

	int32 left_coord;

   212

	int32 top_coord;

   213

	int32 right_coord;

   214

	int32 bottom_coord;

   215

	uint16 next_hash;

   216

   217

	// Related to age and service time

   218

	uint16 age;				// Age in days

   219

	uint16 max_age;		// Maximum age

   220

	uint16 date_of_last_service;

   221

	uint16 service_interval;

   222

	uint16 reliability;

   223

	uint16 reliability_spd_dec;

   224

	byte breakdown_ctr;

   225

	byte breakdown_delay;

   226

	byte breakdowns_since_last_service;

   227

	byte breakdown_chance;

   228

	byte build_year;

   229

   230

	uint16 load_unload_time_rem;

   231

   232

	int32 profit_this_year;

   233

	int32 profit_last_year;

   234

	uint32 value;

   235

   236

	union {

   237

		VehicleRail rail;

   238

		VehicleAir air;

   239

		VehicleRoad road;

   240

		VehicleSpecial special;

   241

		VehicleDisaster disaster;

   242

		VehicleShip ship;

   243

	} u;

   244

};

   245

   246

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

   247

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

   248

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

   249

   250

typedef void VehicleTickProc(Vehicle *v);

   251

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

   252

   253

void VehicleServiceInDepot(Vehicle *v);

   254

Vehicle *AllocateVehicle(void);

   255

Vehicle *ForceAllocateVehicle(void);

   256

Vehicle *ForceAllocateSpecialVehicle(void);

   257

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

   258

void VehiclePositionChanged(Vehicle *v);

   259

void AfterLoadVehicles(void);

   260

Vehicle *GetLastVehicleInChain(Vehicle *v);

   261

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   262

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   263

int CountVehiclesInChain(Vehicle *v);

   264

void DeleteVehicle(Vehicle *v);

   265

void DeleteVehicleChain(Vehicle *v);

   266

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

   267

void CallVehicleTicks(void);

   268

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   269

   270

void InitializeTrains(void);

   271

   272

bool CanFillVehicle(Vehicle *v);

   273

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

   274

   275

void ViewportAddVehicles(DrawPixelInfo *dpi);

   276

   277

void TrainEnterDepot(Vehicle *v, uint tile);

   278

   279

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

   280

   281

/* train_cmd.h */

   282

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

   283

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

   284

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

   285

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

   286

   287

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

   288

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

   289

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

   290

   291

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

   292

   293

void VehicleInTheWayErrMsg(Vehicle *v);

   294

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

   295

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   296

   297

bool UpdateSignalsOnSegment(uint tile, byte direction);

   298

void SetSignalsOnBothDir(uint tile, byte track);

   299

   300

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

   301

//uint GetVehicleWeight(Vehicle *v);

   302

   303

void DecreaseVehicleValue(Vehicle *v);

   304

void CheckVehicleBreakdown(Vehicle *v);

   305

void AgeVehicle(Vehicle *v);

   306

void MaybeReplaceVehicle(Vehicle *v);

   307

   308

void BeginVehicleMove(Vehicle *v);

   309

void EndVehicleMove(Vehicle *v);

   310

   311

bool IsAircraftHangarTile(TileIndex tile);

   312

void ShowAircraftViewWindow(Vehicle *v);

   313

   314

UnitID GetFreeUnitNumber(byte type);

   315

   316

int LoadUnloadVehicle(Vehicle *v);

   317

   318

void TrainConsistChanged(Vehicle *v);

   319

void UpdateTrainAcceleration(Vehicle *v);

   320

int32 GetTrainRunningCost(const Vehicle *v);

   321

   322

int CheckTrainStoppedInDepot(const Vehicle *v);

   323

   324

bool VehicleNeedsService(const Vehicle *v);

   325

   326

typedef struct GetNewVehiclePosResult {

   327

	int x,y;

   328

	uint old_tile;

   329

	uint new_tile;

   330

} GetNewVehiclePosResult;

   331

   332

/**

   333

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

   334

 * Works for trains and ships.

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

 * in depots), returns 0xFF.

   342

 */

   343

byte GetVehicleTrackdir(const Vehicle* v);

   344

   345

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

   346

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

   347

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

   348

   349

#define BEGIN_ENUM_WAGONS(v) do {

   350

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

   351

   352

/* vehicle.c */

   353

VARDEF SortStruct *_vehicle_sort;

   354

   355

extern MemoryPool _vehicle_pool;

   356

   357

/**

   358

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

   359

 */

   360

static inline Vehicle *GetVehicle(VehicleID index)

   361

{

   362

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

   363

}

   364

   365

/**

   366

 * Get the current size of the VehiclePool

   367

 */

   368

static inline uint16 GetVehiclePoolSize(void)

   369

{

   370

	return _vehicle_pool.total_items;

   371

}

   372

   373

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

   374

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

   375

   376

/**

   377

 * Check if a Vehicle really exists.

   378

 */

   379

static inline bool IsValidVehicle(const Vehicle *v)

   380

{

   381

	return v->type != 0;

   382

}

   383

   384

/**

   385

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

   386

 *

   387

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

   388

 */

   389

static inline bool IsVehicleIndex(uint index)

   390

{

   391

	if (index < GetVehiclePoolSize()) return true;

   392

   393

	return false;

   394

}

   395

   396

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

   397

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

   398

{

   399

	Order *order = v->orders;

   400

   401

	if (index < 0) return NULL;

   402

   403

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

   404

		order = order->next;

   405

   406

	return order;

   407

}

   408

   409

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

   410

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   411

{

   412

	Order *order = v->orders;

   413

   414

	if (order == NULL) return NULL;

   415

   416

	while (order->next != NULL)

   417

		order = order->next;

   418

   419

	return order;

   420

}

   421

   422

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

   423

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   424

{

   425

	Vehicle *u = v;

   426

	while (u->prev_shared != NULL)

   427

		u = u->prev_shared;

   428

   429

	return u;

   430

}

   431

   432

/* Validate functions for rail building */

   433

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

   434

   435

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

   436

VARDEF VehicleID _vehicle_position_hash[0x1000];

   437

   438

// NOSAVE: Return values from various commands.

   439

VARDEF VehicleID _new_train_id;

   440

VARDEF VehicleID _new_wagon_id;

   441

VARDEF VehicleID _new_aircraft_id;

   442

VARDEF VehicleID _new_ship_id;

   443

VARDEF VehicleID _new_roadveh_id;

   444

VARDEF uint16 _aircraft_refit_capacity;

   445

VARDEF byte _cmd_build_rail_veh_score;

   446

VARDEF byte _cmd_build_rail_veh_var1;

   447

   448

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

   449

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

   450

   451

#define INVALID_VEHICLE 0xFFFF

   452

   453

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

   454

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

   455

#define STATUS_BAR 5

   456

   457

#endif /* VEHICLE_H */