1

/* $Id$ */

     2

     3

/** @file vehicle.cpp Base implementations of all vehicles. */

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

    12

#include "landscape.h"

    13

#include "timetable.h"

    14

#include "viewport_func.h"

    15

#include "gfx_func.h"

    16

#include "news_func.h"

    17

#include "command_func.h"

    18

#include "saveload.h"

    19

#include "company_func.h"

    20

#include "debug.h"

    21

#include "vehicle_gui.h"

    22

#include "rail_type.h"

    23

#include "train.h"

    24

#include "aircraft.h"

    25

#include "industry_map.h"

    26

#include "station_map.h"

    27

#include "water_map.h"

    28

#include "yapf/yapf.h"

    29

#include "newgrf_callbacks.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_sound.h"

    32

#include "newgrf_station.h"

    33

#include "newgrf_text.h"

    34

#include "group.h"

    35

#include "order_func.h"

    36

#include "strings_func.h"

    37

#include "zoom_func.h"

    38

#include "functions.h"

    39

#include "date_func.h"

    40

#include "window_func.h"

    41

#include "vehicle_func.h"

    42

#include "signal_func.h"

    43

#include "sound_func.h"

    44

#include "variables.h"

    45

#include "autoreplace_func.h"

    46

#include "autoreplace_gui.h"

    47

#include "string_func.h"

    48

#include "settings_type.h"

    49

#include "oldpool_func.h"

    50

#include "depot_map.h"

    51

#include "animated_tile_func.h"

    52

#include "effectvehicle_base.h"

    53

#include "core/alloc_func.hpp"

    54

#include "vehiclelist.h"

    55

    56

#include "table/sprites.h"

    57

#include "table/strings.h"

    58

    59

#define INVALID_COORD (0x7fffffff)

    60

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

    61

    62

VehicleID _vehicle_id_ctr_day;

    63

const Vehicle *_place_clicked_vehicle;

    64

VehicleID _new_vehicle_id;

    65

uint16 _returned_refit_capacity;

    66

    67

    68

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

    69

const uint32 _veh_build_proc_table[] = {

    70

	CMD_BUILD_RAIL_VEHICLE,

    71

	CMD_BUILD_ROAD_VEH,

    72

	CMD_BUILD_SHIP,

    73

	CMD_BUILD_AIRCRAFT,

    74

};

    75

const uint32 _veh_sell_proc_table[] = {

    76

	CMD_SELL_RAIL_WAGON,

    77

	CMD_SELL_ROAD_VEH,

    78

	CMD_SELL_SHIP,

    79

	CMD_SELL_AIRCRAFT,

    80

};

    81

    82

const uint32 _veh_refit_proc_table[] = {

    83

	CMD_REFIT_RAIL_VEHICLE,

    84

	CMD_REFIT_ROAD_VEH,

    85

	CMD_REFIT_SHIP,

    86

	CMD_REFIT_AIRCRAFT,

    87

};

    88

    89

const uint32 _send_to_depot_proc_table[] = {

    90

	CMD_SEND_TRAIN_TO_DEPOT,

    91

	CMD_SEND_ROADVEH_TO_DEPOT,

    92

	CMD_SEND_SHIP_TO_DEPOT,

    93

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    94

};

    95

    96

    97

/* Initialize the vehicle-pool */

    98

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    99

   100

/** Function to tell if a vehicle needs to be autorenewed

   101

 * @param *c The vehicle owner

   102

 * @return true if the vehicle is old enough for replacement

   103

 */

   104

bool Vehicle::NeedsAutorenewing(const Company *c) const

   105

{

   106

	/* We can always generate the Company pointer when we have the vehicle.

   107

	 * However this takes time and since the Company pointer is often present

   108

	 * when this function is called then it's faster to pass the pointer as an

   109

	 * argument rather than finding it again. */

   110

	assert(c == GetCompany(this->owner));

   111

   112

	if (!c->engine_renew) return false;

   113

	if (this->age - this->max_age < (c->engine_renew_months * 30)) return false;

   114

	if (this->age == 0) return false; // rail cars don't age and lacks a max age

   115

   116

	return true;

   117

}

   118

   119

void VehicleServiceInDepot(Vehicle *v)

   120

{

   121

	v->date_of_last_service = _date;

   122

	v->breakdowns_since_last_service = 0;

   123

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

   124

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

   125

}

   126

   127

bool Vehicle::NeedsServicing() const

   128

{

   129

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

   130

   131

	if (_settings_game.order.no_servicing_if_no_breakdowns && _settings_game.difficulty.vehicle_breakdowns == 0) {

   132

		/* Vehicles set for autoreplacing needs to go to a depot even if breakdowns are turned off.

   133

		 * Note: If servicing is enabled, we postpone replacement till next service. */

   134

		return EngineHasReplacementForCompany(GetCompany(this->owner), this->engine_type, this->group_id);

   135

	}

   136

   137

	return _settings_game.vehicle.servint_ispercent ?

   138

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

   139

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

   140

}

   141

   142

bool Vehicle::NeedsAutomaticServicing() const

   143

{

   144

	if (_settings_game.order.gotodepot && VehicleHasDepotOrders(this)) return false;

   145

	if (this->current_order.IsType(OT_LOADING))            return false;

   146

	if (this->current_order.IsType(OT_GOTO_DEPOT) && this->current_order.GetDepotOrderType() != ODTFB_SERVICE) return false;

   147

	return NeedsServicing();

   148

}

   149

   150

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   151

{

   152

	switch (v->type) {

   153

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   154

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   155

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   156

		default:           return STR_980E_SHIP_IN_THE_WAY;

   157

	}

   158

}

   159

   160

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

   161

{

   162

	byte z = *(byte*)data;

   163

   164

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

   165

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

   166

   167

	_error_message = VehicleInTheWayErrMsg(v);

   168

	return v;

   169

}

   170

   171

bool EnsureNoVehicleOnGround(TileIndex tile)

   172

{

   173

	byte z = GetTileMaxZ(tile);

   174

	return !HasVehicleOnPos(tile, &z, &EnsureNoVehicleProcZ);

   175

}

   176

   177

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

   178

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

   179

{

   180

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

   181

	if (v == (const Vehicle *)data) return NULL;

   182

   183

	_error_message = VehicleInTheWayErrMsg(v);

   184

	return v;

   185

}

   186

   187

/**

   188

 * Finds vehicle in tunnel / bridge

   189

 * @param tile first end

   190

 * @param endtile second end

   191

 * @param ignore Ignore this vehicle when searching

   192

 * @return true if the bridge has a vehicle

   193

 */

   194

bool HasVehicleOnTunnelBridge(TileIndex tile, TileIndex endtile, const Vehicle *ignore)

   195

{

   196

	return HasVehicleOnPos(tile, (void *)ignore, &GetVehicleTunnelBridgeProc) ||

   197

			HasVehicleOnPos(endtile, (void *)ignore, &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, ST_NORMAL);

   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

		if (v->NextShared() != NULL) v->NextShared()->previous_shared = v;

   229

   230

		v->UpdateDeltaXY(v->direction);

   231

   232

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   233

		v->first = NULL;

   234

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

   235

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

   236

   237

		v->cargo.InvalidateCache();

   238

	}

   239

   240

	FOR_ALL_VEHICLES(v) {

   241

		/* Fill the first pointers */

   242

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

   243

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

   244

				u->first = v;

   245

			}

   246

   247

			/* Shared orders are only valid for first vehicles in chains. */

   248

			if (v->previous_shared == NULL) {

   249

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

   250

					u->first_shared = v;

   251

				}

   252

			}

   253

		}

   254

	}

   255

   256

	FOR_ALL_VEHICLES(v) {

   257

		assert(v->first != NULL);

   258

   259

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

   260

			if (IsFrontEngine(v)) v->u.rail.last_speed = v->cur_speed; // update displayed train speed

   261

			TrainConsistChanged(v, false);

   262

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

   263

			RoadVehUpdateCache(v);

   264

		}

   265

	}

   266

   267

	/* Stop non-front engines */

   268

	FOR_ALL_VEHICLES(v) {

   269

		if (v->type == VEH_TRAIN && IsTrainEngine(v) && !IsFrontEngine(v)) v->vehstatus |= VS_STOPPED;

   270

	}

   271

   272

	FOR_ALL_VEHICLES(v) {

   273

		switch (v->type) {

   274

			case VEH_ROAD:

   275

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

   276

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

   277

				/* FALL THROUGH */

   278

			case VEH_TRAIN:

   279

			case VEH_SHIP:

   280

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

   281

				break;

   282

   283

			case VEH_AIRCRAFT:

   284

				if (IsNormalAircraft(v)) {

   285

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

   286

   287

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

   288

					Vehicle *shadow = v->Next();

   289

					shadow->cur_image = v->cur_image;

   290

   291

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

   292

					if (v->subtype == AIR_HELICOPTER) {

   293

						Vehicle *rotor = shadow->Next();

   294

						rotor->cur_image = GetRotorImage(v);

   295

					}

   296

   297

					UpdateAircraftCache(v);

   298

				}

   299

				break;

   300

			default: break;

   301

		}

   302

   303

		v->left_coord = INVALID_COORD;

   304

		VehiclePositionChanged(v);

   305

	}

   306

}

   307

   308

Vehicle::Vehicle()

   309

{

   310

	this->type               = VEH_INVALID;

   311

	this->left_coord         = INVALID_COORD;

   312

	this->group_id           = DEFAULT_GROUP;

   313

	this->fill_percent_te_id = INVALID_TE_ID;

   314

	this->first              = this;

   315

	this->first_shared       = this;

   316

	this->colormap           = PAL_NONE;

   317

}

   318

   319

/**

   320

 * Get a value for a vehicle's random_bits.

   321

 * @return A random value from 0 to 255.

   322

 */

   323

byte VehicleRandomBits()

   324

{

   325

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

   326

}

   327

   328

   329

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

   330

{

   331

	uint counter = _Vehicle_pool.first_free_index;

   332

   333

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

   334

		Vehicle *v = AllocateRaw(counter);

   335

   336

		if (v == NULL) return false;

   337

		v = new (v) InvalidVehicle();

   338

   339

		if (vl != NULL) {

   340

			vl[i] = v;

   341

		}

   342

		counter++;

   343

	}

   344

   345

	return true;

   346

}

   347

   348

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

   349

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

   350

const int HASH_BITS = 7;

   351

const int HASH_SIZE = 1 << HASH_BITS;

   352

const int HASH_MASK = HASH_SIZE - 1;

   353

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

   354

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   355

   356

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

   357

 * Profiling results show that 0 is fastest. */

   358

const int HASH_RES = 0;

   359

   360

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   361

   362

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

   363

{

   364

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

   365

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

   366

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

   367

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

   368

				Vehicle *a = proc(v, data);

   369

				if (find_first && a != NULL) return a;

   370

			}

   371

			if (x == xu) break;

   372

		}

   373

		if (y == yu) break;

   374

	}

   375

   376

	return NULL;

   377

}

   378

   379

   380

/**

   381

 * Helper function for FindVehicleOnPos/HasVehicleOnPos.

   382

 * @note Do not call this function directly!

   383

 * @param x    The X location on the map

   384

 * @param y    The Y location on the map

   385

 * @param data Arbitrary data passed to proc

   386

 * @param proc The proc that determines whether a vehicle will be "found".

   387

 * @param find_first Whether to return on the first found or iterate over

   388

 *                   all vehicles

   389

 * @return the best matching or first vehicle (depending on find_first).

   390

 */

   391

static Vehicle *VehicleFromPosXY(int x, int y, void *data, VehicleFromPosProc *proc, bool find_first)

   392

{

   393

	const int COLL_DIST = 6;

   394

   395

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

   396

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

   397

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

   398

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

   399

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

   400

   401

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

   402

}

   403

   404

/**

   405

 * Find a vehicle from a specific location. It will call proc for ALL vehicles

   406

 * on the tile and YOU must make SURE that the "best one" is stored in the

   407

 * data value and is ALWAYS the same regardless of the order of the vehicles

   408

 * where proc was called on!

   409

 * When you fail to do this properly you create an almost untraceable DESYNC!

   410

 * @note The return value of proc will be ignored.

   411

 * @note Use this when you have the intention that all vehicles

   412

 *       should be iterated over.

   413

 * @param x    The X location on the map

   414

 * @param y    The Y location on the map

   415

 * @param data Arbitrary data passed to proc

   416

 * @param proc The proc that determines whether a vehicle will be "found".

   417

 */

   418

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

   419

{

   420

	VehicleFromPosXY(x, y, data, proc, false);

   421

}

   422

   423

/**

   424

 * Checks whether a vehicle in on a specific location. It will call proc for

   425

 * vehicles until it returns non-NULL.

   426

 * @note Use FindVehicleOnPosXY when you have the intention that all vehicles

   427

 *       should be iterated over.

   428

 * @param x    The X location on the map

   429

 * @param y    The Y location on the map

   430

 * @param data Arbitrary data passed to proc

   431

 * @param proc The proc that determines whether a vehicle will be "found".

   432

 * @return True if proc returned non-NULL.

   433

 */

   434

bool HasVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc)

   435

{

   436

	return VehicleFromPosXY(x, y, data, proc, true) != NULL;

   437

}

   438

   439

/**

   440

 * Helper function for FindVehicleOnPos/HasVehicleOnPos.

   441

 * @note Do not call this function directly!

   442

 * @param tile The location on the map

   443

 * @param data Arbitrary data passed to proc

   444

 * @param proc The proc that determines whether a vehicle will be "found".

   445

 * @param find_first Whether to return on the first found or iterate over

   446

 *                   all vehicles

   447

 * @return the best matching or first vehicle (depending on find_first).

   448

 */

   449

static Vehicle *VehicleFromPos(TileIndex tile, void *data, VehicleFromPosProc *proc, bool find_first)

   450

{

   451

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

   452

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

   453

   454

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

   455

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

   456

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

   457

   458

		Vehicle *a = proc(v, data);

   459

		if (find_first && a != NULL) return a;

   460

	}

   461

   462

	return NULL;

   463

}

   464

   465

/**

   466

 * Find a vehicle from a specific location. It will call proc for ALL vehicles

   467

 * on the tile and YOU must make SURE that the "best one" is stored in the

   468

 * data value and is ALWAYS the same regardless of the order of the vehicles

   469

 * where proc was called on!

   470

 * When you fail to do this properly you create an almost untraceable DESYNC!

   471

 * @note The return value of proc will be ignored.

   472

 * @note Use this when you have the intention that all vehicles

   473

 *       should be iterated over.

   474

 * @param tile The location on the map

   475

 * @param data Arbitrary data passed to proc

   476

 * @param proc The proc that determines whether a vehicle will be "found".

   477

 */

   478

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

   479

{

   480

	VehicleFromPos(tile, data, proc, false);

   481

}

   482

   483

/**

   484

 * Checks whether a vehicle in on a specific location. It will call proc for

   485

 * vehicles until it returns non-NULL.