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

#include "ai/ai.h"

    54

#include "core/alloc_func.hpp"

    56

    57

#include "table/sprites.h"

    58

#include "table/strings.h"

    59

    60

#define INVALID_COORD (0x7fffffff)

    61

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

    62

    63

VehicleID _vehicle_id_ctr_day;

    64

const Vehicle *_place_clicked_vehicle;

    65

VehicleID _new_vehicle_id;

    66

uint16 _returned_refit_capacity;

    67

    68

    69

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

    70

const uint32 _veh_build_proc_table[] = {

    71

	CMD_BUILD_RAIL_VEHICLE,

    72

	CMD_BUILD_ROAD_VEH,

    73

	CMD_BUILD_SHIP,

    74

	CMD_BUILD_AIRCRAFT,

    75

};

    76

const uint32 _veh_sell_proc_table[] = {

    77

	CMD_SELL_RAIL_WAGON,

    78

	CMD_SELL_ROAD_VEH,

    79

	CMD_SELL_SHIP,

    80

	CMD_SELL_AIRCRAFT,

    81

};

    82

    83

const uint32 _veh_refit_proc_table[] = {

    84

	CMD_REFIT_RAIL_VEHICLE,

    85

	CMD_REFIT_ROAD_VEH,

    86

	CMD_REFIT_SHIP,

    87

	CMD_REFIT_AIRCRAFT,

    88

};

    89

    90

const uint32 _send_to_depot_proc_table[] = {

    91

	CMD_SEND_TRAIN_TO_DEPOT,

    92

	CMD_SEND_ROADVEH_TO_DEPOT,

    93

	CMD_SEND_SHIP_TO_DEPOT,

    94

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    95

};

    96

    97

    98

/* Initialize the vehicle-pool */

    99

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

   100

   101

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

   102

 * @param *p The vehicle owner

   103

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

   104

 */

   105

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

   106

{

   107

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

   108

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

   109

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

   110

	 * argument rather than finding it again. */

   111

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

   112

   113

	if (!p->engine_renew) return false;

   114

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

   115

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

   116

   117

	return true;

   118

}

   119

   120

void VehicleServiceInDepot(Vehicle *v)

   121

{

   122

	v->date_of_last_service = _date;

   123

	v->breakdowns_since_last_service = 0;

   124

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

   125

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

   126

}

   127

   128

bool Vehicle::NeedsServicing() const

   129

{

   130

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

   131

   133

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

   134

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

   135

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

   136

	}

   137

   139

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

   140

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

   141

}

   142

   143

bool Vehicle::NeedsAutomaticServicing() const

   144

{

   146

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

   147

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

   148

	return NeedsServicing();

   149

}

   150

   151

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   152

{

   153

	switch (v->type) {

   154

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   155

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   156

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   157

		default:           return STR_980E_SHIP_IN_THE_WAY;

   158

	}

   159

}

   160

   161

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

   162

{

   163

	byte z = *(byte*)data;

   164

   165

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

   166

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

   167

   168

	_error_message = VehicleInTheWayErrMsg(v);

   169

	return v;

   170

}

   171

   172

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   173

{

   174

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

   175

}

   176

   177

bool EnsureNoVehicleOnGround(TileIndex tile)

   178

{

   179

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

   180

}

   181

   182

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

   183

{

   184

	int x1 = TileX(from);

   185

	int y1 = TileY(from);

   186

	int x2 = TileX(to);

   187

	int y2 = TileY(to);

   188

	Vehicle *veh;

   189

   190

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

   191

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

   192

		Swap(x1, x2);

   193

		Swap(y1, y2);

   194

	}

   195

	FOR_ALL_VEHICLES(veh) {

   196

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

   197

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

   198

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

   199

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

   200

				return veh;

   201

			}

   202

		}

   203

	}

   204

	return NULL;

   205

}

   206

   207

   208

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

   209

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

   210

{

   211

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

   212

   213

	_error_message = VehicleInTheWayErrMsg(v);

   214

	return v;

   215

}

   216

   217

/**

   218

 * Finds vehicle in tunnel / bridge

   219

 * @param tile first end

   220

 * @param endtile second end

   221

 * @return pointer to vehicle found

   222

 */

   223

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   224

{

   225

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

   226

	if (v != NULL) return v;

   227

   228

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

   229

}

   230

   231

   232

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

   233

   234

void VehiclePositionChanged(Vehicle *v)

   235

{

   236

	int img = v->cur_image;

   237

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

   238

	const Sprite *spr = GetSprite(img);

   239

   240

	pt.x += spr->x_offs;

   241

	pt.y += spr->y_offs;

   242

   243

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

   244

   245

	v->left_coord = pt.x;

   246

	v->top_coord = pt.y;

   247

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

   248

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

   249

}

   250

   251

/** Called after load to update coordinates */

   252

void AfterLoadVehicles(bool clear_te_id)

   253

{

   254

	Vehicle *v;

   255

   256

	FOR_ALL_VEHICLES(v) {

   257

		/* Reinstate the previous pointer */

   258

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

   259

   260

		v->UpdateDeltaXY(v->direction);

   261

   262

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   263

		v->first = NULL;

   264

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

   265

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

   266

   267

		v->cargo.InvalidateCache();

   268

	}

   269

   270

	FOR_ALL_VEHICLES(v) {

   271

		/* Fill the first pointers */

   272

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

   273

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

   274

				u->first = v;

   275

			}

   276

		}

   277

	}

   278

   279

	FOR_ALL_VEHICLES(v) {

   280

		assert(v->first != NULL);

   281

   282

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

   283

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

   284

			TrainConsistChanged(v);

   285

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

   286

			RoadVehUpdateCache(v);

   287

		}

   288

	}

   289

   290

	FOR_ALL_VEHICLES(v) {

   291

		switch (v->type) {

   292

			case VEH_ROAD:

   293

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

   294

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

   295

				/* FALL THROUGH */

   296

			case VEH_TRAIN:

   297

			case VEH_SHIP:

   298

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

   299

				break;

   300

   301

			case VEH_AIRCRAFT:

   302

				if (IsNormalAircraft(v)) {

   303

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

   304

   305

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

   306

					Vehicle *shadow = v->Next();

   307

					shadow->cur_image = v->cur_image;

   308

   309

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

   310

					if (v->subtype == AIR_HELICOPTER) {

   311

						Vehicle *rotor = shadow->Next();

   312

						rotor->cur_image = GetRotorImage(v);

   313

					}

   314

   315

					UpdateAircraftCache(v);

   316

				}

   317

				break;

   318

			default: break;

   319

		}

   320

   321

		v->left_coord = INVALID_COORD;

   322

		VehiclePositionChanged(v);

   323

	}

   324

}

   325

   326

Vehicle::Vehicle()

   327

{

   328

	this->type               = VEH_INVALID;

   329

	this->left_coord         = INVALID_COORD;

   330

	this->group_id           = DEFAULT_GROUP;

   331

	this->fill_percent_te_id = INVALID_TE_ID;

   332

	this->first              = this;

   333

	this->colormap           = PAL_NONE;

   334

}

   335

   336

/**

   337

 * Get a value for a vehicle's random_bits.

   338

 * @return A random value from 0 to 255.

   339

 */

   340

byte VehicleRandomBits()

   341

{

   342

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

   343

}

   344

   345

   346

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

   347

{

   348

	uint counter = _Vehicle_pool.first_free_index;

   349

   350

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

   351

		Vehicle *v = AllocateRaw(counter);

   352

   353

		if (v == NULL) return false;

   354

		v = new (v) InvalidVehicle();

   355

   356

		if (vl != NULL) {

   357

			vl[i] = v;

   358

		}

   359

		counter++;

   360

	}

   361

   362

	return true;

   363

}

   364

   365

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

   366

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

   367

const int HASH_BITS = 7;

   368

const int HASH_SIZE = 1 << HASH_BITS;

   369

const int HASH_MASK = HASH_SIZE - 1;

   370

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

   371

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   372

   373

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

   374

 * Profiling results show that 0 is fastest. */

   375

const int HASH_RES = 0;

   376

   377

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   378

   379

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

   380

{

   381

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

   382

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

   383

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

   384

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

   385

				void *a = proc(v, data);

   386

				if (a != NULL) return a;

   387

			}

   388

			if (x == xu) break;

   389

		}

   390

		if (y == yu) break;

   391

	}

   392

   393

	return NULL;

   394

}

   395

   396

   397

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

   398

{

   399

	const int COLL_DIST = 6;

   400

   401

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

   402

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

   403

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

   404

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

   405

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

   406

   407

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

   408

}

   409

   410

   411

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

   412

{

   413

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

   414

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

   415

   416

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

   417

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

   418

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

   419

   420

		void *a = proc(v, data);

   421

		if (a != NULL) return a;

   422

	}

   423

   424

	return NULL;

   425

}

   426

   427

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   428

{

   429

	Vehicle **old_hash = v->old_new_hash;

   430

	Vehicle **new_hash;

   431

   432

	if (remove) {

   433

		new_hash = NULL;

   434

	} else {

   435

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

   436

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

   437

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

   438

	}

   439

   440

	if (old_hash == new_hash) return;

   441

   442

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

   443

	if (old_hash != NULL) {

   444

		Vehicle *last = NULL;

   445

		Vehicle *u = *old_hash;

   446

		while (u != v) {

   447

			last = u;

   448

			u = u->next_new_hash;

   449

			assert(u != NULL);

   450

		}

   451

   452

		if (last == NULL) {

   453

			*old_hash = v->next_new_hash;

   454

		} else {

   455

			last->next_new_hash = v->next_new_hash;

   456

		}

   457

	}

   458

   459

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

   460

	if (new_hash != NULL) {

   461

		v->next_new_hash = *new_hash;

   462

		*new_hash = v;

   463

		assert(v != v->next_new_hash);

   464

	}

   465

   466

	/* Remember current hash position */

   467

	v->old_new_hash = new_hash;

   468

}

   469

   470

static Vehicle *_vehicle_position_hash[0x1000];

   471

   472

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

   473

{

   474

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   475

   476

	Vehicle **old_hash, **new_hash;

   477

	int old_x = v->left_coord;

   478

	int old_y = v->top_coord;

   479

   480

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

   481

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

   482

   483

	if (old_hash == new_hash) return;

   484

   485

	/* remove from hash table? */

   486

	if (old_hash != NULL) {

   487

		Vehicle *last = NULL;