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_func.h"

    17

#include "gfx_func.h"

    18

#include "news.h"

    19

#include "command_func.h"

    20

#include "saveload.h"

    22

#include "engine.h"

    23

#include "debug.h"

    24

#include "vehicle_gui.h"

    25

#include "depot.h"

    26

#include "station.h"

    27

#include "rail_type.h"

    28

#include "train.h"

    29

#include "aircraft.h"

    30

#include "industry_map.h"

    31

#include "station_map.h"

    32

#include "water_map.h"

    33

#include "network/network.h"

    34

#include "yapf/yapf.h"

    35

#include "newgrf_callbacks.h"

    36

#include "newgrf_engine.h"

    37

#include "newgrf_sound.h"

    38

#include "group.h"

    39

#include "order.h"

    40

#include "strings_func.h"

    41

#include "zoom_func.h"

    42

#include "functions.h"

    43

#include "date_func.h"

    44

#include "window_func.h"

    45

#include "vehicle_func.h"

    46

#include "signal_func.h"

    47

#include "sound_func.h"

    48

#include "variables.h"

    49

#include "autoreplace_func.h"

    50

#include "autoreplace_gui.h"

    51

#include "string_func.h"

    52

    53

#define INVALID_COORD (0x7fffffff)

    54

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

    55

    56

VehicleID _vehicle_id_ctr_day;

    57

Vehicle *_place_clicked_vehicle;

    58

VehicleID _new_vehicle_id;

    59

uint16 _returned_refit_capacity;

    60

    61

    62

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

    63

const uint32 _veh_build_proc_table[] = {

    64

	CMD_BUILD_RAIL_VEHICLE,

    65

	CMD_BUILD_ROAD_VEH,

    66

	CMD_BUILD_SHIP,

    67

	CMD_BUILD_AIRCRAFT,

    68

};

    69

const uint32 _veh_sell_proc_table[] = {

    70

	CMD_SELL_RAIL_WAGON,

    71

	CMD_SELL_ROAD_VEH,

    72

	CMD_SELL_SHIP,

    73

	CMD_SELL_AIRCRAFT,

    74

};

    75

    76

const uint32 _veh_refit_proc_table[] = {

    77

	CMD_REFIT_RAIL_VEHICLE,

    78

	CMD_REFIT_ROAD_VEH,

    79

	CMD_REFIT_SHIP,

    80

	CMD_REFIT_AIRCRAFT,

    81

};

    82

    83

const uint32 _send_to_depot_proc_table[] = {

    84

	CMD_SEND_TRAIN_TO_DEPOT,

    85

	CMD_SEND_ROADVEH_TO_DEPOT,

    86

	CMD_SEND_SHIP_TO_DEPOT,

    87

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    88

};

    89

    90

    91

/* Initialize the vehicle-pool */

    92

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    93

    94

void VehicleServiceInDepot(Vehicle *v)

    95

{

    96

	v->date_of_last_service = _date;

    97

	v->breakdowns_since_last_service = 0;

    98

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

    99

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

   100

}

   101

   102

bool VehicleNeedsService(const Vehicle *v)

   103

{

   104

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

   105

	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

   106

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

   107

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

   108

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

   109

	}

   110

   111

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

   112

		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 */

   113

	}

   114

   115

	return _patches.servint_ispercent ?

   116

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

   117

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

   118

}

   119

   120

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   121

{

   122

	switch (v->type) {

   123

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   124

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   125

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   126

		default:           return STR_980E_SHIP_IN_THE_WAY;

   127

	}

   128

}

   129

   130

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

   131

{

   132

	byte z = *(byte*)data;

   133

   134

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

   135

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

   136

   137

	_error_message = VehicleInTheWayErrMsg(v);

   138

	return v;

   139

}

   140

   141

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   142

{

   143

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

   144

}

   145

   146

bool EnsureNoVehicleOnGround(TileIndex tile)

   147

{

   148

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

   149

}

   150

   151

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

   152

{

   153

	int x1 = TileX(from);

   154

	int y1 = TileY(from);

   155

	int x2 = TileX(to);

   156

	int y2 = TileY(to);

   157

	Vehicle *veh;

   158

   159

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

   160

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

   161

		Swap(x1, x2);

   162

		Swap(y1, y2);

   163

	}

   164

	FOR_ALL_VEHICLES(veh) {

   165

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

   166

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

   167

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

   168

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

   169

				return veh;

   170

			}

   171

		}

   172

	}

   173

	return NULL;

   174

}

   175

   176

   177

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

   178

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

   179

{

   180

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

   181

   182

	_error_message = VehicleInTheWayErrMsg(v);

   183

	return v;

   184

}

   185

   186

/**

   187

 * Finds vehicle in tunnel / bridge

   188

 * @param tile first end

   189

 * @param endtile second end

   190

 * @return pointer to vehicle found

   191

 */

   192

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   193

{

   194

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

   195

	if (v != NULL) return v;

   196

   197

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

   198

}

   199

   200

   201

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

   202

   203

void VehiclePositionChanged(Vehicle *v)

   204

{

   205

	int img = v->cur_image;

   206

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

   207

	const Sprite* spr = GetSprite(img);

   208

   209

	pt.x += spr->x_offs;

   210

	pt.y += spr->y_offs;

   211

   212

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

   213

   214

	v->left_coord = pt.x;

   215

	v->top_coord = pt.y;

   216

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

   217

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

   218

}

   219

   220

/** Called after load to update coordinates */

   221

void AfterLoadVehicles(bool clear_te_id)

   222

{

   223

	Vehicle *v;

   224

   225

	FOR_ALL_VEHICLES(v) {

   226

		/* Reinstate the previous pointer */

   227

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

   228

   229

		v->UpdateDeltaXY(v->direction);

   230

   231

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   232

		v->first = NULL;

   233

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

   234

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

   235

   236

		v->cargo.InvalidateCache();

   237

	}

   238

   239

	FOR_ALL_VEHICLES(v) {

   240

		/* Fill the first pointers */

   241

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

   242

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

   243

				u->first = v;

   244

			}

   245

		}

   246

	}

   247

   248

	FOR_ALL_VEHICLES(v) {

   249

		assert(v->first != NULL);

   250

   251

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

   252

			TrainConsistChanged(v);

   253

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

   254

			RoadVehUpdateCache(v);

   255

		}

   256

	}

   257

   258

	FOR_ALL_VEHICLES(v) {

   259

		switch (v->type) {

   260

			case VEH_ROAD:

   261

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

   262

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

   263

				/* FALL THROUGH */

   264

			case VEH_TRAIN:

   265

			case VEH_SHIP:

   266

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

   267

				break;

   268

   269

			case VEH_AIRCRAFT:

   270

				if (IsNormalAircraft(v)) {

   271

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

   272

   273

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

   274

					Vehicle *shadow = v->Next();

   275

					shadow->cur_image = v->cur_image;

   276

   277

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

   278

					if (v->subtype == AIR_HELICOPTER) {

   279

						Vehicle *rotor = shadow->Next();

   280

						rotor->cur_image = GetRotorImage(v);

   281

					}

   282

   283

					UpdateAircraftCache(v);

   284

				}

   285

				break;

   286

			default: break;

   287

		}

   288

   289

		v->left_coord = INVALID_COORD;

   290

		VehiclePositionChanged(v);

   291

	}

   292

}

   293

   294

Vehicle::Vehicle()

   295

{

   296

	this->type               = VEH_INVALID;

   297

	this->left_coord         = INVALID_COORD;

   298

	this->group_id           = DEFAULT_GROUP;

   299

	this->fill_percent_te_id = INVALID_TE_ID;

   300

	this->first              = this;

   301

	this->colormap           = PAL_NONE;

   302

}

   303

   304

/**

   305

 * Get a value for a vehicle's random_bits.

   306

 * @return A random value from 0 to 255.

   307

 */

   308

byte VehicleRandomBits()

   309

{

   310

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

   311

}

   312

   313

   314

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

   315

{

   316

	uint counter = _Vehicle_pool.first_free_index;

   317

   318

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

   319

		Vehicle *v = AllocateRaw(counter);

   320

   321

		if (v == NULL) return false;

   322

		v = new (v) InvalidVehicle();

   323

   324

		if (vl != NULL) {

   325

			vl[i] = v;

   326

		}

   327

		counter++;

   328

	}

   329

   330

	return true;

   331

}

   332

   333

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

   334

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

   335

const int HASH_BITS = 7;

   336

const int HASH_SIZE = 1 << HASH_BITS;

   337

const int HASH_MASK = HASH_SIZE - 1;

   338

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

   339

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   340

   341

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

   342

 * Profiling results show that 0 is fastest. */

   343

const int HASH_RES = 0;

   344

   345

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   346

   347

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

   348

{

   349

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

   350

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

   351

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

   352

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

   353

				void *a = proc(v, data);

   354

				if (a != NULL) return a;

   355

			}

   356

			if (x == xu) break;

   357

		}

   358

		if (y == yu) break;

   359

	}

   360

   361

	return NULL;

   362

}

   363

   364

   365

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

   366

{

   367

	const int COLL_DIST = 6;

   368

   369

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

   370

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

   371

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

   372

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

   373

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

   374

   375

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

   376

}

   377

   378

   379

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

   380

{

   381

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

   382

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

   383

   384

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

   385

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

   386

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

   387

   388

		void *a = proc(v, data);

   389

		if (a != NULL) return a;

   390

	}

   391

   392

	return NULL;

   393

}

   394

   395

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   396

{

   397

	Vehicle **old_hash = v->old_new_hash;

   398

	Vehicle **new_hash;

   399

   400

	if (remove) {

   401

		new_hash = NULL;

   402

	} else {

   403

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

   404

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

   405

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

   406

	}

   407

   408

	if (old_hash == new_hash) return;

   409

   410

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

   411

	if (old_hash != NULL) {

   412

		Vehicle *last = NULL;

   413

		Vehicle *u = *old_hash;

   414

		while (u != v) {

   415

			last = u;

   416

			u = u->next_new_hash;

   417

			assert(u != NULL);

   418

		}

   419

   420

		if (last == NULL) {

   421

			*old_hash = v->next_new_hash;

   422

		} else {

   423

			last->next_new_hash = v->next_new_hash;

   424

		}

   425

	}

   426

   427

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

   428

	if (new_hash != NULL) {

   429

		v->next_new_hash = *new_hash;

   430

		*new_hash = v;

   431

		assert(v != v->next_new_hash);

   432

	}

   433

   434

	/* Remember current hash position */

   435

	v->old_new_hash = new_hash;

   436

}

   437

   438

static Vehicle *_vehicle_position_hash[0x1000];

   439

   440

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

   441

{

   442

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   443

   444

	Vehicle **old_hash, **new_hash;

   445

	int old_x = v->left_coord;

   446

	int old_y = v->top_coord;

   447

   448

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

   449

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

   450

   451

	if (old_hash == new_hash) return;

   452

   453

	/* remove from hash table? */

   454

	if (old_hash != NULL) {

   455

		Vehicle *last = NULL;

   456

		Vehicle *u = *old_hash;

   457

		while (u != v) {

   458

			last = u;

   459

			u = u->next_hash;

   460

			assert(u != NULL);

   461

		}

   462

   463

		if (last == NULL) {

   464

			*old_hash = v->next_hash;

   465

		} else {

   466

			last->next_hash = v->next_hash;

   467

		}

   468

	}

   469

   470

	/* insert into hash table? */

   471

	if (new_hash != NULL) {

   472

		v->next_hash = *new_hash;

   473

		*new_hash = v;

   474

	}

   475

}

   476

   477

void ResetVehiclePosHash()

   478

{

   479

	Vehicle *v;

   480

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

   481

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

   482

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

   483

}

   484

   485

void ResetVehicleColorMap()

   486

{

   487

	Vehicle *v;

   488

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