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

    14

#include "landscape.h"

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "vehicle.h"

    18

#include "timetable.h"

    19

#include "gfx.h"

    20

#include "viewport.h"

    21

#include "news.h"

    22

#include "command.h"

    23

#include "saveload.h"

    24

#include "player.h"

    25

#include "engine.h"

    26

#include "sound.h"

    27

#include "debug.h"

    28

#include "vehicle_gui.h"

    29

#include "depot.h"

    30

#include "station.h"

    31

#include "rail.h"

    32

#include "train.h"

    33

#include "aircraft.h"

    34

#include "industry_map.h"

    35

#include "station_map.h"

    36

#include "water_map.h"

    37

#include "network/network.h"

    38

#include "yapf/yapf.h"

    39

#include "date.h"

    40

#include "newgrf_callbacks.h"

    41

#include "newgrf_engine.h"

    42

#include "newgrf_sound.h"

    43

#include "helpers.hpp"

    44

#include "group.h"

    45

#include "economy.h"

    46

#include "strings.h"

    47

#include "order.h"

    48

    49

#define INVALID_COORD (0x7fffffff)

    50

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

    51

    52

    53

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

    54

const uint32 _veh_build_proc_table[] = {

    55

	CMD_BUILD_RAIL_VEHICLE,

    56

	CMD_BUILD_ROAD_VEH,

    57

	CMD_BUILD_SHIP,

    58

	CMD_BUILD_AIRCRAFT,

    59

};

    60

const uint32 _veh_sell_proc_table[] = {

    61

	CMD_SELL_RAIL_WAGON,

    62

	CMD_SELL_ROAD_VEH,

    63

	CMD_SELL_SHIP,

    64

	CMD_SELL_AIRCRAFT,

    65

};

    66

    67

const uint32 _veh_refit_proc_table[] = {

    68

	CMD_REFIT_RAIL_VEHICLE,

    69

	CMD_REFIT_ROAD_VEH,

    70

	CMD_REFIT_SHIP,

    71

	CMD_REFIT_AIRCRAFT,

    72

};

    73

    74

const uint32 _send_to_depot_proc_table[] = {

    75

	CMD_SEND_TRAIN_TO_DEPOT,

    76

	CMD_SEND_ROADVEH_TO_DEPOT,

    77

	CMD_SEND_SHIP_TO_DEPOT,

    78

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    79

};

    80

    81

    82

/* Initialize the vehicle-pool */

    83

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    84

    85

void VehicleServiceInDepot(Vehicle *v)

    86

{

    87

	v->date_of_last_service = _date;

    88

	v->breakdowns_since_last_service = 0;

    89

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

    90

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

    91

}

    92

    93

bool VehicleNeedsService(const Vehicle *v)

    94

{

    95

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

    96

	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

    97

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

    98

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

    99

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

   100

	}

   101

   102

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

   103

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

   104

	}

   105

   106

	return _patches.servint_ispercent ?

   107

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

   108

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

   109

}

   110

   111

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   112

{

   113

	switch (v->type) {

   114

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   115

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   116

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   117

		default:           return STR_980E_SHIP_IN_THE_WAY;

   118

	}

   119

}

   120

   121

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

   122

{

   123

	const TileInfo *ti = (const TileInfo*)data;

   124

   125

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

   126

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

   127

   128

	_error_message = VehicleInTheWayErrMsg(v);

   129

	return v;

   130

}

   131

   132

   133

bool EnsureNoVehicleOnGround(TileIndex tile)

   134

{

   135

	TileInfo ti;

   136

   137

	ti.tile = tile;

   138

	ti.z = GetTileMaxZ(tile);

   139

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ) == NULL;

   140

}

   141

   142

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   143

{

   144

	TileInfo ti;

   145

   146

	ti.tile = tile;

   147

	ti.z = z;

   148

   149

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

   150

}

   151

   152

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

   153

{

   154

	int x1 = TileX(from);

   155

	int y1 = TileY(from);

   156

	int x2 = TileX(to);

   157

	int y2 = TileY(to);

   158

	Vehicle *veh;

   159

   160

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

   161

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

   162

		Swap(x1, x2);

   163

		Swap(y1, y2);

   164

	}

   165

	FOR_ALL_VEHICLES(veh) {

   166

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

   167

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

   168

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

   169

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

   170

				return veh;

   171

			}

   172

		}

   173

	}

   174

	return NULL;

   175

}

   176

   177

   178

/** Struct used for GetVehicleTunnelBridge() */

   179

struct TunnelBridgeInfo {

   180

	TileIndex tile;                      ///< tile

   181

};

   182

   183

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

   184

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

   185

{

   186

	TunnelBridgeInfo *tbi = (TunnelBridgeInfo*)data;

   187

   188

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

   189

   190

	_error_message = VehicleInTheWayErrMsg(v);

   191

	return v;

   192

}

   193

   194

/**

   195

 * Finds vehicle in tunnel / bridge

   196

 * @param tile first end

   197

 * @param endtile second end

   198

 * @return pointer to vehicle found

   199

 */

   200

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   201

{

   202

	TunnelBridgeInfo tbi = {tile};

   203

   204

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

   205

	if (v != NULL) return v;

   206

   207

	tbi.tile = endtile;

   208

   209

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

   210

}

   211

   212

   213

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

   214

   215

void VehiclePositionChanged(Vehicle *v)

   216

{

   217

	int img = v->cur_image;

   218

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

   219

	const Sprite* spr = GetSprite(img);

   220

   221

	pt.x += spr->x_offs;

   222

	pt.y += spr->y_offs;

   223

   224

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

   225

   226

	v->left_coord = pt.x;

   227

	v->top_coord = pt.y;

   228

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

   229

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

   230

}

   231

   232

/** Called after load to update coordinates */

   233

void AfterLoadVehicles()

   234

{

   235

	Vehicle *v;

   236

   237

	FOR_ALL_VEHICLES(v) {

   238

		/* Reinstate the previous pointer */

   239

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

   240

   241

		v->UpdateDeltaXY(v->direction);

   242

   243

		v->fill_percent_te_id = INVALID_TE_ID;

   244

		v->first = NULL;

   245

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

   246

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

   247

   248

		v->cargo.InvalidateCache();

   249

	}

   250

   251

	FOR_ALL_VEHICLES(v) {

   252

		/* Fill the first pointers */

   253

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

   254

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

   255

				u->first = v;

   256

			}

   257

		}

   258

	}

   259

   260

	FOR_ALL_VEHICLES(v) {

   261

		assert(v->first != NULL);

   262

   263

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

   264

			TrainConsistChanged(v);

   265

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

   266

			RoadVehUpdateCache(v);

   267

		}

   268

	}

   269

   270

	FOR_ALL_VEHICLES(v) {

   271

		switch (v->type) {

   272

			case VEH_ROAD:

   273

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

   274

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

   275

				/* FALL THROUGH */

   276

			case VEH_TRAIN:

   277

			case VEH_SHIP:

   278

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

   279

				break;

   280

   281

			case VEH_AIRCRAFT:

   282

				if (IsNormalAircraft(v)) {

   283

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

   284

   285

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

   286

					Vehicle *shadow = v->Next();

   287

					shadow->cur_image = v->cur_image;

   288

   289

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

   290

					if (v->subtype == AIR_HELICOPTER) {

   291

						Vehicle *rotor = shadow->Next();

   292

						rotor->cur_image = GetRotorImage(v);

   293

					}

   294

   295

					UpdateAircraftCache(v);

   296

				}

   297

				break;

   298

			default: break;

   299

		}

   300

   301

		v->left_coord = INVALID_COORD;

   302

		VehiclePositionChanged(v);

   303

	}

   304

}

   305

   306

Vehicle::Vehicle()

   307

{

   308

	this->type               = VEH_INVALID;

   309

	this->left_coord         = INVALID_COORD;

   310

	this->group_id           = DEFAULT_GROUP;

   311

	this->fill_percent_te_id = INVALID_TE_ID;

   312

	this->first              = this;

   313

	this->colormap           = PAL_NONE;

   314

}

   315

   316

/**

   317

 * Get a value for a vehicle's random_bits.

   318

 * @return A random value from 0 to 255.

   319

 */

   320

byte VehicleRandomBits()

   321

{

   322

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

   323

}

   324

   325

   326

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

   327

{

   328

	uint counter = _Vehicle_pool.first_free_index;

   329

   330

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

   331

		Vehicle *v = AllocateRaw(counter);

   332

   333

		if (v == NULL) return false;

   334

		v = new (v) InvalidVehicle();

   335

   336

		if (vl != NULL) {

   337

			vl[i] = v;

   338

		}

   339

		counter++;

   340

	}

   341

   342

	return true;

   343

}

   344

   345

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

   346

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

   347

const int HASH_BITS = 7;

   348

const int HASH_SIZE = 1 << HASH_BITS;

   349

const int HASH_MASK = HASH_SIZE - 1;

   350

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

   351

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   352

   353

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

   354

 * Profiling results show that 0 is fastest. */

   355

const int HASH_RES = 0;

   356

   357

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   358

   359

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

   360

{

   361

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

   362

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

   363

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

   364

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

   365

				void *a = proc(v, data);

   366

				if (a != NULL) return a;

   367

			}

   368

			if (x == xu) break;

   369

		}

   370

		if (y == yu) break;

   371

	}

   372

   373

	return NULL;

   374

}

   375

   376

   377

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

   378

{

   379

	const int COLL_DIST = 6;

   380

   381

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

   382

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

   383

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

   384

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

   385

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

   386

   387

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

   388

}

   389

   390

   391

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

   392

{

   393

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

   394

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

   395

   396

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

   397

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

   398

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

   399

   400

		void *a = proc(v, data);

   401

		if (a != NULL) return a;

   402

	}

   403

   404

	return NULL;

   405

}

   406

   407

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   408

{

   409

	Vehicle **old_hash = v->old_new_hash;

   410

	Vehicle **new_hash;

   411

   412

	if (remove) {

   413

		new_hash = NULL;

   414

	} else {

   415

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

   416

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

   417

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

   418

	}

   419

   420

	if (old_hash == new_hash) return;

   421

   422

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

   423

	if (old_hash != NULL) {

   424

		Vehicle *last = NULL;

   425

		Vehicle *u = *old_hash;

   426

		while (u != v) {

   427

			last = u;

   428

			u = u->next_new_hash;

   429

			assert(u != NULL);

   430

		}

   431

   432

		if (last == NULL) {

   433

			*old_hash = v->next_new_hash;

   434

		} else {

   435

			last->next_new_hash = v->next_new_hash;

   436

		}

   437

	}

   438

   439

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

   440

	if (new_hash != NULL) {

   441

		v->next_new_hash = *new_hash;

   442

		*new_hash = v;

   443

		assert(v != v->next_new_hash);

   444

	}

   445

   446

	/* Remember current hash position */

   447

	v->old_new_hash = new_hash;

   448

}

   449

   450

static Vehicle *_vehicle_position_hash[0x1000];

   451

   452

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

   453

{

   454

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   455

   456

	Vehicle **old_hash, **new_hash;

   457

	int old_x = v->left_coord;

   458

	int old_y = v->top_coord;

   459

   460

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

   461

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

   462

   463

	if (old_hash == new_hash) return;

   464

   465

	/* remove from hash table? */

   466

	if (old_hash != NULL) {

   467

		Vehicle *last = NULL;

   468

		Vehicle *u = *old_hash;

   469

		while (u != v) {

   470

			last = u;

   471

			u = u->next_hash;

   472

			assert(u != NULL);

   473

		}

   474

   475

		if (last == NULL) {

   476

			*old_hash = v->next_hash;

   477

		} else {

   478

			last->next_hash = v->next_hash;

   479

		}

   480

	}

   481

   482

	/* insert into hash table? */

   483

	if (new_hash != NULL) {

   484

		v->next_hash = *new_hash;

   485

		*new_hash = v;

   486

	}

   487

}

   488

   489

void ResetVehiclePosHash()