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 "player_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 "network/network.h"

    29

#include "yapf/yapf.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_engine.h"

    32

#include "newgrf_sound.h"

    33

#include "newgrf_station.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

    54

#include "table/sprites.h"

    55

#include "table/strings.h"

    56

    57

#define INVALID_COORD (0x7fffffff)

    58

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

    59

    60

VehicleID _vehicle_id_ctr_day;

    61

const Vehicle *_place_clicked_vehicle;

    62

VehicleID _new_vehicle_id;

    63

uint16 _returned_refit_capacity;

    64

    65

    66

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

    67

const uint32 _veh_build_proc_table[] = {

    68

	CMD_BUILD_RAIL_VEHICLE,

    69

	CMD_BUILD_ROAD_VEH,

    70

	CMD_BUILD_SHIP,

    71

	CMD_BUILD_AIRCRAFT,

    72

};

    73

const uint32 _veh_sell_proc_table[] = {

    74

	CMD_SELL_RAIL_WAGON,

    75

	CMD_SELL_ROAD_VEH,

    76

	CMD_SELL_SHIP,

    77

	CMD_SELL_AIRCRAFT,

    78

};

    79

    80

const uint32 _veh_refit_proc_table[] = {

    81

	CMD_REFIT_RAIL_VEHICLE,

    82

	CMD_REFIT_ROAD_VEH,

    83

	CMD_REFIT_SHIP,

    84

	CMD_REFIT_AIRCRAFT,

    85

};

    86

    87

const uint32 _send_to_depot_proc_table[] = {

    88

	CMD_SEND_TRAIN_TO_DEPOT,

    89

	CMD_SEND_ROADVEH_TO_DEPOT,

    90

	CMD_SEND_SHIP_TO_DEPOT,

    91

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    92

};

    93

    94

    95

/* Initialize the vehicle-pool */

    96

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    97

    98

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

    99

 * @param *p The vehicle owner

   100

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

   101

 */

   102

bool Vehicle::NeedsAutorenewing(const Player *p) const

   103

{

   104

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

   105

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

   106

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

   107

	 * argument rather than finding it again. */

   108

	assert(p == GetPlayer(this->owner));

   109

   110

	if (!p->engine_renew) return false;

   111

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

   112

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

   113

   114

	return true;

   115

}

   116

   117

void VehicleServiceInDepot(Vehicle *v)

   118

{

   119

	v->date_of_last_service = _date;

   120

	v->breakdowns_since_last_service = 0;

   121

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

   122

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

   123

}

   124

   125

bool Vehicle::NeedsServicing() const

   126

{

   127

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

   128

   129

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

   130

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

   131

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

   132

		return EngineHasReplacementForPlayer(GetPlayer(this->owner), this->engine_type, this->group_id);

   133

	}

   134

   135

	return _patches.servint_ispercent ?

   136

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

   137

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

   138

}

   139

   140

bool Vehicle::NeedsAutomaticServicing() const

   141

{

   142

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

   143

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

   144

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

   145

	return NeedsServicing();

   146

}

   147

   148

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   149

{

   150

	switch (v->type) {

   151

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   152

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   153

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   154

		default:           return STR_980E_SHIP_IN_THE_WAY;

   155

	}

   156

}

   157

   158

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

   159

{

   160

	byte z = *(byte*)data;

   161

   162

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

   163

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

   164

   165

	_error_message = VehicleInTheWayErrMsg(v);

   166

	return v;

   167

}

   168

   169

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   170

{

   171

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

   172

}

   173

   174

bool EnsureNoVehicleOnGround(TileIndex tile)

   175

{

   176

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

   177

}

   178

   179

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

   180

{

   181

	int x1 = TileX(from);

   182

	int y1 = TileY(from);

   183

	int x2 = TileX(to);

   184

	int y2 = TileY(to);

   185

	Vehicle *veh;

   186

   187

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

   188

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

   189

		Swap(x1, x2);

   190

		Swap(y1, y2);

   191

	}

   192

	FOR_ALL_VEHICLES(veh) {

   193

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

   194

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

   195

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

   196

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

   197

				return veh;

   198

			}

   199

		}

   200

	}

   201

	return NULL;

   202

}

   203

   204

   205

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

   206

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

   207

{

   208

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

   209

   210

	_error_message = VehicleInTheWayErrMsg(v);

   211

	return v;

   212

}

   213

   214

/**

   215

 * Finds vehicle in tunnel / bridge

   216

 * @param tile first end

   217

 * @param endtile second end

   218

 * @return pointer to vehicle found

   219

 */

   220

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   221

{

   222

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

   223

	if (v != NULL) return v;

   224

   225

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

   226

}

   227

   228

   229

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

   230

   231

void VehiclePositionChanged(Vehicle *v)

   232

{

   233

	int img = v->cur_image;

   234

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

   235

	const Sprite *spr = GetSprite(img);

   236

   237

	pt.x += spr->x_offs;

   238

	pt.y += spr->y_offs;

   239

   240

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

   241

   242

	v->left_coord = pt.x;

   243

	v->top_coord = pt.y;

   244

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

   245

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

   246

}

   247

   248

/** Called after load to update coordinates */

   249

void AfterLoadVehicles(bool clear_te_id)

   250

{

   251

	Vehicle *v;

   252

   253

	FOR_ALL_VEHICLES(v) {

   254

		/* Reinstate the previous pointer */

   255

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

   256

   257

		v->UpdateDeltaXY(v->direction);

   258

   259

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   260

		v->first = NULL;

   261

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

   262

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

   263

   264

		v->cargo.InvalidateCache();

   265

	}

   266

   267

	FOR_ALL_VEHICLES(v) {

   268

		/* Fill the first pointers */

   269

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

   270

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

   271

				u->first = v;

   272

			}

   273

		}

   274

	}

   275

   276

	FOR_ALL_VEHICLES(v) {

   277

		assert(v->first != NULL);

   278

   279

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

   280

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

   281

			TrainConsistChanged(v);

   282

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

   283

			RoadVehUpdateCache(v);

   284

		}

   285

	}

   286

   287

	FOR_ALL_VEHICLES(v) {

   288

		switch (v->type) {

   289

			case VEH_ROAD:

   290

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

   291

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

   292

				/* FALL THROUGH */

   293

			case VEH_TRAIN:

   294

			case VEH_SHIP:

   295

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

   296

				break;

   297

   298

			case VEH_AIRCRAFT:

   299

				if (IsNormalAircraft(v)) {

   300

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

   301

   302

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

   303

					Vehicle *shadow = v->Next();

   304

					shadow->cur_image = v->cur_image;

   305

   306

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

   307

					if (v->subtype == AIR_HELICOPTER) {

   308

						Vehicle *rotor = shadow->Next();

   309

						rotor->cur_image = GetRotorImage(v);

   310

					}

   311

   312

					UpdateAircraftCache(v);

   313

				}

   314

				break;

   315

			default: break;

   316

		}

   317

   318

		v->left_coord = INVALID_COORD;

   319

		VehiclePositionChanged(v);

   320

	}

   321

}

   322

   323

Vehicle::Vehicle()

   324

{

   325

	this->type               = VEH_INVALID;

   326

	this->left_coord         = INVALID_COORD;

   327

	this->group_id           = DEFAULT_GROUP;

   328

	this->fill_percent_te_id = INVALID_TE_ID;

   329

	this->first              = this;

   330

	this->colormap           = PAL_NONE;

   331

}

   332

   333

/**

   334

 * Get a value for a vehicle's random_bits.

   335

 * @return A random value from 0 to 255.

   336

 */

   337

byte VehicleRandomBits()

   338

{

   339

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

   340

}

   341

   342

   343

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

   344

{

   345

	uint counter = _Vehicle_pool.first_free_index;

   346

   347

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

   348

		Vehicle *v = AllocateRaw(counter);

   349

   350

		if (v == NULL) return false;

   351

		v = new (v) InvalidVehicle();

   352

   353

		if (vl != NULL) {

   354

			vl[i] = v;

   355

		}

   356

		counter++;

   357

	}

   358

   359

	return true;

   360

}

   361

   362

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

   363

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

   364

const int HASH_BITS = 7;

   365

const int HASH_SIZE = 1 << HASH_BITS;

   366

const int HASH_MASK = HASH_SIZE - 1;

   367

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

   368

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   369

   370

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

   371

 * Profiling results show that 0 is fastest. */

   372

const int HASH_RES = 0;

   373

   374

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   375

   376

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

   377

{

   378

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

   379

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

   380

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

   381

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

   382

				void *a = proc(v, data);

   383

				if (a != NULL) return a;

   384

			}

   385

			if (x == xu) break;

   386

		}

   387

		if (y == yu) break;

   388

	}

   389

   390

	return NULL;

   391

}

   392

   393

   394

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

   395

{

   396

	const int COLL_DIST = 6;

   397

   398

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

   399

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

   400

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

   401

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

   402

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

   403

   404

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

   405

}

   406

   407

   408

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

   409

{

   410

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

   411

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

   412

   413

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

   414

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

   415

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

   416

   417

		void *a = proc(v, data);

   418

		if (a != NULL) return a;

   419

	}

   420

   421

	return NULL;

   422

}

   423

   424

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   425

{

   426

	Vehicle **old_hash = v->old_new_hash;

   427

	Vehicle **new_hash;

   428

   429

	if (remove) {

   430

		new_hash = NULL;

   431

	} else {

   432

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

   433

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

   434

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

   435

	}

   436

   437

	if (old_hash == new_hash) return;

   438

   439

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

   440

	if (old_hash != NULL) {

   441

		Vehicle *last = NULL;

   442

		Vehicle *u = *old_hash;

   443

		while (u != v) {

   444

			last = u;

   445

			u = u->next_new_hash;

   446

			assert(u != NULL);

   447

		}

   448

   449

		if (last == NULL) {

   450

			*old_hash = v->next_new_hash;

   451

		} else {

   452

			last->next_new_hash = v->next_new_hash;

   453

		}

   454

	}

   455

   456

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

   457

	if (new_hash != NULL) {

   458

		v->next_new_hash = *new_hash;

   459

		*new_hash = v;

   460

		assert(v != v->next_new_hash);

   461

	}

   462

   463

	/* Remember current hash position */

   464

	v->old_new_hash = new_hash;

   465

}

   466

   467

static Vehicle *_vehicle_position_hash[0x1000];

   468

   469

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

   470

{

   471

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   472

   473

	Vehicle **old_hash, **new_hash;

   474

	int old_x = v->left_coord;

   475

	int old_y = v->top_coord;

   476

   477

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

   478

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

   479

   480

	if (old_hash == new_hash) return;

   481

   482

	/* remove from hash table? */

   483

	if (old_hash != NULL) {

   484

		Vehicle *last = NULL;

   485

		Vehicle *u = *old_hash;

   486

		while (u != v) {

   487

			last = u;