1

/* $Id$ */

     2

     3

/** @file autoreplace_cmd.cpp Deals with autoreplace execution but not the setup */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "roadveh.h"

     8

#include "ship.h"

     9

#include "news_func.h"

    10

#include "player_func.h"

    11

#include "debug.h"

    12

#include "vehicle_gui.h"

    13

#include "train.h"

    14

#include "aircraft.h"

    15

#include "cargotype.h"

    16

#include "group.h"

    17

#include "strings_func.h"

    18

#include "command_func.h"

    19

#include "vehicle_func.h"

    20

#include "functions.h"

    21

#include "variables.h"

    22

#include "autoreplace_func.h"

    23

#include "articulated_vehicles.h"

    24

    25

#include "table/strings.h"

    26

    27

    28

/*

    29

 * move the cargo from one engine to another if possible

    30

 */

    31

static void MoveVehicleCargo(Vehicle *dest, Vehicle *source)

    32

{

    33

	Vehicle *v = dest;

    34

    35

	do {

    36

		do {

    37

			if (source->cargo_type != dest->cargo_type)

    38

				continue; // cargo not compatible

    39

    40

			if (dest->cargo.Count() == dest->cargo_cap)

    41

				continue; // the destination vehicle is already full

    42

    43

			uint units_moved = min(source->cargo.Count(), dest->cargo_cap - dest->cargo.Count());

    44

			source->cargo.MoveTo(&dest->cargo, units_moved);

    45

    46

			// copy the age of the cargo

    47

			dest->day_counter  = source->day_counter;

    48

			dest->tick_counter = source->tick_counter;

    49

    50

		} while (source->cargo.Count() > 0 && (dest = dest->Next()) != NULL);

    51

		dest = v;

    52

	} while ((source = source->Next()) != NULL);

    53

    54

	/*

    55

	 * The of the train will be incorrect at this moment. This is due

    56

	 * to the fact that removing the old wagon updates the weight of

    57

	 * the complete train, which is without the weight of cargo we just

    58

	 * moved back into some (of the) new wagon(s).

    59

	 */

    60

	if (dest->type == VEH_TRAIN) TrainConsistChanged(dest->First(), true);

    61

}

    62

    63

    64

/**

    65

 * Tests whether refit orders that applied to v will also apply to the new vehicle type

    66

 * @param v The vehicle to be replaced

    67

 * @param engine_type The type we want to replace with

    68

 * @return true iff all refit orders stay valid

    69

 */

    70

static bool VerifyAutoreplaceRefitForOrders(const Vehicle *v, EngineID engine_type)

    71

{

    72

	const Order *o;

    73

	const Vehicle *u;

    74

    75

	uint32 union_refit_mask_a = GetUnionOfArticulatedRefitMasks(v->engine_type, v->type, false);

    76

	uint32 union_refit_mask_b = GetUnionOfArticulatedRefitMasks(engine_type, v->type, false);

    77

    78

	if (v->type == VEH_TRAIN) {

    79

		u = v->First();

    80

	} else {

    81

		u = v;

    82

	}

    83

    84

	FOR_VEHICLE_ORDERS(u, o) {

    85

		if (!o->IsRefit()) continue;

    86

		CargoID cargo_type = o->GetRefitCargo();

    87

    88

		if (!HasBit(union_refit_mask_a, cargo_type)) continue;

    89

		if (!HasBit(union_refit_mask_b, cargo_type)) return false;

    90

	}

    91

    92

	return true;

    93

}

    94

    95

/**

    96

 * Function to find what type of cargo to refit to when autoreplacing

    97

 * @param *v Original vehicle, that is being replaced

    98

 * @param engine_type The EngineID of the vehicle that is being replaced to

    99

 * @return The cargo type to replace to

   100

 *    CT_NO_REFIT is returned if no refit is needed

   101

 *    CT_INVALID is returned when both old and new vehicle got cargo capacity and refitting the new one to the old one's cargo type isn't possible

   102

 */

   103

static CargoID GetNewCargoTypeForReplace(Vehicle *v, EngineID engine_type)

   104

{

   105

	CargoID cargo_type;

   106

   107

	if (GetUnionOfArticulatedRefitMasks(engine_type, v->type, true) == 0) return CT_NO_REFIT; // Don't try to refit an engine with no cargo capacity

   108

   109

	if (IsArticulatedVehicleCarryingDifferentCargos(v, &cargo_type)) return CT_INVALID; // We cannot refit to mixed cargos in an automated way

   110

   111

	uint32 available_cargo_types = GetIntersectionOfArticulatedRefitMasks(engine_type, v->type, true);

   112

   113

	if (cargo_type == CT_INVALID) {

   114

		if (v->type != VEH_TRAIN) return CT_NO_REFIT; // If the vehicle does not carry anything at all, every replacement is fine.

   115

   116

		/* the old engine didn't have cargo capacity, but the new one does

   117

		 * now we will figure out what cargo the train is carrying and refit to fit this */

   118

   119

		for (v = v->First(); v != NULL; v = v->Next()) {

   120

			if (v->cargo_cap == 0) continue;

   121

			/* Now we found a cargo type being carried on the train and we will see if it is possible to carry to this one */

   122

			if (HasBit(available_cargo_types, v->cargo_type)) {

   123

				/* Do we have to refit the vehicle, or is it already carrying the right cargo? */

   124

				uint16 *default_capacity = GetCapacityOfArticulatedParts(engine_type, v->type);

   125

				for (CargoID cid = 0; cid < NUM_CARGO; cid++) {

   126

					if (cid != cargo_type && default_capacity[cid] > 0) return cargo_type;

   127

				}

   128

   129

				return CT_NO_REFIT;

   130

			}

   131

		}

   132

   133

		return CT_NO_REFIT; // We failed to find a cargo type on the old vehicle and we will not refit the new one

   134

	} else {

   135

		if (!HasBit(available_cargo_types, cargo_type)) return CT_INVALID; // We can't refit the vehicle to carry the cargo we want

   136

   137

		if (!VerifyAutoreplaceRefitForOrders(v, engine_type)) return CT_INVALID; // Some refit orders loose their effect

   138

   139

		/* Do we have to refit the vehicle, or is it already carrying the right cargo? */

   140

		uint16 *default_capacity = GetCapacityOfArticulatedParts(engine_type, v->type);

   141

		for (CargoID cid = 0; cid < NUM_CARGO; cid++) {

   142

			if (cid != cargo_type && default_capacity[cid] > 0) return cargo_type;

   143

		}

   144

   145

		return CT_NO_REFIT;

   146

	}

   147

}

   148

   149

/** Replaces a vehicle (used to be called autorenew)

   150

 * This function is only called from MaybeReplaceVehicle()

   151

 * Must be called with _current_player set to the owner of the vehicle

   152

 * @param w Vehicle to replace

   153

 * @param flags is the flags to use when calling DoCommand(). Mainly DC_EXEC counts

   154

 * @param p The vehicle owner (faster than refinding the pointer)

   155

 * @param new_engine_type The EngineID to replace to

   156

 * @return value is cost of the replacement or CMD_ERROR

   157

 */

   158

static CommandCost ReplaceVehicle(Vehicle **w, uint32 flags, Money total_cost, const Player *p, EngineID new_engine_type)

   159

{

   160

	CommandCost cost;

   161

	CommandCost sell_value;

   162

	Vehicle *old_v = *w;

   163

	const UnitID cached_unitnumber = old_v->unitnumber;

   164

	bool new_front = false;

   165

	Vehicle *new_v = NULL;

   166

	char *vehicle_name = NULL;

   167

	CargoID replacement_cargo_type;

   168

   169

	replacement_cargo_type = GetNewCargoTypeForReplace(old_v, new_engine_type);

   170

   171

	/* check if we can't refit to the needed type, so no replace takes place to prevent the vehicle from altering cargo type */

   172

	if (replacement_cargo_type == CT_INVALID) return CommandCost();

   173

   174

	sell_value = DoCommand(0, old_v->index, 0, DC_QUERY_COST, GetCmdSellVeh(old_v));

   175

   176

	/* We give the player a loan of the same amount as the sell value.

   177

	 * This is needed in case he needs the income from the sale to build the new vehicle.

   178

	 * We take it back if building fails or when we really sell the old engine */

   179

	SubtractMoneyFromPlayer(sell_value);

   180

   181

	cost = DoCommand(old_v->tile, new_engine_type, 0, flags | DC_AUTOREPLACE, GetCmdBuildVeh(old_v));

   182

	if (CmdFailed(cost)) {

   183

		/* Take back the money we just gave the player */

   184

		sell_value.MultiplyCost(-1);

   185

		SubtractMoneyFromPlayer(sell_value);

   186

		return cost;

   187

	}

   188

   189

	if (replacement_cargo_type != CT_NO_REFIT) {

   190

		/* add refit cost */

   191

		CommandCost refit_cost = GetRefitCost(new_engine_type);

   192

		if (old_v->type == VEH_TRAIN && RailVehInfo(new_engine_type)->railveh_type == RAILVEH_MULTIHEAD) {

   193

			/* Since it's a dualheaded engine we have to pay once more because the rear end is being refitted too. */

   194

			refit_cost.AddCost(refit_cost);

   195

		}

   196

		cost.AddCost(refit_cost);

   197

	}

   198

   199

	if (flags & DC_EXEC) {

   200

		new_v = GetVehicle(_new_vehicle_id);

   201

		*w = new_v; //we changed the vehicle, so MaybeReplaceVehicle needs to work on the new one. Now we tell it what the new one is

   202

   203

		/* refit if needed */

   204

		if (replacement_cargo_type != CT_NO_REFIT) {

   205

			if (CmdFailed(DoCommand(0, new_v->index, replacement_cargo_type, DC_EXEC, GetCmdRefitVeh(new_v)))) {

   206

				/* Being here shows a failure, which most likely is in GetNewCargoTypeForReplace() or incorrect estimation costs */

   207

				error("Autoreplace failed to refit. Replace engine %d to %d and refit to cargo %d", old_v->engine_type, new_v->engine_type, replacement_cargo_type);

   208

			}

   209

		}

   210

   211

		if (new_v->type == VEH_TRAIN && HasBit(old_v->u.rail.flags, VRF_REVERSE_DIRECTION) && !IsMultiheaded(new_v) && !(new_v->Next() != NULL && IsArticulatedPart(new_v->Next()))) {

   212

			// we are autorenewing to a single engine, so we will turn it as the old one was turned as well

   213

			SetBit(new_v->u.rail.flags, VRF_REVERSE_DIRECTION);

   214

		}

   215

   216

		if (old_v->type == VEH_TRAIN && !IsFrontEngine(old_v)) {

   217

			/* this is a railcar. We need to move the car into the train

   218

			 * We add the new engine after the old one instead of replacing it. It will give the same result anyway when we

   219

			 * sell the old engine in a moment

   220

			 */

   221

			/* Get the vehicle in front of the one we move out */

   222

			Vehicle *front = old_v->Previous();

   223

			if (front == NULL) {

   224

				/* It would appear that we have the front wagon of a row of wagons without engines */

   225

				Vehicle *next = old_v->Next();

   226

				if (next != NULL) {

   227

					/* Move the chain to the new front wagon */

   228

					DoCommand(0, (new_v->index << 16) | next->index, 1, DC_EXEC, CMD_MOVE_RAIL_VEHICLE);

   229

				}

   230

			} else {

   231

				/* If the vehicle in front is the rear end of a dualheaded engine, then we need to use the one in front of that one */

   232

				if (IsRearDualheaded(front)) front = front->Previous();

   233

				/* Now we move the old one out of the train */

   234

				DoCommand(0, (INVALID_VEHICLE << 16) | old_v->index, 0, DC_EXEC, CMD_MOVE_RAIL_VEHICLE);

   235

				/* Add the new vehicle */

   236

				CommandCost tmp_move = DoCommand(0, (front->index << 16) | new_v->index, 1, DC_EXEC, CMD_MOVE_RAIL_VEHICLE);

   237

				if (CmdFailed(tmp_move)) {

   238

					cost.AddCost(tmp_move);

   239

					DoCommand(0, new_v->index, 1, DC_EXEC, GetCmdSellVeh(VEH_TRAIN));

   240

				}

   241

			}

   242

		} else {

   243

			// copy/clone the orders

   244

			DoCommand(0, (old_v->index << 16) | new_v->index, old_v->IsOrderListShared() ? CO_SHARE : CO_COPY, DC_EXEC, CMD_CLONE_ORDER);

   245

			new_v->cur_order_index = old_v->cur_order_index;

   246

			ChangeVehicleViewWindow(old_v->index, new_v->index);

   247

			new_v->profit_this_year = old_v->profit_this_year;

   248

			new_v->profit_last_year = old_v->profit_last_year;

   249

			new_v->service_interval = old_v->service_interval;

   250

			DoCommand(0, old_v->group_id, new_v->index, flags, CMD_ADD_VEHICLE_GROUP);

   251

			new_front = true;

   252

			new_v->unitnumber = old_v->unitnumber; // use the same unit number

   253

			new_v->dest_tile  = old_v->dest_tile;

   254

   255

			new_v->current_order = old_v->current_order;

   256

			if (old_v->type == VEH_TRAIN && GetNextVehicle(old_v) != NULL){

   257

				Vehicle *temp_v = GetNextVehicle(old_v);

   258

   259

				// move the entire train to the new engine, excluding the old engine

   260

				if (IsMultiheaded(old_v) && temp_v == old_v->u.rail.other_multiheaded_part) {

   261

					// we got front and rear of a multiheaded engine right after each other. We should work with the next in line instead

   262

					temp_v = GetNextVehicle(temp_v);

   263

				}

   264

   265

				if (temp_v != NULL) {

   266

					CommandCost tmp_move = DoCommand(0, (new_v->index << 16) | temp_v->index, 1, DC_EXEC, CMD_MOVE_RAIL_VEHICLE);

   267

					if (CmdFailed(tmp_move)) {

   268

						cost.AddCost(tmp_move);

   269

						DoCommand(0, temp_v->index, 1, DC_EXEC, GetCmdSellVeh(VEH_TRAIN));

   270

					}

   271

				}

   272

			}

   273

		}

   274

		if (CmdSucceeded(cost)) {

   275

			/* We are done setting up the new vehicle. Now we move the cargo from the old one to the new one */

   276

			MoveVehicleCargo(new_v->type == VEH_TRAIN ? new_v->First() : new_v, old_v);

   277

   278

			/* Get the name of the old vehicle if it has a custom name. */

   279

			if (old_v->name != NULL) vehicle_name = strdup(old_v->name);

   280

		}

   281

	} else { // flags & DC_EXEC not set

   282

		CommandCost tmp_move;

   283

   284

		if (old_v->type == VEH_TRAIN && IsFrontEngine(old_v)) {

   285

			Vehicle *next_veh = GetNextUnit(old_v); // don't try to move the rear multiheaded engine or articulated parts

   286

			if (next_veh != NULL) {

   287

				/* Verify that the wagons can be placed on the engine in question.

   288

				 * This is done by building an engine, test if the wagons can be added and then sell the test engine. */

   289

				DoCommand(old_v->tile, new_engine_type, 0, DC_EXEC | DC_AUTOREPLACE, GetCmdBuildVeh(old_v));

   290

				Vehicle *temp = GetVehicle(_new_vehicle_id);

   291

				tmp_move = DoCommand(0, (temp->index << 16) | next_veh->index, 1, 0, CMD_MOVE_RAIL_VEHICLE);

   292

				DoCommand(0, temp->index, 0, DC_EXEC, GetCmdSellVeh(old_v));

   293

			}

   294

		}

   295

   296

		/* Ensure that the player will not end up having negative money while autoreplacing

   297

		 * This is needed because the only other check is done after the income from selling the old vehicle is substracted from the cost */

   298

		if (CmdFailed(tmp_move) || p->player_money < (cost.GetCost() + total_cost)) {

   299

			/* Pay back the loan */

   300

			sell_value.MultiplyCost(-1);

   301

			SubtractMoneyFromPlayer(sell_value);

   302

			return CMD_ERROR;

   303

		}

   304

	}

   305

   306

	/* Take back the money we just gave the player just before building the vehicle

   307

	 * The player will get the same amount now that the sale actually takes place */

   308

	sell_value.MultiplyCost(-1);

   309

	SubtractMoneyFromPlayer(sell_value);

   310

   311

	/* sell the engine/ find out how much you get for the old engine (income is returned as negative cost) */

   312

	cost.AddCost(DoCommand(0, old_v->index, 0, flags, GetCmdSellVeh(old_v)));

   313

   314

	if (CmdFailed(cost)) return cost;

   315

   316

	if (new_front) {

   317

		/* now we assign the old unitnumber to the new vehicle */

   318

		new_v->unitnumber = cached_unitnumber;

   319

	}

   320

   321

	/* Transfer the name of the old vehicle */

   322

	if ((flags & DC_EXEC) && vehicle_name != NULL) {

   323

		_cmd_text = vehicle_name;

   324

		DoCommand(0, new_v->index, 0, DC_EXEC, CMD_NAME_VEHICLE);

   325

		free(vehicle_name);

   326

	}

   327

   328

	return cost;

   329

}

   330

   331

/** Removes wagons from a train until it get a certain length

   332

 * @param v The vehicle

   333

 * @param old_total_length The wanted max length

   334

 * @return The profit from selling the wagons

   335

 */

   336

static CommandCost WagonRemoval(Vehicle *v, uint16 old_total_length)

   337

{

   338

	if (v->type != VEH_TRAIN) return CommandCost();

   339

	Vehicle *front = v;

   340

   341

	CommandCost cost = CommandCost();

   342

   343

	while (front->u.rail.cached_total_length > old_total_length) {

   344

		/* the train is too long. We will remove cars one by one from the start of the train until it's short enough */

   345

		while (v != NULL && RailVehInfo(v->engine_type)->railveh_type != RAILVEH_WAGON) {

   346

			/* We move backwards in the train until we find a wagon */

   347

			v = GetNextVehicle(v);

   348

		}

   349

   350

		if (v == NULL) {

   351

			/* We sold all the wagons and the train is still not short enough */

   352

			SetDParam(0, front->unitnumber);

   353

			AddNewsItem(STR_TRAIN_TOO_LONG_AFTER_REPLACEMENT, NS_ADVICE, front->index, 0);

   354

			return cost;

   355

		}

   356

   357

		/* We found a wagon we can sell */

   358

		Vehicle *temp = v;

   359

		v = GetNextVehicle(v);

   360

		DoCommand(0, (INVALID_VEHICLE << 16) | temp->index, 0, DC_EXEC, CMD_MOVE_RAIL_VEHICLE); // remove the wagon from the train

   361

		MoveVehicleCargo(front, temp); // move the cargo back on the train

   362

		cost.AddCost(DoCommand(0, temp->index, 0, DC_EXEC, CMD_SELL_RAIL_WAGON)); // sell the wagon

   363

	}

   364

	return cost;

   365

}

   366

   367

/** Get the EngineID of the replacement for a vehicle

   368

 * @param v The vehicle to find a replacement for

   369

 * @param p The vehicle's owner (it's faster to forward the pointer than refinding it)

   370

 * @return the EngineID of the replacement. INVALID_ENGINE if no buildable replacement is found

   371

 */

   372

static EngineID GetNewEngineType(const Vehicle *v, const Player *p)

   373

{

   374

	assert(v->type != VEH_TRAIN || !IsArticulatedPart(v));

   375

   376

	if (v->type == VEH_TRAIN && IsRearDualheaded(v)) {

   377

		/* we build the rear ends of multiheaded trains with the front ones */

   378

		return INVALID_ENGINE;

   379

	}

   380

   381

	EngineID e = EngineReplacementForPlayer(p, v->engine_type, v->group_id);

   382

   383

	if (e != INVALID_ENGINE && IsEngineBuildable(e, v->type, _current_player)) {

   384

		return e;

   385

	}

   386

   387

	if (v->NeedsAutorenewing(p) && // replace if engine is too old

   388

	    IsEngineBuildable(v->engine_type, v->type, _current_player)) { // engine can still be build

   389

		return v->engine_type;

   390

	}

   391

   392

	return INVALID_ENGINE;

   393

}

   394

   395

/** replaces a vehicle if it's set for autoreplace or is too old

   396

 * (used to be called autorenew)

   397

 * @param v The vehicle to replace

   398

 * if the vehicle is a train, v needs to be the front engine

   399

 * @param flags

   400

 * @param display_costs If set, a cost animation is shown (only if DC_EXEC is set)

   401

 *        This bool also takes autorenew money into consideration

   402

 * @return the costs, the success bool and sometimes an error message

   403

 */

   404

CommandCost MaybeReplaceVehicle(Vehicle *v, uint32 flags, bool display_costs)

   405

{

   406

	Vehicle *w;

   407

	Player *p = GetPlayer(v->owner);

   408

	CommandCost cost;

   409

	bool stopped = false;

   410

	BackuppedVehicle backup(true);

   411

   412

	/* We only want "real" vehicle types. */

   413

	assert(IsPlayerBuildableVehicleType(v));

   414

   415

	/* Ensure that this bool is cleared. */

   416

	assert(!v->leave_depot_instantly);

   417

   418

	/* We can't sell if the current player don't own the vehicle. */

   419

	assert(v->owner == _current_player);

   420

   421

	if (!v->IsInDepot()) {

   422

		/* The vehicle should be inside the depot */

   423

		switch (v->type) {

   424

			default: NOT_REACHED();

   425

			case VEH_TRAIN:    return_cmd_error(STR_881A_TRAINS_CAN_ONLY_BE_ALTERED); break;

   426

			case VEH_ROAD:     return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);     break;

   427

			case VEH_SHIP:     return_cmd_error(STR_980B_SHIP_MUST_BE_STOPPED_IN);    break;

   428

			case VEH_AIRCRAFT: return_cmd_error(STR_A01B_AIRCRAFT_MUST_BE_STOPPED);   break;

   429

		}

   430

	}

   431

   432

	/* Remember the length in case we need to trim train later on

   433

	 * If it's not a train, the value is unused

   434

	 * round up to the length of the tiles used for the train instead of the train length instead

   435

	 * Useful when newGRF uses custom length */

   436

	uint16 old_total_length = (v->type == VEH_TRAIN ?

   437

		(v->u.rail.cached_total_length + TILE_SIZE - 1) / TILE_SIZE * TILE_SIZE :

   438

		-1

   439

	);

   440

   441

	if (!(v->vehstatus & VS_STOPPED)) {

   442

		/* The vehicle is moving so we better stop it before we might alter consist or sell it */

   443

		v->vehstatus |= VS_STOPPED;

   444

		/* Remember that we stopped the vehicle */

   445

		stopped = true;

   446

	}

   447

   448

	{

   449

		cost = CommandCost(EXPENSES_NEW_VEHICLES);

   450

		w = v;

   451

		do {

   452

			EngineID new_engine = GetNewEngineType(w, p);

   453

			if (new_engine == INVALID_ENGINE) continue;

   454

   455

			if (!backup.ContainsBackup()) {

   456

				/* We are going to try to replace a vehicle but we don't have any backup so we will make one. */

   457

				backup.Backup(v, p);

   458

			}

   459

			/* Now replace the vehicle.

   460

			 * First we need to cache if it's the front vehicle as we need to update the v pointer if it is.

   461

			 * If the replacement fails then we can't trust the data in the vehicle hence the reason to cache the result. */

   462

			bool IsFront = w->type != VEH_TRAIN || w->u.rail.first_engine == INVALID_ENGINE;

   463

   464

			cost.AddCost(ReplaceVehicle(&w, DC_EXEC, cost.GetCost(), p, new_engine));

   465

   466

			if (IsFront) {

   467

				/* now we bought a new engine and sold the old one. We need to fix the

   468

				 * pointers in order to avoid pointing to the old one for trains: these

   469

				 * pointers should point to the front engine and not the cars

   470

				 */

   471

				v = w;

   472

			}

   473

		} while (CmdSucceeded(cost) && w->type == VEH_TRAIN && (w = GetNextVehicle(w)) != NULL);

   474

   475

		if (CmdSucceeded(cost) && v->type == VEH_TRAIN && p->renew_keep_length) {

   476

			/* Remove wagons until the wanted length is reached */

   477

			cost.AddCost(WagonRemoval(v, old_total_length));

   478

		}

   479

   480

		if (flags & DC_QUERY_COST || cost.GetCost() == 0) {

   481

			/* We didn't do anything during the replace so we will just exit here */

   482

			v = backup.Restore(v, p);

   483

			if (stopped) v->vehstatus &= ~VS_STOPPED;

   484

			return cost;