1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "vehicle_gui.h"

     5

     6

typedef struct Order {

     7

	uint8 type;

     8

	uint8 flags;

     9

	uint16 station;

    10

} Order;

    11

    12

static inline uint32 PackOrder(const Order *order)

    13

{

    14

	return order->station << 16 | order->flags << 8 | order->type;

    15

}

    16

    17

static inline Order UnpackOrder(uint32 packed)

    18

{

    19

	Order order;

    20

	order.type    = (packed & 0x000000FF);

    21

	order.flags   = (packed & 0x0000FF00) >> 8;

    22

	order.station = (packed & 0xFFFF0000) >> 16;

    23

	return order;

    24

}

    25

    26

static inline Order UnpackVersion4Order(uint16 packed)

    27

{

    28

	Order order;

    29

	order.type    = (packed & 0x000F);

    30

	order.flags   = (packed & 0x00F0) >> 4;

    31

	order.station = (packed & 0xFF00) >> 8;

    32

	return order;

    33

}

    34

    35

Order UnpackOldOrder(uint16 packed);

    36

    37

    38

typedef struct VehicleRail {

    39

	uint16 last_speed;		// NOSAVE: only used in UI

    40

	uint16 crash_anim_pos;

    41

	uint16 days_since_order_progr;

    42

    43

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

    44

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

    45

    46

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

    47

	// 0xffff == not in train

    48

	uint16 first_engine;

    49

    50

	byte track;

    51

	byte force_proceed;

    52

	byte railtype;

    53

    54

	byte flags;

    55

} VehicleRail;

    56

    57

enum {

    58

	VRF_REVERSING = 1,

    59

    60

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

    61

	VRF_GOINGUP = 2,

    62

	VRF_GOINGDOWN = 4,

    63

};

    64

    65

typedef struct VehicleAir {

    66

	uint16 crashed_counter;

    67

	byte pos;

    68

  byte previous_pos;

    69

	uint16 targetairport;

    70

	byte state;

    71

} VehicleAir;

    72

    73

typedef struct VehicleRoad {

    74

	byte state;

    75

	byte frame;

    76

	uint16 unk2;

    77

	byte overtaking;

    78

	byte overtaking_ctr;

    79

	uint16 crashed_ctr;

    80

	byte reverse_ctr;

    81

} VehicleRoad;

    82

    83

typedef struct VehicleSpecial {

    84

	uint16 unk0;

    85

	byte unk2;

    86

} VehicleSpecial;

    87

    88

typedef struct VehicleDisaster {

    89

	uint16 image_override;

    90

	uint16 unk2;

    91

} VehicleDisaster;

    92

    93

typedef struct VehicleShip {

    94

	byte state;

    95

} VehicleShip;

    96

    97

// not used ATM

    98

struct WorldSprite {

    99

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

   100

	uint16 image;			// sprite number for this vehicle

   101

   102

	// screen coordinates

   103

	int16 left, top, right, bottom;

   104

   105

	// world coordinates

   106

	int16 x;

   107

	int16 y;

   108

	byte z;

   109

   110

	int8 x_offs;			// x offset for vehicle sprite

   111

	int8 y_offs;			// y offset for vehicle sprite

   112

   113

	byte width;				// width of vehicle sprite

   114

	byte height;			// height of vehicle sprite

   115

	byte depth;				// depth of vehicle sprite

   116

   117

	byte flags;				// draw flags

   118

};

   119

   120

struct Vehicle {

   121

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

   122

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

   123

   124

	uint16 index;			// NOSAVE: Index in vehicle array

   125

   126

	Vehicle *next;		// next

   127

   128

	StringID string_id; // Displayed string

   129

   130

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

   131

	byte owner;				// which player owns the vehicle?

   132

   133

	TileIndex tile;		// Current tile index

   134

	TileIndex dest_tile; // Heading for this tile

   135

   136

	int16 x_pos;			// coordinates

   137

	int16 y_pos;

   138

	byte z_pos;

   139

	byte direction;		// facing

   140

   141

	byte spritenum; // currently displayed sprite index

   142

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

   143

	                // 0xff == reserved for another custom sprite

   144

	uint16 cur_image; // sprite number for this vehicle

   145

	byte sprite_width;// width of vehicle sprite

   146

	byte sprite_height;// height of vehicle sprite

   147

	byte z_height;		// z-height of vehicle sprite

   148

	int8 x_offs;			// x offset for vehicle sprite

   149

	int8 y_offs;			// y offset for vehicle sprite

   150

	uint16 engine_type;

   151

   152

	// for randomized variational spritegroups

   153

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

   154

	// of corresponding spritegroups get matched

   155

	byte random_bits;

   156

	byte waiting_triggers; // triggers to be yet matched

   157

   158

	uint16 max_speed;	// maximum speed

   159

	uint16 cur_speed;	// current speed

   160

	byte subspeed;		// fractional speed

   161

	byte acceleration; // used by train & aircraft

   162

	byte progress;

   163

   164

	byte vehstatus;		// Status

   165

	uint16 last_station_visited;

   166

   167

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

   168

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

   169

	byte cargo_source;// source of cargo

   170

	uint16 cargo_cap;	// total capacity

   171

	uint16 cargo_count;// how many pieces are used

   172

   173

	byte day_counter; // increased by one for each day

   174

	byte tick_counter;// increased by one for each tick

   175

   176

	// related to the current order

   177

	byte cur_order_index;

   178

	byte num_orders;

   179

	Order current_order;

   180

	Order *schedule_ptr;

   181

   182

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

   183

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

   184

	int32 left_coord;

   185

	int32 top_coord;

   186

	int32 right_coord;

   187

	int32 bottom_coord;

   188

	uint16 next_hash;

   189

   190

	// Related to age and service time

   191

	uint16 age;				// Age in days

   192

	uint16 max_age;		// Maximum age

   193

	uint16 date_of_last_service;

   194

	uint16 service_interval;

   195

	uint16 reliability;

   196

	uint16 reliability_spd_dec;

   197

	byte breakdown_ctr;

   198

	byte breakdown_delay;

   199

	byte breakdowns_since_last_service;

   200

	byte breakdown_chance;

   201

	byte build_year;

   202

   203

	uint16 load_unload_time_rem;

   204

   205

	int32 profit_this_year;

   206

	int32 profit_last_year;

   207

	uint32 value;

   208

   209

	union {

   210

		VehicleRail rail;

   211

		VehicleAir air;

   212

		VehicleRoad road;

   213

		VehicleSpecial special;

   214

		VehicleDisaster disaster;

   215

		VehicleShip ship;

   216

	} u;

   217

};

   218

   219

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

   220

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

   221

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

   222

   223

struct Depot {

   224

	TileIndex xy;

   225

	uint16 town_index;

   226

};

   227

   228

// train waypoint

   229

struct Waypoint {

   230

	TileIndex xy;

   231

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

   232

	ViewportSign sign;

   233

	uint16 build_date;

   234

	byte stat_id;

   235

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

   236

};

   237

   238

enum {

   239

	VEH_Train = 0x10,

   240

	VEH_Road = 0x11,

   241

	VEH_Ship = 0x12,

   242

	VEH_Aircraft = 0x13,

   243

	VEH_Special = 0x14,

   244

	VEH_Disaster = 0x15,

   245

};

   246

   247

/* Order types */

   248

enum {

   249

	OT_NOTHING = 0,

   250

	OT_GOTO_STATION = 1,

   251

	OT_GOTO_DEPOT = 2,

   252

	OT_LOADING = 3,

   253

	OT_LEAVESTATION = 4,

   254

	OT_DUMMY = 5,

   255

	OT_GOTO_WAYPOINT = 6,

   256

};

   257

   258

/* Order flags */

   259

enum {

   260

	OF_UNLOAD    = 0x2,

   261

	OF_FULL_LOAD = 0x4, // Also used when to force an aircraft into a depot

   262

	OF_NON_STOP  = 0x8

   263

};

   264

   265

   266

enum VehStatus {

   267

	VS_HIDDEN = 1,

   268

	VS_STOPPED = 2,

   269

	VS_UNCLICKABLE = 4,

   270

	VS_DEFPAL = 0x8,

   271

	VS_TRAIN_SLOWING = 0x10,

   272

	VS_DISASTER = 0x20,

   273

	VS_AIRCRAFT_BROKEN = 0x40,

   274

	VS_CRASHED = 0x80,

   275

};

   276

   277

   278

   279

/* Effect vehicle types */

   280

enum {

   281

	EV_INDUSTRYSMOKE = 0,

   282

	EV_STEAM_SMOKE = 1,

   283

   284

	EV_SMOKE_1 = 2,

   285

	EV_SMOKE_2 = 3,

   286

	EV_SMOKE_3 = 4,

   287

   288

	EV_CRASHED_SMOKE = 5,

   289

	EV_BREAKDOWN_SMOKE = 6,

   290

   291

	EV_DEMOLISH = 7,

   292

	EV_ROADWORK = 8,

   293

   294

	EV_INDUSTRY_SMOKE = 9,

   295

   296

};

   297

   298

typedef void VehicleTickProc(Vehicle *v);

   299

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

   300

   301

typedef struct {

   302

	VehicleID clone;

   303

	byte orderindex;

   304

	Order order[41];

   305

	uint16 service_interval;

   306

	char name[32];

   307

} BackuppedOrders;

   308

   309

void VehicleServiceInDepot(Vehicle *v);

   310

void BackupVehicleOrders(Vehicle *v, BackuppedOrders *order);

   311

void RestoreVehicleOrders(Vehicle *v, BackuppedOrders *order);

   312

Vehicle *AllocateVehicle();

   313

Vehicle *ForceAllocateVehicle();

   314

Vehicle *ForceAllocateSpecialVehicle();

   315

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

   316

void InitializeVehicles();

   317

void VehiclePositionChanged(Vehicle *v);

   318

void AfterLoadVehicles();

   319

Vehicle *GetLastVehicleInChain(Vehicle *v);

   320

Vehicle *GetPrevVehicleInChain(Vehicle *v);

   321

Vehicle *GetFirstVehicleInChain(Vehicle *v);

   322

int CountVehiclesInChain(Vehicle *v);

   323

void DeleteVehicle(Vehicle *v);

   324

void DeleteVehicleChain(Vehicle *v);

   325

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

   326

void CallVehicleTicks();

   327

void DeleteVehicleSchedule(Vehicle *v);

   328

Vehicle *IsScheduleShared(Vehicle *v);

   329

   330

Depot *AllocateDepot();

   331

Waypoint *AllocateWaypoint();

   332

void UpdateWaypointSign(Waypoint *cp);

   333

void RedrawWaypointSign(Waypoint *cp);

   334

   335

void InitializeTrains();

   336

bool IsTrainDepotTile(TileIndex tile);

   337

bool IsRoadDepotTile(TileIndex tile);

   338

   339

bool CanFillVehicle(Vehicle *v);

   340

   341

void ViewportAddVehicles(DrawPixelInfo *dpi);

   342

   343

void TrainEnterDepot(Vehicle *v, uint tile);

   344

   345

/* train_cmd.h */

   346

int GetTrainImage(Vehicle *v, byte direction);

   347

int GetAircraftImage(Vehicle *v, byte direction);

   348

int GetRoadVehImage(Vehicle *v, byte direction);

   349

int GetShipImage(Vehicle *v, byte direction);

   350

   351

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

   352

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

   353

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

   354

   355

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

   356

   357

void VehicleInTheWayErrMsg(Vehicle *v);

   358

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

   359

uint GetVehicleOutOfTunnelTile(Vehicle *v);

   360

   361

bool UpdateSignalsOnSegment(uint tile, byte direction);

   362

void SetSignalsOnBothDir(uint tile, byte track);

   363

   364

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

   365

//uint GetVehicleWeight(Vehicle *v);

   366

   367

void DecreaseVehicleValue(Vehicle *v);

   368

void CheckVehicleBreakdown(Vehicle *v);

   369

void AgeVehicle(Vehicle *v);

   370

void MaybeReplaceVehicle(Vehicle *v);

   371

   372

void DeleteCommandFromVehicleSchedule(Order cmd);

   373

   374

void BeginVehicleMove(Vehicle *v);

   375

void EndVehicleMove(Vehicle *v);

   376

   377

bool IsAircraftHangarTile(TileIndex tile);

   378

void ShowAircraftViewWindow(Vehicle *v);

   379

   380

void InvalidateVehicleOrderWidget(Vehicle *v);

   381

   382

bool IsShipDepotTile(TileIndex tile);

   383

uint GetFreeUnitNumber(byte type);

   384

   385

int LoadUnloadVehicle(Vehicle *v);

   386

int GetDepotByTile(uint tile);

   387

uint GetWaypointByTile(uint tile);

   388

   389

void DoDeleteDepot(uint tile);

   390

   391

void UpdateTrainAcceleration(Vehicle *v);

   392

int32 GetTrainRunningCost(Vehicle *v);

   393

   394

int CheckStoppedInDepot(Vehicle *v);

   395

   396

int ScheduleHasDepotOrders(const Order *schedule);

   397

int CheckOrders(Vehicle *v);

   398

   399

bool VehicleNeedsService(const Vehicle *v);

   400

   401

typedef struct GetNewVehiclePosResult {

   402

	int x,y;

   403

	uint old_tile;

   404

	uint new_tile;

   405

} GetNewVehiclePosResult;

   406

   407

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

   408

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

   409

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

   410

   411

#define BEGIN_ENUM_WAGONS(v) do {

   412

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

   413

   414

/* vehicle.c */

   415

enum {

   416

	NUM_NORMAL_VEHICLES = 2048,

   417

	NUM_SPECIAL_VEHICLES = 512,

   418

	NUM_VEHICLES = NUM_NORMAL_VEHICLES + NUM_SPECIAL_VEHICLES

   419

};

   420

   421

VARDEF Vehicle _vehicles[NUM_VEHICLES];

   422

VARDEF uint _vehicles_size;

   423

   424

VARDEF SortStruct *_vehicle_sort;

   425

   426

static inline Vehicle *GetVehicle(uint index)

   427

{

   428

	assert(index < _vehicles_size);

   429

	return &_vehicles[index];

   430

}

   431

   432

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

   433

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

   434

   435

VARDEF Order _order_array[5000];

   436

VARDEF Order *_ptr_to_next_order;

   437

   438

VARDEF Depot _depots[255];

   439

   440

// 128 waypoints

   441

VARDEF Waypoint _waypoints[128];

   442

   443

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

   444

VARDEF VehicleID _vehicle_position_hash[0x1000];

   445

   446

// NOSAVE: Return values from various commands.

   447

VARDEF VehicleID _new_train_id;

   448

VARDEF VehicleID _new_wagon_id;

   449

VARDEF VehicleID _new_aircraft_id;

   450

VARDEF VehicleID _new_ship_id;

   451

VARDEF VehicleID _new_roadveh_id;

   452

VARDEF uint16 _aircraft_refit_capacity;

   453

VARDEF byte _cmd_build_rail_veh_score;

   454

VARDEF byte _cmd_build_rail_veh_var1;

   455

   456

// NOSAVE: Player specific info

   457

VARDEF TileIndex _last_built_train_depot_tile;

   458

VARDEF TileIndex _last_built_road_depot_tile;

   459

VARDEF TileIndex _last_built_aircraft_depot_tile;

   460

VARDEF TileIndex _last_built_ship_depot_tile;

   461

VARDEF TileIndex _backup_orders_tile;

   462

VARDEF BackuppedOrders _backup_orders_data[1];

   463

   464

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

   465

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

   466

   467

#define INVALID_VEHICLE 0xffff

   468

   469

#define MIN_SERVINT_PERCENT  5

   470

#define MAX_SERVINT_PERCENT 90

   471

#define MIN_SERVINT_DAYS    30

   472

#define MAX_SERVINT_DAYS   800

   473

   474

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

   475

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

   476

#define STATUS_BAR 5

   477

   478

#endif /* VEHICLE_H */