1

/* $Id$ */

     2

     3

/** @file vehicle.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "road_map.h"

     8

#include "roadveh.h"

     9

#include "ship.h"

    10

#include "spritecache.h"

    11

#include "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "tile_cmd.h"

    14

#include "landscape.h"

    15

#include "timetable.h"

    16

#include "viewport.h"

    17

#include "news.h"

    18

#include "command_func.h"

    19

#include "saveload.h"

    20

#include "player.h"

    21

#include "engine.h"

    22

#include "debug.h"

    23

#include "vehicle_gui.h"

    24

#include "depot.h"

    25

#include "station.h"

    26

#include "rail_type.h"

    27

#include "train.h"

    28

#include "aircraft.h"

    29

#include "industry_map.h"

    30

#include "station_map.h"

    31

#include "water_map.h"

    32

#include "network/network.h"

    33

#include "yapf/yapf.h"

    34

#include "newgrf_callbacks.h"

    35

#include "newgrf_engine.h"

    36

#include "newgrf_sound.h"

    37

#include "group.h"

    38

#include "order.h"

    39

#include "strings_func.h"

    40

#include "zoom_func.h"

    41

#include "functions.h"

    42

#include "date_func.h"

    43

#include "window_func.h"

    44

#include "vehicle_func.h"

    45

#include "sound_func.h"

    46

#include "variables.h"

    47

#include "autoreplace_func.h"

    48

#include "autoreplace_gui.h"

    50

    51

#define INVALID_COORD (0x7fffffff)

    52

#define GEN_HASH(x, y) ((GB((y), 6, 6) << 6) + GB((x), 7, 6))

    53

    54

VehicleID _vehicle_id_ctr_day;

    55

Vehicle *_place_clicked_vehicle;

    56

VehicleID _new_vehicle_id;

    57

uint16 _returned_refit_capacity;

    58

    59

    60

/* Tables used in vehicle.h to find the right command for a certain vehicle type */

    61

const uint32 _veh_build_proc_table[] = {

    62

	CMD_BUILD_RAIL_VEHICLE,

    63

	CMD_BUILD_ROAD_VEH,

    64

	CMD_BUILD_SHIP,

    65

	CMD_BUILD_AIRCRAFT,

    66

};

    67

const uint32 _veh_sell_proc_table[] = {

    68

	CMD_SELL_RAIL_WAGON,

    69

	CMD_SELL_ROAD_VEH,

    70

	CMD_SELL_SHIP,

    71

	CMD_SELL_AIRCRAFT,

    72

};

    73

    74

const uint32 _veh_refit_proc_table[] = {

    75

	CMD_REFIT_RAIL_VEHICLE,

    76

	CMD_REFIT_ROAD_VEH,

    77

	CMD_REFIT_SHIP,

    78

	CMD_REFIT_AIRCRAFT,

    79

};

    80

    81

const uint32 _send_to_depot_proc_table[] = {

    82

	CMD_SEND_TRAIN_TO_DEPOT,

    83

	CMD_SEND_ROADVEH_TO_DEPOT,

    84

	CMD_SEND_SHIP_TO_DEPOT,

    85

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    86

};

    87

    88

    89

/* Initialize the vehicle-pool */

    90

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    91

    92

void VehicleServiceInDepot(Vehicle *v)

    93

{

    94

	v->date_of_last_service = _date;

    95

	v->breakdowns_since_last_service = 0;

    96

	v->reliability = GetEngine(v->engine_type)->reliability;

    97

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index); // ensure that last service date and reliability are updated

    98

}

    99

   100

bool VehicleNeedsService(const Vehicle *v)

   101

{

   102

	if (v->vehstatus & (VS_STOPPED | VS_CRASHED))       return false;

   103

	if (v->current_order.type != OT_GOTO_DEPOT || !(v->current_order.flags & OF_PART_OF_ORDERS)) { // Don't interfere with a depot visit by the order list

   104

		if (_patches.gotodepot && VehicleHasDepotOrders(v)) return false;

   105

		if (v->current_order.type == OT_LOADING)            return false;

   106

		if (v->current_order.type == OT_GOTO_DEPOT && v->current_order.flags & OF_HALT_IN_DEPOT) return false;

   107

	}

   108

   109

	if (_patches.no_servicing_if_no_breakdowns && _opt.diff.vehicle_breakdowns == 0) {

   110

		return EngineHasReplacementForPlayer(GetPlayer(v->owner), v->engine_type, v->group_id);  /* Vehicles set for autoreplacing needs to go to a depot even if breakdowns are turned off */

   111

	}

   112

   113

	return _patches.servint_ispercent ?

   114

		(v->reliability < GetEngine(v->engine_type)->reliability * (100 - v->service_interval) / 100) :

   115

		(v->date_of_last_service + v->service_interval < _date);

   116

}

   117

   118

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   119

{

   120

	switch (v->type) {

   121

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   122

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   123

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   124

		default:           return STR_980E_SHIP_IN_THE_WAY;

   125

	}

   126

}

   127

   128

static void *EnsureNoVehicleProcZ(Vehicle *v, void *data)

   129

{

   130

	byte z = *(byte*)data;

   131

   132

	if (v->type == VEH_DISASTER || (v->type == VEH_AIRCRAFT && v->subtype == AIR_SHADOW)) return NULL;

   133

	if (v->z_pos > z) return NULL;

   134

   135

	_error_message = VehicleInTheWayErrMsg(v);

   136

	return v;

   137

}

   138

   139

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   140

{

   141

	return (Vehicle*)VehicleFromPos(tile, &z, &EnsureNoVehicleProcZ);

   142

}

   143

   144

bool EnsureNoVehicleOnGround(TileIndex tile)

   145

{

   146

	return FindVehicleOnTileZ(tile, GetTileMaxZ(tile)) == NULL;

   147

}

   148

   149

Vehicle *FindVehicleBetween(TileIndex from, TileIndex to, byte z, bool without_crashed)

   150

{

   151

	int x1 = TileX(from);

   152

	int y1 = TileY(from);

   153

	int x2 = TileX(to);

   154

	int y2 = TileY(to);

   155

	Vehicle *veh;

   156

   157

	/* Make sure x1 < x2 or y1 < y2 */

   158

	if (x1 > x2 || y1 > y2) {

   159

		Swap(x1, x2);

   160

		Swap(y1, y2);

   161

	}

   162

	FOR_ALL_VEHICLES(veh) {

   163

		if (without_crashed && (veh->vehstatus & VS_CRASHED) != 0) continue;

   164

		if ((veh->type == VEH_TRAIN || veh->type == VEH_ROAD) && (z == 0xFF || veh->z_pos == z)) {

   165

			if ((veh->x_pos >> 4) >= x1 && (veh->x_pos >> 4) <= x2 &&

   166

					(veh->y_pos >> 4) >= y1 && (veh->y_pos >> 4) <= y2) {

   167

				return veh;

   168

			}

   169

		}

   170

	}

   171

	return NULL;

   172

}

   173

   174

   175

/** Procedure called for every vehicle found in tunnel/bridge in the hash map */

   176

static void *GetVehicleTunnelBridgeProc(Vehicle *v, void *data)

   177

{

   178

	if (v->type != VEH_TRAIN && v->type != VEH_ROAD) return NULL;

   179

   180

	_error_message = VehicleInTheWayErrMsg(v);

   181

	return v;

   182

}

   183

   184

/**

   185

 * Finds vehicle in tunnel / bridge

   186

 * @param tile first end

   187

 * @param endtile second end

   188

 * @return pointer to vehicle found

   189

 */

   190

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   191

{

   192

	Vehicle *v = (Vehicle*)VehicleFromPos(tile, NULL, &GetVehicleTunnelBridgeProc);

   193

	if (v != NULL) return v;

   194

   195

	return (Vehicle*)VehicleFromPos(endtile, NULL, &GetVehicleTunnelBridgeProc);

   196

}

   197

   198

   199

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

   200

   201

void VehiclePositionChanged(Vehicle *v)

   202

{

   203

	int img = v->cur_image;

   204

	Point pt = RemapCoords(v->x_pos + v->x_offs, v->y_pos + v->y_offs, v->z_pos);

   205

	const Sprite* spr = GetSprite(img);

   206

   207

	pt.x += spr->x_offs;

   208

	pt.y += spr->y_offs;

   209

   210

	UpdateVehiclePosHash(v, pt.x, pt.y);

   211

   212

	v->left_coord = pt.x;

   213

	v->top_coord = pt.y;

   214

	v->right_coord = pt.x + spr->width + 2;

   215

	v->bottom_coord = pt.y + spr->height + 2;

   216

}

   217

   218

/** Called after load to update coordinates */

   219

void AfterLoadVehicles(bool clear_te_id)

   220

{

   221

	Vehicle *v;

   222

   223

	FOR_ALL_VEHICLES(v) {

   224

		/* Reinstate the previous pointer */

   225

		if (v->Next() != NULL) v->Next()->previous = v;

   226

   227

		v->UpdateDeltaXY(v->direction);

   228

   229

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   230

		v->first = NULL;

   231

		if (v->type == VEH_TRAIN) v->u.rail.first_engine = INVALID_ENGINE;

   232

		if (v->type == VEH_ROAD)  v->u.road.first_engine = INVALID_ENGINE;

   233

   234

		v->cargo.InvalidateCache();

   235

	}

   236

   237

	FOR_ALL_VEHICLES(v) {

   238

		/* Fill the first pointers */

   239

		if (v->Previous() == NULL) {

   240

			for (Vehicle *u = v; u != NULL; u = u->Next()) {

   241

				u->first = v;

   242

			}

   243

		}

   244

	}

   245

   246

	FOR_ALL_VEHICLES(v) {

   247

		assert(v->first != NULL);

   248

   249

		if (v->type == VEH_TRAIN && (IsFrontEngine(v) || IsFreeWagon(v))) {

   250

			TrainConsistChanged(v);

   251

		} else if (v->type == VEH_ROAD && IsRoadVehFront(v)) {

   252

			RoadVehUpdateCache(v);

   253

		}

   254

	}

   255

   256

	FOR_ALL_VEHICLES(v) {

   257

		switch (v->type) {

   258

			case VEH_ROAD:

   259

				v->u.road.roadtype = HasBit(EngInfo(v->engine_type)->misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD;

   260

				v->u.road.compatible_roadtypes = RoadTypeToRoadTypes(v->u.road.roadtype);

   261

				/* FALL THROUGH */

   262

			case VEH_TRAIN:

   263

			case VEH_SHIP:

   264

				v->cur_image = v->GetImage(v->direction);

   265

				break;

   266

   267

			case VEH_AIRCRAFT:

   268

				if (IsNormalAircraft(v)) {

   269

					v->cur_image = v->GetImage(v->direction);

   270

   271

					/* The plane's shadow will have the same image as the plane */

   272

					Vehicle *shadow = v->Next();

   273

					shadow->cur_image = v->cur_image;

   274

   275

					/* In the case of a helicopter we will update the rotor sprites */

   276

					if (v->subtype == AIR_HELICOPTER) {

   277

						Vehicle *rotor = shadow->Next();

   278

						rotor->cur_image = GetRotorImage(v);

   279

					}

   280

   281

					UpdateAircraftCache(v);

   282

				}

   283

				break;

   284

			default: break;

   285

		}

   286

   287

		v->left_coord = INVALID_COORD;

   288

		VehiclePositionChanged(v);

   289

	}

   290

}

   291

   292

Vehicle::Vehicle()

   293

{

   294

	this->type               = VEH_INVALID;

   295

	this->left_coord         = INVALID_COORD;

   296

	this->group_id           = DEFAULT_GROUP;

   297

	this->fill_percent_te_id = INVALID_TE_ID;

   298

	this->first              = this;

   299

	this->colormap           = PAL_NONE;

   300

}

   301

   302

/**

   303

 * Get a value for a vehicle's random_bits.

   304

 * @return A random value from 0 to 255.

   305

 */

   306

byte VehicleRandomBits()

   307

{

   308

	return GB(Random(), 0, 8);

   309

}

   310

   311

   312

/* static */ bool Vehicle::AllocateList(Vehicle **vl, int num)

   313

{

   314

	uint counter = _Vehicle_pool.first_free_index;

   315

   316

	for (int i = 0; i != num; i++) {

   317

		Vehicle *v = AllocateRaw(counter);

   318

   319

		if (v == NULL) return false;

   320

		v = new (v) InvalidVehicle();

   321

   322

		if (vl != NULL) {

   323

			vl[i] = v;

   324

		}

   325

		counter++;

   326

	}

   327

   328

	return true;

   329

}

   330

   331

/* Size of the hash, 6 = 64 x 64, 7 = 128 x 128. Larger sizes will (in theory) reduce hash

   332

 * lookup times at the expense of memory usage. */

   333

const int HASH_BITS = 7;

   334

const int HASH_SIZE = 1 << HASH_BITS;

   335

const int HASH_MASK = HASH_SIZE - 1;

   336

const int TOTAL_HASH_SIZE = 1 << (HASH_BITS * 2);

   337

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   338

   339

/* Resolution of the hash, 0 = 1*1 tile, 1 = 2*2 tiles, 2 = 4*4 tiles, etc.

   340

 * Profiling results show that 0 is fastest. */

   341

const int HASH_RES = 0;

   342

   343

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   344

   345

static void *VehicleFromHash(int xl, int yl, int xu, int yu, void *data, VehicleFromPosProc *proc)

   346

{

   347

	for (int y = yl; ; y = (y + (1 << HASH_BITS)) & (HASH_MASK << HASH_BITS)) {

   348

		for (int x = xl; ; x = (x + 1) & HASH_MASK) {

   349

			Vehicle *v = _new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   350

			for (; v != NULL; v = v->next_new_hash) {

   351

				void *a = proc(v, data);

   352

				if (a != NULL) return a;

   353

			}

   354

			if (x == xu) break;

   355

		}

   356

		if (y == yu) break;

   357

	}

   358

   359

	return NULL;

   360

}

   361

   362

   363

void *VehicleFromPosXY(int x, int y, void *data, VehicleFromPosProc *proc)

   364

{

   365

	const int COLL_DIST = 6;

   366

   367

	/* Hash area to scan is from xl,yl to xu,yu */

   368

	int xl = GB((x - COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS);

   369

	int xu = GB((x + COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS);

   370

	int yl = GB((y - COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS) << HASH_BITS;

   371

	int yu = GB((y + COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS) << HASH_BITS;

   372

   373

	return VehicleFromHash(xl, yl, xu, yu, data, proc);

   374

}

   375

   376

   377

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

   378

{

   379

	int x = GB(TileX(tile), HASH_RES, HASH_BITS);

   380

	int y = GB(TileY(tile), HASH_RES, HASH_BITS) << HASH_BITS;

   381

   382

	Vehicle *v = _new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   383

	for (; v != NULL; v = v->next_new_hash) {

   384

		if (v->tile != tile) continue;

   385

   386

		void *a = proc(v, data);

   387

		if (a != NULL) return a;

   388

	}

   389

   390

	return NULL;

   391

}

   392

   393

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   394

{

   395

	Vehicle **old_hash = v->old_new_hash;

   396

	Vehicle **new_hash;

   397

   398

	if (remove) {

   399

		new_hash = NULL;

   400

	} else {

   401

		int x = GB(TileX(v->tile), HASH_RES, HASH_BITS);

   402

		int y = GB(TileY(v->tile), HASH_RES, HASH_BITS) << HASH_BITS;

   403

		new_hash = &_new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   404

	}

   405

   406

	if (old_hash == new_hash) return;

   407

   408

	/* Remove from the old position in the hash table */

   409

	if (old_hash != NULL) {

   410

		Vehicle *last = NULL;

   411

		Vehicle *u = *old_hash;

   412

		while (u != v) {

   413

			last = u;

   414

			u = u->next_new_hash;

   415

			assert(u != NULL);

   416

		}

   417

   418

		if (last == NULL) {

   419

			*old_hash = v->next_new_hash;

   420

		} else {

   421

			last->next_new_hash = v->next_new_hash;

   422

		}

   423

	}

   424

   425

	/* Insert vehicle at beginning of the new position in the hash table */

   426

	if (new_hash != NULL) {

   427

		v->next_new_hash = *new_hash;

   428

		*new_hash = v;

   429

		assert(v != v->next_new_hash);

   430

	}

   431

   432

	/* Remember current hash position */

   433

	v->old_new_hash = new_hash;

   434

}

   435

   436

static Vehicle *_vehicle_position_hash[0x1000];

   437

   438

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

   439

{

   440

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   441

   442

	Vehicle **old_hash, **new_hash;

   443

	int old_x = v->left_coord;

   444

	int old_y = v->top_coord;

   445

   446

	new_hash = (x == INVALID_COORD) ? NULL : &_vehicle_position_hash[GEN_HASH(x, y)];

   447

	old_hash = (old_x == INVALID_COORD) ? NULL : &_vehicle_position_hash[GEN_HASH(old_x, old_y)];

   448

   449

	if (old_hash == new_hash) return;

   450

   451

	/* remove from hash table? */

   452

	if (old_hash != NULL) {

   453

		Vehicle *last = NULL;

   454

		Vehicle *u = *old_hash;

   455

		while (u != v) {

   456

			last = u;

   457

			u = u->next_hash;

   458

			assert(u != NULL);

   459

		}

   460

   461

		if (last == NULL) {

   462

			*old_hash = v->next_hash;

   463

		} else {

   464

			last->next_hash = v->next_hash;

   465

		}

   466

	}

   467

   468

	/* insert into hash table? */

   469

	if (new_hash != NULL) {

   470

		v->next_hash = *new_hash;

   471

		*new_hash = v;

   472

	}

   473

}

   474

   475

void ResetVehiclePosHash()

   476

{

   477

	Vehicle *v;

   478

	FOR_ALL_VEHICLES(v) { v->old_new_hash = NULL; }

   479

	memset(_vehicle_position_hash, 0, sizeof(_vehicle_position_hash));

   480

	memset(_new_vehicle_position_hash, 0, sizeof(_new_vehicle_position_hash));

   481

}

   482

   483

void ResetVehicleColorMap()

   484

{

   485

	Vehicle *v;

   486

	FOR_ALL_VEHICLES(v) { v->colormap = PAL_NONE; }

   487

}

   488