1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "vehicle_gui.h"

     5

#include "order.h"

     6

     7

typedef struct VehicleRail {

     8

	uint16 last_speed;		// NOSAVE: only used in UI

     9

	uint16 crash_anim_pos;

    10

	uint16 days_since_order_progr;

    11

    12

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

    13

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

    14

    15

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

    16

	// 0xffff == not in train

    17

	uint16 first_engine;

    18

    19

	byte track;

    20

	byte force_proceed;

    21

	byte railtype;

    22

    23

	byte flags;

    24

} VehicleRail;

    25

    26

enum {

    27

	VRF_REVERSING = 0,

    28

    29

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

    30

	VRF_GOINGUP   = 1,

    31

	VRF_GOINGDOWN = 2,

    32

};

    33

    34

typedef struct VehicleAir {

    35

	uint16 crashed_counter;

    36

	byte pos;

    37

  byte previous_pos;

    38

	uint16 targetairport;

    39

	byte state;

    40

} VehicleAir;

    41

    42

typedef struct VehicleRoad {

    43

	byte state;

    44

	byte frame;

    45

	uint16 unk2;

    46

	byte overtaking;

    47

	byte overtaking_ctr;

    48

	uint16 crashed_ctr;

    49

	byte reverse_ctr;

    50

} VehicleRoad;

    51

    52

typedef struct VehicleSpecial {

    53

	uint16 unk0;

    54

	byte unk2;

    55

} VehicleSpecial;

    56

    57

typedef struct VehicleDisaster {

    58

	uint16 image_override;

    59

	uint16 unk2;

    60

} VehicleDisaster;

    61

    62

typedef struct VehicleShip {

    63

	byte state;

    64

} VehicleShip;

    65

    66

// not used ATM

    67

struct WorldSprite {

    68

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

    69

	uint16 image;			// sprite number for this vehicle

    70

    71

	// screen coordinates

    72

	int16 left, top, right, bottom;

    73

    74

	// world coordinates

    75

	int16 x;

    76

	int16 y;

    77

	byte z;

    78

    79

	int8 x_offs;			// x offset for vehicle sprite

    80

	int8 y_offs;			// y offset for vehicle sprite

    81

    82

	byte width;				// width of vehicle sprite

    83

	byte height;			// height of vehicle sprite

    84

	byte depth;				// depth of vehicle sprite

    85

    86

	byte flags;				// draw flags

    87

};

    88

    89

struct Vehicle {

    90

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

    91

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

    92

    93

	uint16 index;			// NOSAVE: Index in vehicle array

    94

    95

	Vehicle *next;		// next

    96

    97

	StringID string_id; // Displayed string

    98

    99

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

   100

	byte owner;				// which player owns the vehicle?

   101

   102

	TileIndex tile;		// Current tile index

   103

	TileIndex dest_tile; // Heading for this tile

   104

   107

	byte z_pos;

   108

	byte direction;		// facing

   109

   110

	byte spritenum; // currently displayed sprite index

   111

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

   112

	                // 0xff == reserved for another custom sprite

   113

	uint16 cur_image; // sprite number for this vehicle

   114

	byte sprite_width;// width of vehicle sprite

   115

	byte sprite_height;// height of vehicle sprite

   116

	byte z_height;		// z-height of vehicle sprite

   117

	int8 x_offs;			// x offset for vehicle sprite

   118

	int8 y_offs;			// y offset for vehicle sprite

   119

	uint16 engine_type;

   120

   121

	// for randomized variational spritegroups

   122

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

   123

	// of corresponding spritegroups get matched

   124

	byte random_bits;

   125

	byte waiting_triggers; // triggers to be yet matched

   126

   127

	uint16 max_speed;	// maximum speed

   128

	uint16 cur_speed;	// current speed

   129

	byte subspeed;		// fractional speed

   130

	byte acceleration; // used by train & aircraft

   131

	byte progress;

   132

   133

	byte vehstatus;		// Status

   134

	uint16 last_station_visited;

   135

   136

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

   137

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

   138

	byte cargo_source;// source of cargo

   139

	uint16 cargo_cap;	// total capacity

   140

	uint16 cargo_count;// how many pieces are used

   141

   142

	byte day_counter; // increased by one for each day

   143

	byte tick_counter;// increased by one for each tick

   144

   145

	/* Begin Order-stuff */

   146

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

   147

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

   148

   149

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

   150

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

   151

   152

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

   153

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

   154

	/* End Order-stuff */

   155

   156

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

   157

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

   158

	int32 left_coord;

   159

	int32 top_coord;

   160

	int32 right_coord;

   161

	int32 bottom_coord;

   162

	uint16 next_hash;

   163

   164

	// Related to age and service time

   165

	uint16 age;				// Age in days

   166

	uint16 max_age;		// Maximum age

   167

	uint16 date_of_last_service;

   168

	uint16 service_interval;

   169

	uint16 reliability;

   170

	uint16 reliability_spd_dec;

   171

	byte breakdown_ctr;

   172

	byte breakdown_delay;

   173

	byte breakdowns_since_last_service;

   174

	byte breakdown_chance;

   175

	byte build_year;

   176

   177

	uint16 load_unload_time_rem;

   178

   179

	int32 profit_this_year;

   180

	int32 profit_last_year;

   181

	uint32 value;

   182

   183

	bool set_for_replacement;   // marks this vehicle to be replaced

   184

   185

	union {

   186

		VehicleRail rail;

   187

		VehicleAir air;

   188

		VehicleRoad road;

   189

		VehicleSpecial special;

   190

		VehicleDisaster disaster;

   191

		VehicleShip ship;

   192

	} u;

   193

};

   194

   195

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

   196

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

   197

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

   198

   199

struct Depot {

   200

	TileIndex xy;

   201

	uint16 town_index;

   202

};

   203

   204

// train waypoint

   205

struct Waypoint {

   206

	TileIndex xy;

   207

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

   208

	ViewportSign sign;

   209

	uint16 build_date;

   210

	byte stat_id;

   211

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

   212

};

   213

   214

enum {

   215

	VEH_Train = 0x10,

   216

	VEH_Road = 0x11,

   217

	VEH_Ship = 0x12,

   218

	VEH_Aircraft = 0x13,

   219

	VEH_Special = 0x14,

   220

	VEH_Disaster = 0x15,

   221

};

   222

   223

enum VehStatus {

   224

	VS_HIDDEN = 1,

   225

	VS_STOPPED = 2,

   226

	VS_UNCLICKABLE = 4,

   227

	VS_DEFPAL = 0x8,

   228

	VS_TRAIN_SLOWING = 0x10,

   229

	VS_DISASTER = 0x20,

   230

	VS_AIRCRAFT_BROKEN = 0x40,

   231

	VS_CRASHED = 0x80,

   232

};

   233

   234

// 1 and 3 do not appear to be used

   235

enum TrainSubtype {

   236

	TS_Front_Engine = 0,

   237

	TS_Not_First = 2,

   238

	TS_Free_Car = 4,

   239

};

   240

   241

/* Effect vehicle types */

   242

enum {

   243

	EV_INDUSTRYSMOKE = 0,

   244

	EV_STEAM_SMOKE = 1,

   245

   246

	EV_SMOKE_1 = 2,

   247

	EV_SMOKE_2 = 3,

   248

	EV_SMOKE_3 = 4,

   249

   250

	EV_CRASHED_SMOKE = 5,

   251

	EV_BREAKDOWN_SMOKE = 6,

   252

   253

	EV_DEMOLISH = 7,

   254

	EV_ROADWORK = 8,

   255

   256

	EV_INDUSTRY_SMOKE = 9,

   257

   258

};

   259

   260

typedef void VehicleTickProc(Vehicle *v);

   261

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

   262

   263

void VehicleServiceInDepot(Vehicle *v);

   264

Vehicle *AllocateVehicle(void);

   265

Vehicle *ForceAllocateVehicle(void);

   266

Vehicle *ForceAllocateSpecialVehicle(void);

   267

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

   268

void VehiclePositionChanged(Vehicle *v);

   269

void AfterLoadVehicles(void);

   270

Vehicle *GetLastVehicleInChain(Vehicle *v);

   271

Vehicle *GetPrevVehicleInChain(Vehicle *v);

   272

Vehicle *GetFirstVehicleInChain(Vehicle *v);

   273

int CountVehiclesInChain(Vehicle *v);

   274

void DeleteVehicle(Vehicle *v);

   275

void DeleteVehicleChain(Vehicle *v);

   276

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

   277

void CallVehicleTicks(void);

   278

   279

Depot *AllocateDepot(void);

   280

Waypoint *AllocateWaypoint(void);

   281

void UpdateWaypointSign(Waypoint *cp);

   282

void RedrawWaypointSign(Waypoint *cp);

   283

   284

void InitializeTrains(void);

   285

bool IsTrainDepotTile(TileIndex tile);

   286

bool IsRoadDepotTile(TileIndex tile);

   287

   288

bool CanFillVehicle(Vehicle *v);

   289

   290

void ViewportAddVehicles(DrawPixelInfo *dpi);

   291

   292

void TrainEnterDepot(Vehicle *v, uint tile);

   293

   294

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

   295

   296

/* train_cmd.h */

   297

int GetTrainImage(Vehicle *v, byte direction);

   298

int GetAircraftImage(Vehicle *v, byte direction);

   299

int GetRoadVehImage(Vehicle *v, byte direction);

   300

int GetShipImage(Vehicle *v, byte direction);

   301

   302

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

   303

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

   304

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

   305

   306

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

   307

   308

void VehicleInTheWayErrMsg(Vehicle *v);

   309

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

   310

uint GetVehicleOutOfTunnelTile(Vehicle *v);

   311

   312

bool UpdateSignalsOnSegment(uint tile, byte direction);

   313

void SetSignalsOnBothDir(uint tile, byte track);

   314

   315

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

   316

//uint GetVehicleWeight(Vehicle *v);

   317

   318

void DecreaseVehicleValue(Vehicle *v);

   319

void CheckVehicleBreakdown(Vehicle *v);

   320

void AgeVehicle(Vehicle *v);

   321

void MaybeReplaceVehicle(Vehicle *v);

   322

   323

void BeginVehicleMove(Vehicle *v);

   324

void EndVehicleMove(Vehicle *v);

   325

   326

bool IsAircraftHangarTile(TileIndex tile);

   327

void ShowAircraftViewWindow(Vehicle *v);

   328

   329

bool IsShipDepotTile(TileIndex tile);

   330

uint GetFreeUnitNumber(byte type);

   331

   332

int LoadUnloadVehicle(Vehicle *v);

   333

int GetDepotByTile(uint tile);

   334

uint GetWaypointByTile(uint tile);

   335

   336

void DoDeleteDepot(uint tile);

   337

   338

void UpdateTrainAcceleration(Vehicle *v);

   339

int32 GetTrainRunningCost(Vehicle *v);

   340

   341

int CheckStoppedInDepot(Vehicle *v);

   342

   343

bool VehicleNeedsService(const Vehicle *v);

   344

   345

typedef struct GetNewVehiclePosResult {

   346

	int x,y;

   347

	uint old_tile;

   348

	uint new_tile;

   349

} GetNewVehiclePosResult;

   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

enum {

   360

	NUM_NORMAL_VEHICLES = 2048,

   361

	NUM_SPECIAL_VEHICLES = 512,

   362

	NUM_VEHICLES = NUM_NORMAL_VEHICLES + NUM_SPECIAL_VEHICLES

   363

};

   364

   365

VARDEF Vehicle _vehicles[NUM_VEHICLES];

   366

VARDEF uint _vehicles_size;

   367

   368

VARDEF SortStruct *_vehicle_sort;

   369

   370

static inline Vehicle *GetVehicle(uint index)

   371

{

   372

	assert(index < _vehicles_size);

   373

	return &_vehicles[index];

   374

}

   375

   376

#define FOR_ALL_VEHICLES(v) for(v = _vehicles; v != &_vehicles[_vehicles_size]; v++)

   377

#define FOR_ALL_VEHICLES_FROM(v, from) for(v = GetVehicle(from); v != &_vehicles[_vehicles_size]; v++)

   378

   379

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

   380

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

   381

{

   382

	Order *order = v->orders;

   383

   384

	if (index < 0)

   385

		return NULL;

   386

   387

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

   388

		order = order->next;

   389

   390

	return order;

   391

}

   392

   393

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

   394

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   395

{

   396

	Order *order = v->orders;

   397

   398

	if (order == NULL)

   399

		return NULL;

   400

   401

	while (order->next != NULL)

   402

		order = order->next;

   403

   404

	return order;

   405

}

   406

   407

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

   408

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   409

{

   410

	Vehicle *u = v;

   411

	while (u->prev_shared != NULL)

   412

		u = u->prev_shared;

   413

   414

	return u;

   415

}

   416

   417

VARDEF Depot _depots[255];

   418

   419

// 128 waypoints

   420

VARDEF Waypoint _waypoints[128];

   421

   422

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

   423

VARDEF VehicleID _vehicle_position_hash[0x1000];

   424

   425

// NOSAVE: Return values from various commands.

   426

VARDEF VehicleID _new_train_id;

   427

VARDEF VehicleID _new_wagon_id;

   428

VARDEF VehicleID _new_aircraft_id;

   429

VARDEF VehicleID _new_ship_id;

   430

VARDEF VehicleID _new_roadveh_id;

   431

VARDEF uint16 _aircraft_refit_capacity;

   432

VARDEF byte _cmd_build_rail_veh_score;

   433

VARDEF byte _cmd_build_rail_veh_var1;

   434

   435

// NOSAVE: Player specific info

   436

VARDEF TileIndex _last_built_train_depot_tile;

   437

VARDEF TileIndex _last_built_road_depot_tile;

   438

VARDEF TileIndex _last_built_aircraft_depot_tile;

   439

VARDEF TileIndex _last_built_ship_depot_tile;

   440

   441

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

   442

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

   443

   444

#define INVALID_VEHICLE 0xffff

   445

   446

#define MIN_SERVINT_PERCENT  5

   447

#define MAX_SERVINT_PERCENT 90

   448

#define MIN_SERVINT_DAYS    30

   449

#define MAX_SERVINT_DAYS   800

   450

   451

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

   452

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

   453

#define STATUS_BAR 5

   454

   455

#endif /* VEHICLE_H */