1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "pool.h"

     5

#include "order.h"

     6

    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

	uint16 cached_weight; // cached power and weight for the vehicle.

    54

	uint32 cached_power;  // no need to save those, they are recomputed on load.

    55

    56

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

    57

	// 0xffff == not in train

    58

	uint16 first_engine;

    59

    60

	byte track;

    61

	byte force_proceed;

    62

	byte railtype;

    63

    64

	byte flags;

    65

} VehicleRail;

    66

    67

enum {

    68

	VRF_REVERSING = 0,

    69

    70

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

    71

	VRF_GOINGUP   = 1,

    72

	VRF_GOINGDOWN = 2,

    73

};

    74

    75

typedef struct VehicleAir {

    76

	uint16 crashed_counter;

    77

	byte pos;

    78

  byte previous_pos;

    79

	uint16 targetairport;

    80

	byte state;

    81

} VehicleAir;

    82

    83

typedef struct VehicleRoad {

    84

	byte state;

    85

	byte frame;

    86

	uint16 unk2;

    87

	byte overtaking;

    88

	byte overtaking_ctr;

    89

	uint16 crashed_ctr;

    90

	byte reverse_ctr;

    91

	struct RoadStop *slot;

    92

	byte slotindex;

    93

	byte slot_age;

    94

} VehicleRoad;

    95

    96

typedef struct VehicleSpecial {

    97

	uint16 unk0;

    98

	byte unk2;

    99

} VehicleSpecial;

   100

   101

typedef struct VehicleDisaster {

   102

	uint16 image_override;

   103

	uint16 unk2;

   104

} VehicleDisaster;

   105

   106

typedef struct VehicleShip {

   107

	byte state;

   108

} VehicleShip;

   109

   110

// not used ATM

   111

struct WorldSprite {

   112

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

   113

	uint16 image;			// sprite number for this vehicle

   114

   115

	// screen coordinates

   116

	int16 left, top, right, bottom;

   117

   118

	// world coordinates

   119

	int16 x;

   120

	int16 y;

   121

	byte z;

   122

   123

	int8 x_offs;			// x offset for vehicle sprite

   124

	int8 y_offs;			// y offset for vehicle sprite

   125

   126

	byte width;				// width of vehicle sprite

   127

	byte height;			// height of vehicle sprite

   128

	byte depth;				// depth of vehicle sprite

   129

   130

	byte flags;				// draw flags

   131

};

   132

   133

struct Vehicle {

   136

   137

	uint16 index;			// NOSAVE: Index in vehicle array

   138

   139

	Vehicle *next;		// next

   140

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

   141

   142

	StringID string_id; // Displayed string

   143

   144

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

   145

	byte owner;				// which player owns the vehicle?

   146

   147

	TileIndex tile;		// Current tile index

   148

	TileIndex dest_tile; // Heading for this tile

   149

   150

	int32 x_pos;			// coordinates

   151

	int32 y_pos;

   152

	byte z_pos;

   153

	byte direction;		// facing

   154

   155

	byte spritenum; // currently displayed sprite index

   156

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

   157

	                // 0xff == reserved for another custom sprite

   158

	uint16 cur_image; // sprite number for this vehicle

   159

	byte sprite_width;// width of vehicle sprite

   160

	byte sprite_height;// height of vehicle sprite

   161

	byte z_height;		// z-height of vehicle sprite

   162

	int8 x_offs;			// x offset for vehicle sprite

   163

	int8 y_offs;			// y offset for vehicle sprite

   164

	uint16 engine_type;

   165

   166

	// for randomized variational spritegroups

   167

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

   168

	// of corresponding spritegroups get matched

   169

	byte random_bits;

   170

	byte waiting_triggers; // triggers to be yet matched

   171

   172

	uint16 max_speed;	// maximum speed

   173

	uint16 cur_speed;	// current speed

   174

	byte subspeed;		// fractional speed

   175

	byte acceleration; // used by train & aircraft

   176

	byte progress;

   177

   178

	byte vehstatus;		// Status

   179

	uint16 last_station_visited;

   180

   181

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

   182

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

   183

	uint16 cargo_source;// source of cargo

   184

	uint16 cargo_cap;	// total capacity

   185

	uint16 cargo_count;// how many pieces are used

   186

   187

	byte day_counter; // increased by one for each day

   188

	byte tick_counter;// increased by one for each tick

   189

   190

	/* Begin Order-stuff */

   191

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

   192

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

   193

   194

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

   195

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

   196

   197

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

   198

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

   199

	/* End Order-stuff */

   200

   201

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

   202

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

   203

	int32 left_coord;

   204

	int32 top_coord;

   205

	int32 right_coord;

   206

	int32 bottom_coord;

   207

	uint16 next_hash;

   208

   209

	// Related to age and service time

   210

	uint16 age;				// Age in days

   211

	uint16 max_age;		// Maximum age

   212

	uint16 date_of_last_service;

   213

	uint16 service_interval;

   214

	uint16 reliability;

   215

	uint16 reliability_spd_dec;

   216

	byte breakdown_ctr;

   217

	byte breakdown_delay;

   218

	byte breakdowns_since_last_service;

   219

	byte breakdown_chance;

   220

	byte build_year;

   221

   222

	uint16 load_unload_time_rem;

   223

   224

	int32 profit_this_year;

   225

	int32 profit_last_year;

   226

	uint32 value;

   227

   228

	union {

   229

		VehicleRail rail;

   230

		VehicleAir air;

   231

		VehicleRoad road;

   232

		VehicleSpecial special;

   233

		VehicleDisaster disaster;

   234

		VehicleShip ship;

   235

	} u;

   236

};

   237

   238

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

   239

#define is_custom_firsthead_sprite(x) (x == 0xfd)

   240

#define is_custom_secondhead_sprite(x) (x == 0xfe)

   241

   242

typedef void VehicleTickProc(Vehicle *v);

   243

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

   244

   245

void VehicleServiceInDepot(Vehicle *v);

   246

Vehicle *AllocateVehicle(void);

   247

Vehicle *ForceAllocateVehicle(void);

   248

Vehicle *ForceAllocateSpecialVehicle(void);

   249

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

   250

void VehiclePositionChanged(Vehicle *v);

   251

void AfterLoadVehicles(void);

   252

Vehicle *GetLastVehicleInChain(Vehicle *v);

   253

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   254

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   255

int CountVehiclesInChain(Vehicle *v);

   256

void DeleteVehicle(Vehicle *v);

   257

void DeleteVehicleChain(Vehicle *v);

   258

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

   259

void CallVehicleTicks(void);

   260

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   261

   262

void InitializeTrains(void);

   263

   264

bool CanFillVehicle(Vehicle *v);

   265

   266

void ViewportAddVehicles(DrawPixelInfo *dpi);

   267

   268

void TrainEnterDepot(Vehicle *v, uint tile);

   269

   270

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

   271

   272

/* train_cmd.h */

   273

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

   274

int GetAircraftImage(Vehicle *v, byte direction);

   275

int GetRoadVehImage(Vehicle *v, byte direction);

   276

int GetShipImage(Vehicle *v, byte direction);

   277

   278

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

   279

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

   280

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

   281

   282

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

   283

   284

void VehicleInTheWayErrMsg(Vehicle *v);

   285

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

   286

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   287

   288

bool UpdateSignalsOnSegment(uint tile, byte direction);

   289

void SetSignalsOnBothDir(uint tile, byte track);

   290

   291

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

   292

//uint GetVehicleWeight(Vehicle *v);

   293

   294

void DecreaseVehicleValue(Vehicle *v);

   295

void CheckVehicleBreakdown(Vehicle *v);

   296

void AgeVehicle(Vehicle *v);

   297

void MaybeReplaceVehicle(Vehicle *v);

   298

   299

void BeginVehicleMove(Vehicle *v);

   300

void EndVehicleMove(Vehicle *v);

   301

   302

bool IsAircraftHangarTile(TileIndex tile);

   303

void ShowAircraftViewWindow(Vehicle *v);

   304

   305

UnitID GetFreeUnitNumber(byte type);

   306

   307

int LoadUnloadVehicle(Vehicle *v);

   308

   309

void UpdateTrainAcceleration(Vehicle *v);

   310

int32 GetTrainRunningCost(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

	uint old_tile;

   319

	uint new_tile;

   320

} GetNewVehiclePosResult;

   321

   335

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

   336

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

   337

byte GetDirectionTowards(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

/* vehicle.c */

   343

VARDEF SortStruct *_vehicle_sort;

   344

   345

extern MemoryPool _vehicle_pool;

   346

   347

/**

   348

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

   349

 */

   350

static inline Vehicle *GetVehicle(VehicleID index)

   351

{

   352

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

   353

}

   354

   355

/**

   356

 * Get the current size of the VehiclePool

   357

 */

   358

static inline uint16 GetVehiclePoolSize(void)

   359

{

   360

	return _vehicle_pool.total_items;

   361

}

   362

   363

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

   364

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

   365

   366

/**

   367

 * Check if a Vehicle really exists.

   368

 */

   369

static inline bool IsValidVehicle(Vehicle* v)

   370

{

   371

	return v->type != 0;

   372

}

   373

   374

/**

   375

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

   376

 *

   377

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

   378

 */

   379

static inline bool IsVehicleIndex(uint index)

   380

{

   381

	if (index < GetVehiclePoolSize())

   382

		return true;

   383

   384

	return false;

   385

}

   386

   387

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

   388

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

   389

{

   390

	Order *order = v->orders;

   391

   392

	if (index < 0)

   393

		return NULL;

   394

   395

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

   396

		order = order->next;

   397

   398

	return order;

   399

}

   400

   401

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

   402

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   403

{

   404

	Order *order = v->orders;

   405

   406

	if (order == NULL)

   407

		return NULL;

   408

   409

	while (order->next != NULL)

   410

		order = order->next;

   411

   412

	return order;

   413

}

   414

   415

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

   416

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   417

{

   418

	Vehicle *u = v;

   419

	while (u->prev_shared != NULL)

   420

		u = u->prev_shared;

   421

   422

	return u;

   423

}

   424

   425

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

   426

VARDEF VehicleID _vehicle_position_hash[0x1000];

   427

   428

// NOSAVE: Return values from various commands.

   429

VARDEF VehicleID _new_train_id;

   430

VARDEF VehicleID _new_wagon_id;

   431

VARDEF VehicleID _new_aircraft_id;

   432

VARDEF VehicleID _new_ship_id;

   433

VARDEF VehicleID _new_roadveh_id;

   434

VARDEF uint16 _aircraft_refit_capacity;

   435

VARDEF byte _cmd_build_rail_veh_score;

   436

VARDEF byte _cmd_build_rail_veh_var1;

   437

   438

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

   439

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

   440

   441

#define INVALID_VEHICLE 0xffff

   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 */