1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "vehicle_gui.h"

     5

     6

typedef struct VehicleRail {

     7

	uint16 last_speed;		// NOSAVE: only used in UI

     8

	uint16 crash_anim_pos;

     9

	uint16 days_since_order_progr;

    10

    11

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

    12

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

    13

    14

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

    15

	// 0xffff == not in train

    16

	uint16 first_engine;

    17

    18

	byte track;

    19

	byte force_proceed;

    20

	byte railtype;

    21

    22

	byte flags;

    23

} VehicleRail;

    24

    25

enum {

    26

	VRF_REVERSING = 1,

    27

    28

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

    29

	VRF_GOINGUP = 2,

    30

	VRF_GOINGDOWN = 4,

    31

};

    32

    33

typedef struct VehicleAir {

    34

	uint16 crashed_counter;

    35

	byte pos;

    36

  byte previous_pos;

    37

	byte targetairport;

    38

	byte state;

    39

} VehicleAir;

    40

    41

typedef struct VehicleRoad {

    42

	byte state;

    43

	byte frame;

    44

	uint16 unk2;

    45

	byte overtaking;

    46

	byte overtaking_ctr;

    47

	uint16 crashed_ctr;

    48

	byte reverse_ctr;

    49

} VehicleRoad;

    50

    51

typedef struct VehicleSpecial {

    52

	uint16 unk0;

    53

	byte unk2;

    54

} VehicleSpecial;

    55

    56

typedef struct VehicleDisaster {

    57

	uint16 image_override;

    58

	uint16 unk2;

    59

} VehicleDisaster;

    60

    61

typedef struct VehicleShip {

    62

	byte state;

    63

} VehicleShip;

    64

    65

// not used ATM

    66

struct WorldSprite {

    67

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

    68

	uint16 image;			// sprite number for this vehicle

    69

    70

	// screen coordinates

    71

	int16 left, top, right, bottom;

    72

    73

	// world coordinates

    74

	int16 x;

    75

	int16 y;

    76

	byte z;

    77

    78

	int8 x_offs;			// x offset for vehicle sprite

    79

	int8 y_offs;			// y offset for vehicle sprite

    80

    81

	byte width;				// width of vehicle sprite

    82

	byte height;			// height of vehicle sprite

    83

	byte depth;				// depth of vehicle sprite

    84

    85

	byte flags;				// draw flags

    86

};

    87

    88

struct Vehicle {

    89

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

    90

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

    91

    92

	uint16 index;			// NOSAVE: Index in vehicle array

    93

	uint16 next_in_chain_old; // Next vehicle index for chained vehicles

    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

   105

	int16 x_pos;			// coordinates

   106

	int16 y_pos;

   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

   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

   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

	byte 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

	// related to the current order

   146

	byte cur_order_index;

   147

	byte num_orders;

   148

	byte next_order;

   149

	byte next_order_param;

   150

	uint16 *schedule_ptr;

   151

   152

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

   153

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

   154

	int16 left_coord, top_coord, right_coord, bottom_coord;

   155

	uint16 next_hash;

   156

   157

	// Related to age and service time

   158

	uint16 age;				// Age in days

   159

	uint16 max_age;		// Maximum age

   160

	uint16 date_of_last_service;

   161

	uint16 service_interval;

   162

	uint16 reliability;

   163

	uint16 reliability_spd_dec;

   164

	byte breakdown_ctr;

   165

	byte breakdown_delay;

   166

	byte breakdowns_since_last_service;

   167

	byte breakdown_chance;

   168

	byte build_year;

   169

   170

	uint16 load_unload_time_rem;

   171

   172

	int32 profit_this_year;

   173

	int32 profit_last_year;

   174

	uint32 value;

   175

   176

	union {

   177

		VehicleRail rail;

   178

		VehicleAir air;

   179

		VehicleRoad road;

   180

		VehicleSpecial special;

   181

		VehicleDisaster disaster;

   182

		VehicleShip ship;

   183

	} u;

   184

};

   185

   186

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

   187

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

   188

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

   189

   190

struct Depot {

   191

	TileIndex xy;

   192

	uint16 town_index;

   193

};

   194

   195

// train waypoint

   196

struct Waypoint {

   197

	TileIndex xy;

   198

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

   199

	ViewportSign sign;

   200

	uint16 build_date;

   201

	byte stat_id;

   202

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

   203

};

   204

   205

enum {

   206

	VEH_Train = 0x10,

   207

	VEH_Road = 0x11,

   208

	VEH_Ship = 0x12,

   209

	VEH_Aircraft = 0x13,

   210

	VEH_Special = 0x14,

   211

	VEH_Disaster = 0x15,

   212

};

   213

   214

/* Order types */

   215

enum {

   216

	OT_NOTHING = 0,

   217

	OT_GOTO_STATION = 1,

   218

	OT_GOTO_DEPOT = 2,

   219

	OT_LOADING = 3,

   220

	OT_LEAVESTATION = 4,

   221

	OT_DUMMY = 5,

   222

	OT_GOTO_WAYPOINT = 6,

   223

   224

	OT_MASK = 0x1F,

   225

};

   226

   227

/* Order flags */

   228

enum {

   229

	OF_UNLOAD = 0x20,

   230

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

   231

	OF_NON_STOP = 0x80,

   232

	OF_MASK = 0xE0,

   233

};

   234

   235

   236

enum VehStatus {

   237

	VS_HIDDEN = 1,

   238

	VS_STOPPED = 2,

   239

	VS_UNCLICKABLE = 4,

   240

	VS_DEFPAL = 0x8,

   241

	VS_TRAIN_SLOWING = 0x10,

   242

	VS_DISASTER = 0x20,

   243

	VS_AIRCRAFT_BROKEN = 0x40,

   244

	VS_CRASHED = 0x80,

   245

};

   246

   247

   248

   249

/* Effect vehicle types */

   250

enum {

   251

	EV_INDUSTRYSMOKE = 0,

   252

	EV_STEAM_SMOKE = 1,

   253

   254

	EV_SMOKE_1 = 2,

   255

	EV_SMOKE_2 = 3,

   256

	EV_SMOKE_3 = 4,

   257

   258

	EV_CRASHED_SMOKE = 5,

   259

	EV_BREAKDOWN_SMOKE = 6,

   260

   261

	EV_DEMOLISH = 7,

   262

	EV_ROADWORK = 8,

   263

   264

	EV_INDUSTRY_SMOKE = 9,

   265

   266

};

   267

   268

typedef void VehicleTickProc(Vehicle *v);

   269

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

   270

   271

typedef struct {

   272

	byte orderindex;

   273

	uint16 order[41];

   274

	uint16 service_interval;

   275

	char name[32];

   276

} BackuppedOrders;

   277

   278

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

   279

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

   280

Vehicle *AllocateVehicle();

   281

Vehicle *ForceAllocateVehicle();

   282

Vehicle *ForceAllocateSpecialVehicle();

   283

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

   284

void InitializeVehicles();

   285

void VehiclePositionChanged(Vehicle *v);

   286

void AfterLoadVehicles();

   287

Vehicle *GetLastVehicleInChain(Vehicle *v);

   288

Vehicle *GetPrevVehicleInChain(Vehicle *v);

   289

Vehicle *GetFirstVehicleInChain(Vehicle *v);

   290

int CountVehiclesInChain(Vehicle *v);

   291

void DeleteVehicle(Vehicle *v);

   292

void DeleteVehicleChain(Vehicle *v);

   293

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

   294

void CallVehicleTicks();

   295

void DeleteVehicleSchedule(Vehicle *v);

   296

Vehicle *IsScheduleShared(Vehicle *v);

   297

   298

Depot *AllocateDepot();

   299

Waypoint *AllocateWaypoint();

   300

void UpdateWaypointSign(Waypoint *cp);

   301

void RedrawWaypointSign(Waypoint *cp);

   302

   303

void InitializeTrains();

   304

bool IsTrainDepotTile(TileIndex tile);

   305

bool IsRoadDepotTile(TileIndex tile);

   306

   307

bool CanFillVehicle(Vehicle *v);

   308

   309

void ViewportAddVehicles(DrawPixelInfo *dpi);

   310

   311

void TrainEnterDepot(Vehicle *v, uint tile);

   312

   313

/* train_cmd.h */

   314

int GetTrainImage(Vehicle *v, byte direction);

   315

int GetAircraftImage(Vehicle *v, byte direction);

   316

int GetRoadVehImage(Vehicle *v, byte direction);

   317

int GetShipImage(Vehicle *v, byte direction);

   318

   319

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

   320

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

   321

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

   322

   323

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

   324

   325

void VehicleInTheWayErrMsg(Vehicle *v);

   326

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

   327

uint GetVehicleOutOfTunnelTile(Vehicle *v);

   328

   329

bool UpdateSignalsOnSegment(uint tile, byte direction);

   330

void SetSignalsOnBothDir(uint tile, byte track);

   331

   332

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

   333

//uint GetVehicleWeight(Vehicle *v);

   334

   335

void DecreaseVehicleValue(Vehicle *v);

   336

void CheckVehicleBreakdown(Vehicle *v);

   337

void AgeVehicle(Vehicle *v);

   338

void MaybeRenewVehicle(Vehicle *v, int32 build_cost);

   339

   340

void DeleteCommandFromVehicleSchedule(uint cmd);

   341

   342

void BeginVehicleMove(Vehicle *v);

   343

void EndVehicleMove(Vehicle *v);

   344

   345

bool IsAircraftHangarTile(TileIndex tile);

   346

void ShowAircraftViewWindow(Vehicle *v);

   347

   348

void InvalidateVehicleOrderWidget(Vehicle *v);

   349

   350

bool IsShipDepotTile(TileIndex tile);

   351

uint GetFreeUnitNumber(byte type);

   352

   353

int LoadUnloadVehicle(Vehicle *v);

   354

int GetDepotByTile(uint tile);

   355

uint GetWaypointByTile(uint tile);

   356

   357

void DoDeleteDepot(uint tile);

   358

   359

void UpdateTrainAcceleration(Vehicle *v);

   360

int32 GetTrainRunningCost(Vehicle *v);

   361

   362

int CheckStoppedInDepot(Vehicle *v);

   363

   364

int ScheduleHasDepotOrders(uint16 *schedule);

   365

int CheckOrders(Vehicle *v);

   366

   367

typedef struct GetNewVehiclePosResult {

   368

	int x,y;

   369

	uint old_tile;

   370

	uint new_tile;

   371

} GetNewVehiclePosResult;

   372

   373

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

   374

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

   375

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

   376

   377

#define BEGIN_ENUM_WAGONS(v) do {

   378

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

   379

   380

#define DEREF_VEHICLE(i) (&_vehicles[i])

   381

#define FOR_ALL_VEHICLES(v) for(v=_vehicles; v != endof(_vehicles); v++)

   382

   383

/* vehicle.c */

   384

enum {

   385

	NUM_NORMAL_VEHICLES = 2048,

   386

	NUM_SPECIAL_VEHICLES = 512,

   387

	NUM_VEHICLES = NUM_NORMAL_VEHICLES + NUM_SPECIAL_VEHICLES

   388

};

   389

   390

VARDEF Vehicle _vehicles[NUM_VEHICLES];

   391

   392

VARDEF uint16 _order_array[5000];

   393

VARDEF uint16 *_ptr_to_next_order;

   394

   395

VARDEF Depot _depots[255];

   396

   397

// 128 waypoints

   398

VARDEF Waypoint _waypoints[128];

   399

   400

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

   401

VARDEF VehicleID _vehicle_position_hash[0x1000];

   402

   403

// NOSAVE: Return values from various commands.

   404

VARDEF VehicleID _new_train_id;

   405

VARDEF VehicleID _new_wagon_id;

   406

VARDEF VehicleID _new_aircraft_id;

   407

VARDEF VehicleID _new_ship_id;

   408

VARDEF VehicleID _new_roadveh_id;

   409

VARDEF uint16 _aircraft_refit_capacity;

   410

VARDEF byte _cmd_build_rail_veh_score;

   411

VARDEF byte _cmd_build_rail_veh_var1;

   412

   413

// NOSAVE: Player specific info

   414

VARDEF TileIndex _last_built_train_depot_tile;

   415

VARDEF TileIndex _last_built_road_depot_tile;

   416

VARDEF TileIndex _last_built_aircraft_depot_tile;

   417

VARDEF TileIndex _last_built_ship_depot_tile;

   418

VARDEF TileIndex _backup_orders_tile;

   419

VARDEF BackuppedOrders _backup_orders_data[1];

   420

   421

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

   422

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

   423

   424

#define INVALID_VEHICLE 0xffff

   425

   426

#define SERVICE_INTERVAL (_patches.servint_ispercent ? (v->reliability > _engines[v->engine_type].reliability * (100 - v->service_interval) / 100) : (v->date_of_last_service + v->service_interval > _date))

   427

#define MIN_SERVINT_PERCENT  5

   428

#define MAX_SERVINT_PERCENT 90

   429

#define MIN_SERVINT_DAYS    30

   430

#define MAX_SERVINT_DAYS   800

   431

   432

#endif /* VEHICLE_H */