1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "vehicle_gui.h"

     5

     6

typedef struct Order {

     7

#ifdef TTD_LITTLE_ENDIAN /* XXX hack to avoid savegame revision bump */

     8

	uint8 type:4;

     9

	uint8 flags:4;

    10

#else

    11

	uint8 flags:4;

    12

	uint8 type:4;

    13

#endif

    14

	uint16 station;

    15

} Order;

    16

    17

static inline uint16 PackOrder(const Order *order)

    18

{

    19

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

    20

}

    21

    22

static inline Order UnpackOrder(uint16 packed)

    23

{

    24

	Order order;

    25

	order.type    = (packed & 0x000f);

    26

	order.flags   = (packed & 0x00f0) >> 4,

    27

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

    28

	return order;

    29

}

    30

    31

Order UnpackOldOrder(uint16 packed);

    32

    33

    34

typedef struct VehicleRail {

    35

	uint16 last_speed;		// NOSAVE: only used in UI

    36

	uint16 crash_anim_pos;

    37

	uint16 days_since_order_progr;

    38

    39

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

    40

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

    41

    42

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

    43

	// 0xffff == not in train

    44

	uint16 first_engine;

    45

    46

	byte track;

    47

	byte force_proceed;

    48

	byte railtype;

    49

    50

	byte flags;

    51

} VehicleRail;

    52

    53

enum {

    54

	VRF_REVERSING = 1,

    55

    56

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

    57

	VRF_GOINGUP = 2,

    58

	VRF_GOINGDOWN = 4,

    59

};

    60

    61

typedef struct VehicleAir {

    62

	uint16 crashed_counter;

    63

	byte pos;

    64

  byte previous_pos;

    65

	uint16 targetairport;

    66

	byte state;

    67

} VehicleAir;

    68

    69

typedef struct VehicleRoad {

    70

	byte state;

    71

	byte frame;

    72

	uint16 unk2;

    73

	byte overtaking;

    74

	byte overtaking_ctr;

    75

	uint16 crashed_ctr;

    76

	byte reverse_ctr;

    77

} VehicleRoad;

    78

    79

typedef struct VehicleSpecial {

    80

	uint16 unk0;

    81

	byte unk2;

    82

} VehicleSpecial;

    83

    84

typedef struct VehicleDisaster {

    85

	uint16 image_override;

    86

	uint16 unk2;

    87

} VehicleDisaster;

    88

    89

typedef struct VehicleShip {

    90

	byte state;

    91

} VehicleShip;

    92

    93

// not used ATM

    94

struct WorldSprite {

    95

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

    96

	uint16 image;			// sprite number for this vehicle

    97

    98

	// screen coordinates

    99

	int16 left, top, right, bottom;

   100

   101

	// world coordinates

   102

	int16 x;

   103

	int16 y;

   104

	byte z;

   105

   106

	int8 x_offs;			// x offset for vehicle sprite

   107

	int8 y_offs;			// y offset for vehicle sprite

   108

   109

	byte width;				// width of vehicle sprite

   110

	byte height;			// height of vehicle sprite

   111

	byte depth;				// depth of vehicle sprite

   112

   113

	byte flags;				// draw flags

   114

};

   115

   116

struct Vehicle {

   117

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

   118

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

   119

   120

	uint16 index;			// NOSAVE: Index in vehicle array

   121

	uint16 next_in_chain_old; // Next vehicle index for chained vehicles

   122

   123

	Vehicle *next;		// next

   124

   125

	StringID string_id; // Displayed string

   126

   127

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

   128

	byte owner;				// which player owns the vehicle?

   129

   130

	TileIndex tile;		// Current tile index

   131

	TileIndex dest_tile; // Heading for this tile

   132

   133

	int16 x_pos;			// coordinates

   134

	int16 y_pos;

   135

	byte z_pos;

   136

	byte direction;		// facing

   137

   138

	byte spritenum; // currently displayed sprite index

   139

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

   140

	                // 0xff == reserved for another custom sprite

   141

	uint16 cur_image; // sprite number for this vehicle

   142

	byte sprite_width;// width of vehicle sprite

   143

	byte sprite_height;// height of vehicle sprite

   144

	byte z_height;		// z-height of vehicle sprite

   145

	int8 x_offs;			// x offset for vehicle sprite

   146

	int8 y_offs;			// y offset for vehicle sprite

   147

	uint16 engine_type;

   148

   149

	// for randomized variational spritegroups

   150

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

   151

	// of corresponding spritegroups get matched

   152

	byte random_bits;

   153

	byte waiting_triggers; // triggers to be yet matched

   154

   155

	uint16 max_speed;	// maximum speed

   156

	uint16 cur_speed;	// current speed

   157

	byte subspeed;		// fractional speed

   158

	byte acceleration; // used by train & aircraft

   159

	byte progress;

   160

   161

	byte vehstatus;		// Status

   162

	uint16 last_station_visited;

   163

   164

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

   165

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

   166

	byte cargo_source;// source of cargo

   167

	uint16 cargo_cap;	// total capacity

   168

	uint16 cargo_count;// how many pieces are used

   169

   170

	byte day_counter; // increased by one for each day

   171

	byte tick_counter;// increased by one for each tick

   172

   173

	// related to the current order

   174

	byte cur_order_index;

   175

	byte num_orders;

   176

	Order current_order;

   177

	Order *schedule_ptr;

   178

   179

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

   180

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

   181

	int32 left_coord;

   182

	int32 top_coord;

   183

	int32 right_coord;

   184

	int32 bottom_coord;

   185

	uint16 next_hash;

   186

   187

	// Related to age and service time

   188

	uint16 age;				// Age in days

   189

	uint16 max_age;		// Maximum age

   190

	uint16 date_of_last_service;

   191

	uint16 service_interval;

   192

	uint16 reliability;

   193

	uint16 reliability_spd_dec;

   194

	byte breakdown_ctr;

   195

	byte breakdown_delay;

   196

	byte breakdowns_since_last_service;

   197

	byte breakdown_chance;

   198

	byte build_year;

   199

   200

	uint16 load_unload_time_rem;

   201

   202

	int32 profit_this_year;

   203

	int32 profit_last_year;

   204

	uint32 value;

   205

   206

	union {

   207

		VehicleRail rail;

   208

		VehicleAir air;

   209

		VehicleRoad road;

   210

		VehicleSpecial special;

   211

		VehicleDisaster disaster;

   212

		VehicleShip ship;

   213

	} u;

   214

};

   215

   216

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

   217

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

   218

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

   219

   220

struct Depot {

   221

	TileIndex xy;

   222

	uint16 town_index;

   223

};

   224

   225

// train waypoint

   226

struct Waypoint {

   227

	TileIndex xy;

   228

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

   229

	ViewportSign sign;

   230

	uint16 build_date;

   231

	byte stat_id;

   232

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

   233

};

   234

   235

enum {

   236

	VEH_Train = 0x10,

   237

	VEH_Road = 0x11,

   238

	VEH_Ship = 0x12,

   239

	VEH_Aircraft = 0x13,

   240

	VEH_Special = 0x14,

   241

	VEH_Disaster = 0x15,

   242

};

   243

   244

/* Order types */

   245

enum {

   246

	OT_NOTHING = 0,

   247

	OT_GOTO_STATION = 1,

   248

	OT_GOTO_DEPOT = 2,

   249

	OT_LOADING = 3,

   250

	OT_LEAVESTATION = 4,

   251

	OT_DUMMY = 5,

   252

	OT_GOTO_WAYPOINT = 6,

   253

};

   254

   255

/* Order flags */

   256

enum {

   257

	OF_UNLOAD    = 0x2,

   258

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

   259

	OF_NON_STOP  = 0x8

   260

};

   261

   262

   263

enum VehStatus {

   264

	VS_HIDDEN = 1,

   265

	VS_STOPPED = 2,

   266

	VS_UNCLICKABLE = 4,

   267

	VS_DEFPAL = 0x8,

   268

	VS_TRAIN_SLOWING = 0x10,

   269

	VS_DISASTER = 0x20,

   270

	VS_AIRCRAFT_BROKEN = 0x40,

   271

	VS_CRASHED = 0x80,

   272

};

   273

   274

   275

   276

/* Effect vehicle types */

   277

enum {

   278

	EV_INDUSTRYSMOKE = 0,

   279

	EV_STEAM_SMOKE = 1,

   280

   281

	EV_SMOKE_1 = 2,

   282

	EV_SMOKE_2 = 3,

   283

	EV_SMOKE_3 = 4,

   284

   285

	EV_CRASHED_SMOKE = 5,

   286

	EV_BREAKDOWN_SMOKE = 6,

   287

   288

	EV_DEMOLISH = 7,

   289

	EV_ROADWORK = 8,

   290

   291

	EV_INDUSTRY_SMOKE = 9,

   292

   293

};

   294

   295

typedef void VehicleTickProc(Vehicle *v);

   296

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

   297

   298

typedef struct {

   299

	VehicleID clone;

   300

	byte orderindex;

   301

	Order order[41];

   302

	uint16 service_interval;

   303

	char name[32];

   304

} BackuppedOrders;

   305

   306

void VehicleServiceInDepot(Vehicle *v);

   307

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

   308

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

   309

Vehicle *AllocateVehicle();

   310

Vehicle *ForceAllocateVehicle();

   311

Vehicle *ForceAllocateSpecialVehicle();

   312

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

   313

void InitializeVehicles();

   314

void VehiclePositionChanged(Vehicle *v);

   315

void AfterLoadVehicles();

   316

Vehicle *GetLastVehicleInChain(Vehicle *v);

   317

Vehicle *GetPrevVehicleInChain(Vehicle *v);

   318

Vehicle *GetFirstVehicleInChain(Vehicle *v);

   319

int CountVehiclesInChain(Vehicle *v);

   320

void DeleteVehicle(Vehicle *v);

   321

void DeleteVehicleChain(Vehicle *v);

   322

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

   323

void CallVehicleTicks();

   324

void DeleteVehicleSchedule(Vehicle *v);

   325

Vehicle *IsScheduleShared(Vehicle *v);

   326

   327

Depot *AllocateDepot();

   328

Waypoint *AllocateWaypoint();

   329

void UpdateWaypointSign(Waypoint *cp);

   330

void RedrawWaypointSign(Waypoint *cp);

   331

   332

void InitializeTrains();

   333

bool IsTrainDepotTile(TileIndex tile);

   334

bool IsRoadDepotTile(TileIndex tile);

   335

   336

bool CanFillVehicle(Vehicle *v);

   337

   338

void ViewportAddVehicles(DrawPixelInfo *dpi);

   339

   340

void TrainEnterDepot(Vehicle *v, uint tile);

   341

   342

/* train_cmd.h */

   343

int GetTrainImage(Vehicle *v, byte direction);

   344

int GetAircraftImage(Vehicle *v, byte direction);

   345

int GetRoadVehImage(Vehicle *v, byte direction);

   346

int GetShipImage(Vehicle *v, byte direction);

   347

   348

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

   349

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

   350

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

   351

   352

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

   353

   354

void VehicleInTheWayErrMsg(Vehicle *v);

   355

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

   356

uint GetVehicleOutOfTunnelTile(Vehicle *v);

   357

   358

bool UpdateSignalsOnSegment(uint tile, byte direction);

   359

void SetSignalsOnBothDir(uint tile, byte track);

   360

   361

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

   362

//uint GetVehicleWeight(Vehicle *v);

   363

   364

void DecreaseVehicleValue(Vehicle *v);

   365

void CheckVehicleBreakdown(Vehicle *v);

   366

void AgeVehicle(Vehicle *v);

   367

void MaybeReplaceVehicle(Vehicle *v);

   368

   369

void DeleteCommandFromVehicleSchedule(Order cmd);

   370

   371

void BeginVehicleMove(Vehicle *v);

   372

void EndVehicleMove(Vehicle *v);

   373

   374

bool IsAircraftHangarTile(TileIndex tile);

   375

void ShowAircraftViewWindow(Vehicle *v);

   376

   377

void InvalidateVehicleOrderWidget(Vehicle *v);

   378

   379

bool IsShipDepotTile(TileIndex tile);

   380

uint GetFreeUnitNumber(byte type);

   381

   382

int LoadUnloadVehicle(Vehicle *v);

   383

int GetDepotByTile(uint tile);

   384

uint GetWaypointByTile(uint tile);

   385

   386

void DoDeleteDepot(uint tile);

   387

   388

void UpdateTrainAcceleration(Vehicle *v);

   389

int32 GetTrainRunningCost(Vehicle *v);

   390

   391

int CheckStoppedInDepot(Vehicle *v);

   392

   393

int ScheduleHasDepotOrders(const Order *schedule);

   394

int CheckOrders(Vehicle *v);

   395

   396

bool VehicleNeedsService(const Vehicle *v);

   397

   398

typedef struct GetNewVehiclePosResult {

   399

	int x,y;

   400

	uint old_tile;

   401

	uint new_tile;

   402

} GetNewVehiclePosResult;

   403

   404

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

   405

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

   406

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

   407

   408

#define BEGIN_ENUM_WAGONS(v) do {

   409

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

   410

   411

/* vehicle.c */

   412

enum {

   413

	NUM_NORMAL_VEHICLES = 2048,

   414

	NUM_SPECIAL_VEHICLES = 512,

   415

	NUM_VEHICLES = NUM_NORMAL_VEHICLES + NUM_SPECIAL_VEHICLES

   416

};

   417

   418

VARDEF Vehicle _vehicles[NUM_VEHICLES];

   431

   432

VARDEF Order _order_array[5000];

   433

VARDEF Order *_ptr_to_next_order;

   434

   435

VARDEF Depot _depots[255];

   436

   437

// 128 waypoints

   438

VARDEF Waypoint _waypoints[128];

   439

   440

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

   441

VARDEF VehicleID _vehicle_position_hash[0x1000];

   442

   443

// NOSAVE: Return values from various commands.

   444

VARDEF VehicleID _new_train_id;

   445

VARDEF VehicleID _new_wagon_id;

   446

VARDEF VehicleID _new_aircraft_id;

   447

VARDEF VehicleID _new_ship_id;

   448

VARDEF VehicleID _new_roadveh_id;

   449

VARDEF uint16 _aircraft_refit_capacity;

   450

VARDEF byte _cmd_build_rail_veh_score;

   451

VARDEF byte _cmd_build_rail_veh_var1;

   452

   453

// NOSAVE: Player specific info

   454

VARDEF TileIndex _last_built_train_depot_tile;

   455

VARDEF TileIndex _last_built_road_depot_tile;

   456

VARDEF TileIndex _last_built_aircraft_depot_tile;

   457

VARDEF TileIndex _last_built_ship_depot_tile;

   458

VARDEF TileIndex _backup_orders_tile;

   459

VARDEF BackuppedOrders _backup_orders_data[1];

   460

   461

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

   462

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

   463

   464

#define INVALID_VEHICLE 0xffff

   465

   466

#define MIN_SERVINT_PERCENT  5

   467

#define MAX_SERVINT_PERCENT 90

   468

#define MIN_SERVINT_DAYS    30

   469

#define MAX_SERVINT_DAYS   800

   470

   471

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

   472

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

   473

#define STATUS_BAR 5

   474

   475

#endif /* VEHICLE_H */