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

    19

#include "viewport.h"

    20

#include "news.h"

    21

#include "command.h"

    22

#include "saveload.h"

    23

#include "player.h"

    24

#include "engine.h"

    25

#include "sound.h"

    26

#include "debug.h"

    27

#include "vehicle_gui.h"

    28

#include "depot.h"

    29

#include "station.h"

    30

#include "rail.h"

    31

#include "train.h"

    32

#include "aircraft.h"

    33

#include "industry_map.h"

    34

#include "station_map.h"

    35

#include "water_map.h"

    36

#include "network/network.h"

    37

#include "yapf/yapf.h"

    38

#include "date.h"

    39

#include "newgrf_callbacks.h"

    40

#include "newgrf_engine.h"

    41

#include "newgrf_sound.h"

    42

#include "helpers.hpp"

    44

    45

#define INVALID_COORD (-0x8000)

    46

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

    47

    48

    49

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

    50

const uint32 _veh_build_proc_table[] = {

    51

	CMD_BUILD_RAIL_VEHICLE,

    52

	CMD_BUILD_ROAD_VEH,

    53

	CMD_BUILD_SHIP,

    54

	CMD_BUILD_AIRCRAFT,

    55

};

    56

const uint32 _veh_sell_proc_table[] = {

    57

	CMD_SELL_RAIL_WAGON,

    58

	CMD_SELL_ROAD_VEH,

    59

	CMD_SELL_SHIP,

    60

	CMD_SELL_AIRCRAFT,

    61

};

    62

    63

const uint32 _veh_refit_proc_table[] = {

    64

	CMD_REFIT_RAIL_VEHICLE,

    65

	CMD_REFIT_ROAD_VEH,

    66

	CMD_REFIT_SHIP,

    67

	CMD_REFIT_AIRCRAFT,

    68

};

    69

    70

const uint32 _send_to_depot_proc_table[] = {

    71

	CMD_SEND_TRAIN_TO_DEPOT,

    72

	CMD_SEND_ROADVEH_TO_DEPOT,

    73

	CMD_SEND_SHIP_TO_DEPOT,

    74

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    75

};

    76

    77

    78

enum {

    79

	BLOCKS_FOR_SPECIAL_VEHICLES   = 2, ///< Blocks needed for special vehicles

    80

};

    81

    82

/**

    83

 * Called if a new block is added to the vehicle-pool

    84

 */

    85

static void VehiclePoolNewBlock(uint start_item)

    86

{

    87

	Vehicle *v;

    88

    89

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    90

	 * TODO - This is just a temporary stage, this will be removed. */

    91

	for (v = GetVehicle(start_item); v != NULL; v = (v->index + 1U < GetVehiclePoolSize()) ? GetVehicle(v->index + 1) : NULL) {

    92

		v->index = start_item++;

    94

	}

    95

}

    96

    97

/* Initialize the vehicle-pool */

    98

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

    99

   100

void VehicleServiceInDepot(Vehicle *v)

   101

{

   102

	v->date_of_last_service = _date;

   103

	v->breakdowns_since_last_service = 0;

   104

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

   105

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

   106

}

   107

   108

bool VehicleNeedsService(const Vehicle *v)

   109

{

   110

	if (v->vehstatus & VS_CRASHED)

   111

		return false; // Crashed vehicles don't need service anymore

   112

   113

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

   114

		return EngineHasReplacementForPlayer(GetPlayer(v->owner), v->engine_type);  /* Vehicles set for autoreplacing needs to go to a depot even if breakdowns are turned off */

   115

	}

   116

   117

	return _patches.servint_ispercent ?

   118

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

   119

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

   120

}

   121

   122

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   123

{

   124

	switch (v->type) {

   125

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   126

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   127

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   128

		default:           return STR_980E_SHIP_IN_THE_WAY;

   129

	}

   130

}

   131

   132

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

   133

{

   134

	if (v->tile != *(const TileIndex*)data || v->type == VEH_DISASTER)

   135

		return NULL;

   136

   137

	_error_message = VehicleInTheWayErrMsg(v);

   138

	return v;

   139

}

   140

   141

bool EnsureNoVehicle(TileIndex tile)

   142

{

   143

	return VehicleFromPos(tile, &tile, EnsureNoVehicleProc) == NULL;

   144

}

   145

   146

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

   147

{

   148

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

   149

   150

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

   151

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

   152

   153

	_error_message = VehicleInTheWayErrMsg(v);

   154

	return v;

   155

}

   156

   157

   158

bool EnsureNoVehicleOnGround(TileIndex tile)

   159

{

   160

	TileInfo ti;

   161

   162

	ti.tile = tile;

   163

	ti.z = GetTileMaxZ(tile);

   164

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

   165

}

   166

   167

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   168

{

   169

	TileInfo ti;

   170

   171

	ti.tile = tile;

   172

	ti.z = z;

   173

   174

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

   175

}

   176

   177

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

   178

{

   179

	int x1 = TileX(from);

   180

	int y1 = TileY(from);

   181

	int x2 = TileX(to);

   182

	int y2 = TileY(to);

   183

	Vehicle *veh;

   184

   185

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

   186

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

   187

		Swap(x1, x2);

   188

		Swap(y1, y2);

   189

	}

   190

	FOR_ALL_VEHICLES(veh) {

   191

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

   192

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

   193

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

   194

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

   195

				return veh;

   196

			}

   197

		}

   198

	}

   199

	return NULL;

   200

}

   201

   202

   203

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

   204

   205

void VehiclePositionChanged(Vehicle *v)

   206

{

   207

	int img = v->cur_image;

   208

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

   209

	const Sprite* spr = GetSprite(img);

   210

   211

	pt.x += spr->x_offs;

   212

	pt.y += spr->y_offs;

   213

   214

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

   215

   216

	v->left_coord = pt.x;

   217

	v->top_coord = pt.y;

   218

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

   219

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

   220

}

   221

   222

/** Called after load to update coordinates */

   223

void AfterLoadVehicles()

   224

{

   225

	Vehicle *v;

   226

   227

	FOR_ALL_VEHICLES(v) {

   230

		v->first = NULL;

   231

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

   232

	}

   233

   234

	FOR_ALL_VEHICLES(v) {

   235

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

   236

			TrainConsistChanged(v);

   237

	}

   238

   239

	FOR_ALL_VEHICLES(v) {

   240

		switch (v->type) {

   241

			case VEH_TRAIN: v->cur_image = GetTrainImage(v, v->direction); break;

   242

			case VEH_ROAD: v->cur_image = GetRoadVehImage(v, v->direction); break;

   243

			case VEH_SHIP: v->cur_image = GetShipImage(v, v->direction); break;

   244

			case VEH_AIRCRAFT:

   245

				if (IsNormalAircraft(v)) {

   246

					v->cur_image = GetAircraftImage(v, v->direction);

   247

   248

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

   249

					Vehicle *shadow = v->next;

   250

					shadow->cur_image = v->cur_image;

   251

   252

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

   253

					if (v->subtype == AIR_HELICOPTER) {

   254

						Vehicle *rotor = shadow->next;

   255

						rotor->cur_image = GetRotorImage(v);

   256

					}

   257

   258

					UpdateAircraftCache(v);

   259

				}

   260

				break;

   261

			default: break;

   262

		}

   263

   264

		v->left_coord = INVALID_COORD;

   265

		VehiclePositionChanged(v);

   266

	}

   267

}

   268

   269

static Vehicle *InitializeVehicle(Vehicle *v)

   270

{

   271

	VehicleID index = v->index;

   272

	memset(v, 0, sizeof(Vehicle));

   273

	v->index = index;

   274

   275

	assert(v->orders == NULL);

   276

   278

	v->left_coord = INVALID_COORD;

   279

	v->first = NULL;

   280

	v->next = NULL;

   281

	v->next_hash = NULL;

   282

	v->string_id = 0;

   283

	v->next_shared = NULL;

   284

	v->prev_shared = NULL;

   285

	v->depot_list  = NULL;

   286

	v->random_bits = 0;

   287

	return v;

   288

}

   289

   290

/**

   291

 * Get a value for a vehicle's random_bits.

   292

 * @return A random value from 0 to 255.

   293

 */

   294

byte VehicleRandomBits()

   295

{

   296

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

   297

}

   298

   299

Vehicle *ForceAllocateSpecialVehicle()

   300

{

   301

	/* This stays a strange story.. there should always be room for special

   302

	 * vehicles (special effects all over the map), but with 65k of vehicles

   303

	 * is this realistic to double-check for that? For now we just reserve

   304

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   305

	 * be used for special vehicles.. should work nicely :) */

   306

   307

	Vehicle *v;

   308

   309

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   310

	 * TODO - This is just a temporary stage, this will be removed. */

   311

	for (v = GetVehicle(0); v != NULL; v = (v->index + 1U < GetVehiclePoolSize()) ? GetVehicle(v->index + 1) : NULL) {

   312

		/* No more room for the special vehicles, return NULL */

   313

		if (v->index >= (1 << Vehicle_POOL_BLOCK_SIZE_BITS) * BLOCKS_FOR_SPECIAL_VEHICLES)

   314

			return NULL;

   315

   316

		if (!IsValidVehicle(v)) return InitializeVehicle(v);

   317

	}

   318

   319

	return NULL;

   320

}

   321

   322

/**

   323

 * finds a free vehicle in the memory or allocates a new one

   324

 * returns a pointer to the first free vehicle or NULL if all vehicles are in use

   325

 * *skip_vehicles is an offset to where in the array we should begin looking

   326

 * this is to avoid looping though the same vehicles more than once after we learned that they are not free

   327

 * this feature is used by AllocateVehicles() since it need to allocate more than one and when

   328

 * another block is added to _Vehicle_pool, since we only do that when we know it's already full

   329

 */

   330

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   331

{

   332

	/* See note by ForceAllocateSpecialVehicle() why we skip the

   333

	 * first blocks */

   334

	Vehicle *v;

   335

	const int offset = (1 << Vehicle_POOL_BLOCK_SIZE_BITS) * BLOCKS_FOR_SPECIAL_VEHICLES;

   336

   337

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   338

	 * @todo - This is just a temporary stage, this will be removed. */

   339

	if (*skip_vehicles < (_Vehicle_pool.total_items - offset)) { // make sure the offset in the array is not larger than the array itself

   340

		for (v = GetVehicle(offset + *skip_vehicles); v != NULL; v = (v->index + 1U < GetVehiclePoolSize()) ? GetVehicle(v->index + 1) : NULL) {

   341

			(*skip_vehicles)++;

   342

			if (!IsValidVehicle(v)) return InitializeVehicle(v);

   343

		}

   344

	}

   345

   346

	/* Check if we can add a block to the pool */

   347

	if (AddBlockToPool(&_Vehicle_pool))

   348

		return AllocateSingleVehicle(skip_vehicles);

   349

   350

	return NULL;

   351

}

   352

   353

   354

Vehicle *AllocateVehicle()

   355

{

   356

	VehicleID counter = 0;

   357

	return AllocateSingleVehicle(&counter);

   358

}

   359

   360

   361

/** Allocates a lot of vehicles and frees them again

   362

 * @param vl pointer to an array of vehicles to get allocated. Can be NULL if the vehicles aren't needed (makes it test only)

   363

 * @param num number of vehicles to allocate room for

   364

 * @return true if there is room to allocate all the vehicles

   365

 */

   366

bool AllocateVehicles(Vehicle **vl, int num)

   367

{

   368

	int i;

   369

	Vehicle *v;

   370

	VehicleID counter = 0;

   371

   372

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

   373

		v = AllocateSingleVehicle(&counter);

   374

		if (v == NULL) {

   375

			return false;

   376

		}

   377

		if (vl != NULL) {

   378

			vl[i] = v;

   379

		}

   380

	}

   381

   382

	return true;

   383

}

   384

   385

   386

static Vehicle *_vehicle_position_hash[0x1000];

   387

   388

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

   389

{

   390

	Point pt = RemapCoords(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, 0);

   391

   392

	/* The hash area to scan */

   393

	const int xl = GB(pt.x - 174, 7, 6);

   394

	const int xu = GB(pt.x + 104, 7, 6);

   395

	const int yl = GB(pt.y - 294, 6, 6) << 6;

   396

	const int yu = GB(pt.y +  56, 6, 6) << 6;

   397

   398

	int x;

   399

	int y;

   400

   401

	for (y = yl;; y = (y + (1 << 6)) & (0x3F << 6)) {

   402

		for (x = xl;; x = (x + 1) & 0x3F) {

   403

			Vehicle *v = _vehicle_position_hash[(x + y) & 0xFFFF];

   404

   405

			while (v != NULL) {

   406

				void* a = proc(v, data);

   407

   408

				if (a != NULL) return a;

   409

				v = v->next_hash;

   410

			}

   411

   412

			if (x == xu) break;

   413

		}

   414

   415

		if (y == yu) break;

   416

	}

   417

	return NULL;

   418

}

   419

   420

   421

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

   422

{

   423

	Vehicle **old_hash, **new_hash;

   424

	int old_x = v->left_coord;

   425

	int old_y = v->top_coord;

   426

   427

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

   428

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

   429

   430

	if (old_hash == new_hash) return;

   431

   432

	/* remove from hash table? */

   433

	if (old_hash != NULL) {

   434

		Vehicle *last = NULL;

   435

		Vehicle *u = *old_hash;

   436

		while (u != v) {

   437

			last = u;

   438

			u = u->next_hash;

   439

			assert(u != NULL);

   440

		}

   441

   442

		if (last == NULL) {

   443

			*old_hash = v->next_hash;

   444

		} else {

   445

			last->next_hash = v->next_hash;

   446

		}

   447

	}

   448

   449

	/* insert into hash table? */

   450

	if (new_hash != NULL) {

   451

		v->next_hash = *new_hash;

   452

		*new_hash = v;

   453

	}

   454

}

   455

   456

void ResetVehiclePosHash()

   457

{

   458

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

   459

}

   460

   461

void InitializeVehicles()

   462

{

   463

	uint i;

   464

   465

	/* Clean the vehicle pool, and reserve enough blocks

   466

	 *  for the special vehicles, plus one for all the other

   467

	 *  vehicles (which is increased on-the-fly) */

   468

	CleanPool(&_Vehicle_pool);

   469

	AddBlockToPool(&_Vehicle_pool);

   470

	for (i = 0; i < BLOCKS_FOR_SPECIAL_VEHICLES; i++) {

   471

		AddBlockToPool(&_Vehicle_pool);

   472

	}

   473

   474

	ResetVehiclePosHash();

   475

}

   476

   477

Vehicle *GetLastVehicleInChain(Vehicle *v)

   478

{

   479

	while (v->next != NULL) v = v->next;

   480

	return v;

   481

}

   482

   483

/** Finds the previous vehicle in a chain, by a brute force search.

   484

 * This old function is REALLY slow because it searches through all vehicles to

   485

 * find the previous vehicle, but if v->first has not been set, then this function

   486

 * will need to be used to find the previous one. This function should never be

   487

 * called by anything but GetFirstVehicleInChain

   488

 */