1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "pool.h"

     5

#include "vehicle_gui.h"

     6

#include "order.h"

     7

     8

typedef struct VehicleRail {

     9

	uint16 last_speed;		// NOSAVE: only used in UI

    10

	uint16 crash_anim_pos;

    11

	uint16 days_since_order_progr;

    12

    13

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

    14

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

    15

    16

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

    17

	// 0xffff == not in train

    18

	uint16 first_engine;

    19

    20

	byte track;

    21

	byte force_proceed;

    22

	byte railtype;

    23

    24

	byte flags;

    25

} VehicleRail;

    26

    27

enum {

    28

	VRF_REVERSING = 0,

    29

    30

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

    31

	VRF_GOINGUP   = 1,

    32

	VRF_GOINGDOWN = 2,

    33

};

    34

    35

typedef struct VehicleAir {

    36

	uint16 crashed_counter;

    37

	byte pos;

    38

  byte previous_pos;

    39

	uint16 targetairport;

    40

	byte state;

    41

} VehicleAir;

    42

    43

typedef struct VehicleRoad {

    44

	byte state;

    45

	byte frame;

    46

	uint16 unk2;

    47

	byte overtaking;

    48

	byte overtaking_ctr;

    49

	uint16 crashed_ctr;

    50

	byte reverse_ctr;

    51

	struct RoadStop *slot;

    52

	byte slotindex;

    53

	byte slot_age;

    54

} VehicleRoad;

    55

    56

typedef struct VehicleSpecial {

    57

	uint16 unk0;

    58

	byte unk2;

    59

} VehicleSpecial;

    60

    61

typedef struct VehicleDisaster {

    62

	uint16 image_override;

    63

	uint16 unk2;

    64

} VehicleDisaster;

    65

    66

typedef struct VehicleShip {

    67

	byte state;

    68

} VehicleShip;

    69

    70

// not used ATM

    71

struct WorldSprite {

    72

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

    73

	uint16 image;			// sprite number for this vehicle

    74

    75

	// screen coordinates

    76

	int16 left, top, right, bottom;

    77

    78

	// world coordinates

    79

	int16 x;

    80

	int16 y;

    81

	byte z;

    82

    83

	int8 x_offs;			// x offset for vehicle sprite

    84

	int8 y_offs;			// y offset for vehicle sprite

    85

    86

	byte width;				// width of vehicle sprite

    87

	byte height;			// height of vehicle sprite

    88

	byte depth;				// depth of vehicle sprite

    89

    90

	byte flags;				// draw flags

    91

};

    92

    93

struct Vehicle {

    94

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

    95

	byte subtype;			// subtype (for trains, 0 == loco, 4 wagon ??)

    96

    97

	uint16 index;			// NOSAVE: Index in vehicle array

    98

    99

	Vehicle *next;		// next

   100

   101

	StringID string_id; // Displayed string

   102

   103

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

   104

	byte owner;				// which player owns the vehicle?

   105

   106

	TileIndex tile;		// Current tile index

   107

	TileIndex dest_tile; // Heading for this tile

   108

   109

	int32 x_pos;			// coordinates

   110

	int32 y_pos;

   111

	byte z_pos;

   112

	byte direction;		// facing

   113

   114

	byte spritenum; // currently displayed sprite index

   115

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

   116

	                // 0xff == reserved for another custom sprite

   117

	uint16 cur_image; // sprite number for this vehicle

   118

	byte sprite_width;// width of vehicle sprite

   119

	byte sprite_height;// height of vehicle sprite

   120

	byte z_height;		// z-height of vehicle sprite

   121

	int8 x_offs;			// x offset for vehicle sprite

   122

	int8 y_offs;			// y offset for vehicle sprite

   123

	uint16 engine_type;

   124

   125

	// for randomized variational spritegroups

   126

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

   127

	// of corresponding spritegroups get matched

   128

	byte random_bits;

   129

	byte waiting_triggers; // triggers to be yet matched

   130

   131

	uint16 max_speed;	// maximum speed

   132

	uint16 cur_speed;	// current speed

   133

	byte subspeed;		// fractional speed

   134

	byte acceleration; // used by train & aircraft

   135

	byte progress;

   136

   137

	byte vehstatus;		// Status

   138

	uint16 last_station_visited;

   139

   140

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

   141

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

   142

	uint16 cargo_source;// source of cargo

   143

	uint16 cargo_cap;	// total capacity

   144

	uint16 cargo_count;// how many pieces are used

   145

   146

	byte day_counter; // increased by one for each day

   147

	byte tick_counter;// increased by one for each tick

   148

   149

	/* Begin Order-stuff */

   150

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

   151

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

   152

   153

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

   154

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

   155

   156

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

   157

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

   158

	/* End Order-stuff */

   159

   160

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

   161

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

   162

	int32 left_coord;

   163

	int32 top_coord;

   164

	int32 right_coord;

   165

	int32 bottom_coord;

   166

	uint16 next_hash;

   167

   168

	// Related to age and service time

   169

	uint16 age;				// Age in days

   170

	uint16 max_age;		// Maximum age

   171

	uint16 date_of_last_service;

   172

	uint16 service_interval;

   173

	uint16 reliability;

   174

	uint16 reliability_spd_dec;

   175

	byte breakdown_ctr;

   176

	byte breakdown_delay;

   177

	byte breakdowns_since_last_service;

   178

	byte breakdown_chance;

   179

	byte build_year;

   180

   181

	uint16 load_unload_time_rem;

   182

   183

	int32 profit_this_year;

   184

	int32 profit_last_year;

   185

	uint32 value;

   186

   187

	bool set_for_replacement;   // marks this vehicle to be replaced

   188

   189

	union {

   190

		VehicleRail rail;

   191

		VehicleAir air;

   192

		VehicleRoad road;

   193

		VehicleSpecial special;

   194

		VehicleDisaster disaster;

   195

		VehicleShip ship;

   196

	} u;

   197

};

   198

   199

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

   200

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

   201

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

   202

   203

// train waypoint

   204

struct Waypoint {

   205

	TileIndex xy;

   206

	uint16 town_or_string; // if this is 0xC000, it's a string id, otherwise a town.

   207

	ViewportSign sign;

   208

	uint16 build_date;

   209

	byte stat_id;

   210

	byte deleted;					 // this is a delete counter. when it reaches 0, the waypoint struct is deleted.

   211

};

   212

   213

enum {

   214

	VEH_Train = 0x10,

   215

	VEH_Road = 0x11,

   216

	VEH_Ship = 0x12,

   217

	VEH_Aircraft = 0x13,

   218

	VEH_Special = 0x14,

   219

	VEH_Disaster = 0x15,

   220

};

   221

   222

enum VehStatus {

   223

	VS_HIDDEN = 1,

   224

	VS_STOPPED = 2,

   225

	VS_UNCLICKABLE = 4,

   226

	VS_DEFPAL = 0x8,

   227

	VS_TRAIN_SLOWING = 0x10,

   228

	VS_DISASTER = 0x20,

   229

	VS_AIRCRAFT_BROKEN = 0x40,

   230

	VS_CRASHED = 0x80,

   231

};

   232

   233

// 1 and 3 do not appear to be used

   234

enum TrainSubtype {

   235

	TS_Front_Engine = 0,

   236

	TS_Not_First = 2,

   237

	TS_Free_Car = 4,

   238

};

   239

   240

/* Effect vehicle types */

   248

	EV_BREAKDOWN_SMOKE = 6,

   253

   254

typedef void VehicleTickProc(Vehicle *v);

   255

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

   256

   257

void VehicleServiceInDepot(Vehicle *v);

   258

Vehicle *AllocateVehicle(void);

   259

Vehicle *ForceAllocateVehicle(void);

   260

Vehicle *ForceAllocateSpecialVehicle(void);

   261

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

   262

void VehiclePositionChanged(Vehicle *v);

   263

void AfterLoadVehicles(void);

   264

Vehicle *GetLastVehicleInChain(Vehicle *v);

   265

Vehicle *GetPrevVehicleInChain(Vehicle *v);

   266

Vehicle *GetFirstVehicleInChain(Vehicle *v);

   267

int CountVehiclesInChain(Vehicle *v);

   268

void DeleteVehicle(Vehicle *v);

   269

void DeleteVehicleChain(Vehicle *v);

   270

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

   271

void CallVehicleTicks(void);

   272

   273

Waypoint *AllocateWaypoint(void);

   274

void UpdateWaypointSign(Waypoint *cp);

   275

void RedrawWaypointSign(Waypoint *cp);

   276

   277

void InitializeTrains(void);

   278

   279

bool CanFillVehicle(Vehicle *v);

   280

   281

void ViewportAddVehicles(DrawPixelInfo *dpi);

   282

   283

void TrainEnterDepot(Vehicle *v, uint tile);

   284

   285

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

   286

   287

/* train_cmd.h */

   288

int GetTrainImage(Vehicle *v, byte direction);

   289

int GetAircraftImage(Vehicle *v, byte direction);

   290

int GetRoadVehImage(Vehicle *v, byte direction);

   291

int GetShipImage(Vehicle *v, byte direction);

   292

   296

   297

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

   298

   299

void VehicleInTheWayErrMsg(Vehicle *v);

   300

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

   301

uint GetVehicleOutOfTunnelTile(Vehicle *v);

   302

   303

bool UpdateSignalsOnSegment(uint tile, byte direction);

   304

void SetSignalsOnBothDir(uint tile, byte track);

   305

   306

Vehicle *CheckClickOnVehicle(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

uint GetWaypointByTile(uint tile);

   324

   325

void UpdateTrainAcceleration(Vehicle *v);

   326

int32 GetTrainRunningCost(Vehicle *v);

   327

   328

int CheckTrainStoppedInDepot(Vehicle *v);

   329

   330

bool VehicleNeedsService(const Vehicle *v);

   331

   332

typedef struct GetNewVehiclePosResult {

   333

	int x,y;

   334

	uint old_tile;

   335

	uint new_tile;

   336

} GetNewVehiclePosResult;

   337

   338

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

   339

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

   340

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

   341

   342

#define BEGIN_ENUM_WAGONS(v) do {

   343

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

   344

   345

/* vehicle.c */

   346

VARDEF SortStruct *_vehicle_sort;

   347

   348

extern MemoryPool _vehicle_pool;

   349

   350

/**

   351

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

   352

 */

   353

static inline Vehicle *GetVehicle(VehicleID index)

   354

{

   355

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

   356

}

   357

   358

/**

   359

 * Get the current size of the VehiclePool

   360

 */

   361

static inline uint16 GetVehiclePoolSize(void)

   362

{

   363

	return _vehicle_pool.total_items;

   364

}

   365

   366

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

   367

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

   368

   369

/**

   370

 * Check if a Vehicle really exists.

   371

 */

   372

static inline bool IsValidVehicle(Vehicle* v)

   373

{

   374

	return v->type != 0;

   375

}

   376

   377

/**

   378

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

   379

 *

   380

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

   381

 */

   382

static inline bool IsVehicleIndex(uint index)

   383

{

   384

	if (index < GetVehiclePoolSize())

   385

		return true;

   386

   387

	return false;

   388

}

   389

   390

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

   391

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

   392

{

   393

	Order *order = v->orders;

   394

   395

	if (index < 0)

   396

		return NULL;

   397

   398

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

   399

		order = order->next;

   400

   401

	return order;

   402

}

   403

   404

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

   405

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   406

{

   407

	Order *order = v->orders;

   408

   409

	if (order == NULL)

   410

		return NULL;

   411

   412

	while (order->next != NULL)

   413

		order = order->next;

   414

   415

	return order;

   416

}

   417

   418

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

   419

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   420

{

   421

	Vehicle *u = v;

   422

	while (u->prev_shared != NULL)

   423

		u = u->prev_shared;

   424

   425

	return u;

   426

}

   427

   428

// 128 waypoints

   429

VARDEF Waypoint _waypoints[128];

   430

   431

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

   432

VARDEF VehicleID _vehicle_position_hash[0x1000];

   433

   434

// NOSAVE: Return values from various commands.

   435

VARDEF VehicleID _new_train_id;

   436

VARDEF VehicleID _new_wagon_id;

   437

VARDEF VehicleID _new_aircraft_id;

   438

VARDEF VehicleID _new_ship_id;

   439

VARDEF VehicleID _new_roadveh_id;

   440

VARDEF uint16 _aircraft_refit_capacity;

   441

VARDEF byte _cmd_build_rail_veh_score;

   442

VARDEF byte _cmd_build_rail_veh_var1;

   443

   444

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

   445

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

   446

   447

#define INVALID_VEHICLE 0xffff

   448

   449

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

   450

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

   451

#define STATUS_BAR 5

   452

   453

#endif /* VEHICLE_H */