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());

    61

}

    62

    63

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

    64

{

    65

	const Order *o;

    66

	const Vehicle *u;

    67

    68

	if (v->type == VEH_TRAIN) {

    69

		u = v->First();

    70

	} else {

    71

		u = v;

    72

	}

    73

    74

	FOR_VEHICLE_ORDERS(u, o) {

    75

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

    76

		if (!CanRefitTo(v->engine_type, o->GetRefitCargo())) continue;

    77

		if (!CanRefitTo(engine_type, o->GetRefitCargo())) return false;

    78

	}

    79

    80

	return true;

    81

}

    82

    83

/**

    84

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

    85

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

    86

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

    87

 * @return The cargo type to replace to

    88

 *    CT_NO_REFIT is returned if no refit is needed

    89

 *    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

    90

 */

    91

static CargoID GetNewCargoTypeForReplace(Vehicle *v, EngineID engine_type)

    92

{

    93

	CargoID new_cargo_type = GetEngineCargoType(engine_type);

    94

    95

	if (new_cargo_type == CT_INVALID) return CT_NO_REFIT; // Don't try to refit an engine with no cargo capacity

    96

    97

	if (v->cargo_cap != 0 && (v->cargo_type == new_cargo_type || CanRefitTo(engine_type, v->cargo_type))) {

    98

		if (VerifyAutoreplaceRefitForOrders(v, engine_type)) {

    99

			return v->cargo_type == new_cargo_type ? (CargoID)CT_NO_REFIT : v->cargo_type;

   100

		} else {

   101

			return CT_INVALID;

   102

		}

   103

	}

   104

	if (v->type != VEH_TRAIN) return CT_INVALID; // We can't refit the vehicle to carry the cargo we want

   105

   106

	/* Below this line it's safe to assume that the vehicle in question is a train */

   107

   108

	if (v->cargo_cap != 0) return CT_INVALID; // trying to replace a vehicle with cargo capacity into another one with incompatible cargo type

   109

   110

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

   111

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

   112

	v = v->First();

   113

	do {

   114

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

   115

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

   116

		if (v->cargo_type == new_cargo_type) return CT_NO_REFIT;

   117

		if (CanRefitTo(engine_type, v->cargo_type)) return v->cargo_type;

   118

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

   119

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

   120

}

   121

   122

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

   123

 * This function is only called from MaybeReplaceVehicle()

   124

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

   125

 * @param w Vehicle to replace

   126

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

   127

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

   128

 * @param new_engine_type The EngineID to replace to

   129

 * @return value is cost of the replacement or CMD_ERROR

   130

 */

   131

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

   132

{

   133

	CommandCost cost;

   134

	CommandCost sell_value;

   135

	Vehicle *old_v = *w;

   136

	const UnitID cached_unitnumber = old_v->unitnumber;

   137

	bool new_front = false;

   138

	Vehicle *new_v = NULL;

   139

	char *vehicle_name = NULL;

   140

	CargoID replacement_cargo_type;

   141

   142

	replacement_cargo_type = GetNewCargoTypeForReplace(old_v, new_engine_type);

   143

   144

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

   145

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

   146

   147

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

   148

   149

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

   150

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

   151

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

   152

	SubtractMoneyFromPlayer(sell_value);

   153

   154

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

   155

	if (CmdFailed(cost)) {

   156

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

   157

		sell_value.MultiplyCost(-1);

   158

		SubtractMoneyFromPlayer(sell_value);

   159

		return cost;

   160

	}

   161

   162

	if (replacement_cargo_type != CT_NO_REFIT) {

   163

		/* add refit cost */

   164

		CommandCost refit_cost = GetRefitCost(new_engine_type);

   165

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

   166

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

   167

			refit_cost.AddCost(refit_cost);

   168

		}

   169

		cost.AddCost(refit_cost);

   170

	}

   171

   172

	if (flags & DC_EXEC) {

   173

		new_v = GetVehicle(_new_vehicle_id);

   174

		*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

   175

   176

		/* refit if needed */

   177

		if (replacement_cargo_type != CT_NO_REFIT) {

   178

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

   179

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

   180

				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);

   181

			}

   182

		}

   183

   184

		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()))) {

   185

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

   186

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

   187

		}

   188

   189

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

   190

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

   191

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

   192

			 * sell the old engine in a moment

   193

			 */

   194

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

   195

			Vehicle *front = old_v->Previous();

   196

			if (front == NULL) {

   197

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

   198

				Vehicle *next = old_v->Next();

   199

				if (next != NULL) {

   200

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

   201

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

   202

				}

   203

			} else {

   204

				/* 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 */

   205

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

   206

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

   207

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

   208

				/* Add the new vehicle */

   209

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

   210

				if (CmdFailed(tmp_move)) {

   211

					cost.AddCost(tmp_move);

   212

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

   213

				}

   214

			}

   215

		} else {

   216

			// copy/clone the orders

   217

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

   218

			new_v->cur_order_index = old_v->cur_order_index;

   219

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

   220

			new_v->profit_this_year = old_v->profit_this_year;

   221

			new_v->profit_last_year = old_v->profit_last_year;

   222

			new_v->service_interval = old_v->service_interval;

   223

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

   224

			new_front = true;

   225

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

   226

			new_v->dest_tile  = old_v->dest_tile;

   227

   228

			new_v->current_order = old_v->current_order;

   229

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

   230

				Vehicle *temp_v = GetNextVehicle(old_v);

   231

   232

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

   233

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

   234

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

   235

					temp_v = GetNextVehicle(temp_v);

   236

				}

   237

   238

				if (temp_v != NULL) {

   239

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

   240

					if (CmdFailed(tmp_move)) {

   241

						cost.AddCost(tmp_move);

   242

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

   243

					}

   244

				}

   245

			}

   246

		}

   247

		if (CmdSucceeded(cost)) {

   248

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

   249

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

   250

   251

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

   252

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

   253

		}

   254

	} else { // flags & DC_EXEC not set

   255

		CommandCost tmp_move;

   256

   257

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

   258

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

   259

			if (next_veh != NULL) {

   260

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

   261

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

   262

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

   263

				Vehicle *temp = GetVehicle(_new_vehicle_id);

   264

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

   265

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

   266

			}

   267

		}

   268

   269

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

   270

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

   271

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

   272

			/* Pay back the loan */

   273

			sell_value.MultiplyCost(-1);

   274

			SubtractMoneyFromPlayer(sell_value);

   275

			return CMD_ERROR;

   276

		}

   277

	}

   278

   279

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

   280

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

   281

	sell_value.MultiplyCost(-1);

   282

	SubtractMoneyFromPlayer(sell_value);

   283

   284

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

   285

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

   286

   287

	if (CmdFailed(cost)) return cost;

   288

   289

	if (new_front) {

   290

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

   291

		new_v->unitnumber = cached_unitnumber;

   292

	}

   293

   294

	/* Transfer the name of the old vehicle */

   295

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

   296

		_cmd_text = vehicle_name;

   297

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

   298

		free(vehicle_name);

   299

	}

   300

   301

	return cost;

   302

}

   303

   304

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

   305

 * @param v The vehicle

   306

 * @param old_total_length The wanted max length

   307

 * @return The profit from selling the wagons

   308

 */

   309

static CommandCost WagonRemoval(Vehicle *v, uint16 old_total_length)

   310

{

   311

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

   312

	Vehicle *front = v;

   313

   314

	CommandCost cost = CommandCost();

   315

   316

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

   317

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

   318

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

   319

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

   320

			v = GetNextVehicle(v);

   321

		}

   322

   323

		if (v == NULL) {

   324

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

   325

			SetDParam(0, front->unitnumber);

   326

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

   327

			return cost;

   328

		}

   329

   330

		/* We found a wagon we can sell */

   331

		Vehicle *temp = v;

   332

		v = GetNextVehicle(v);

   333

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

   334

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

   335

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

   336

	}

   337

	return cost;

   338

}

   339

   340

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

   341

 * @param v The vehicle to find a replacement for

   342

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

   343

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

   344

 */

   345

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

   346

{

   347

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

   348

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

   349

		return INVALID_ENGINE;

   350

	}

   351

   352

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

   353

   354

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

   355

		return e;

   356

	}

   357

   358

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

   359

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

   360

		return v->engine_type;

   361

	}

   362

   363

	return INVALID_ENGINE;

   364

}

   365

   366

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

   367

 * (used to be called autorenew)

   368

 * @param v The vehicle to replace

   369

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

   370

 * @param flags

   371

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

   372

 *        This bool also takes autorenew money into consideration

   373

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

   374

 */

   375

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

   376

{

   377

	Vehicle *w;

   378

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

   379

	CommandCost cost;

   380

	bool stopped = false;

   381

	BackuppedVehicle backup(true);

   382

   383

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

   384

	assert(IsPlayerBuildableVehicleType(v));

   385

   386

	/* Ensure that this bool is cleared. */

   387

	assert(!v->leave_depot_instantly);

   388

   389

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

   390

	assert(v->owner == _current_player);

   391

   392

	if (!v->IsInDepot()) {

   393

		/* The vehicle should be inside the depot */

   394

		switch (v->type) {

   395

			default: NOT_REACHED();

   396

			case VEH_TRAIN:    return_cmd_error(STR_881A_TRAINS_CAN_ONLY_BE_ALTERED); break;

   397

			case VEH_ROAD:     return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);     break;

   398

			case VEH_SHIP:     return_cmd_error(STR_980B_SHIP_MUST_BE_STOPPED_IN);    break;

   399

			case VEH_AIRCRAFT: return_cmd_error(STR_A01B_AIRCRAFT_MUST_BE_STOPPED);   break;

   400

		}

   401

	}

   402

   403

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

   404

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

   405

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

   406

	 * Useful when newGRF uses custom length */

   407

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

   408

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

   409

		-1

   410

	);

   411

   412

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

   413

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

   414

		v->vehstatus |= VS_STOPPED;

   415

		/* Remember that we stopped the vehicle */

   416

		stopped = true;

   417

	}

   418

   419

	{

   420

		cost = CommandCost(EXPENSES_NEW_VEHICLES);

   421

		w = v;

   422

		do {

   423

			EngineID new_engine = GetNewEngineType(w, p);

   424

			if (new_engine == INVALID_ENGINE) continue;

   425

   426

			if (!backup.ContainsBackup()) {

   427

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

   428

				backup.Backup(v, p);

   429

			}

   430

			/* Now replace the vehicle.

   431

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

   432

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

   433

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

   434

   435

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

   436

   437

			if (IsFront) {

   438

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

   439

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

   440

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

   441

				 */

   442

				v = w;

   443

			}

   444

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

   445

   446

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

   447

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

   448

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

   449

		}

   450

   451

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

   452

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

   453

			v = backup.Restore(v, p);

   454

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

   455

			return cost;

   456

		}

   457

   458

		if (display_costs) {

   459

			/* We want to ensure that we will not get below p->engine_renew_money.

   460

			 * We will not actually pay this amount. It's for display and checks only. */

   461

			CommandCost tmp = cost;

   462

			tmp.AddCost((Money)p->engine_renew_money);

   463

			if (CmdSucceeded(tmp) && GetAvailableMoneyForCommand() < tmp.GetCost()) {

   464

				/* We don't have enough money so we will set cost to failed */

   465

				cost.AddCost((Money)p->engine_renew_money);

   466

				cost.AddCost(CMD_ERROR);

   467

			}

   468

		}

   469

   470

		if (display_costs && CmdFailed(cost)) {

   471

			if (GetAvailableMoneyForCommand() < cost.GetCost() && IsLocalPlayer()) {

   472

				StringID message;

   473

				SetDParam(0, v->unitnumber);

   474

				switch (v->type) {

   475

					case VEH_TRAIN:    message = STR_TRAIN_AUTORENEW_FAILED;       break;

   476

					case VEH_ROAD:     message = STR_ROADVEHICLE_AUTORENEW_FAILED; break;

   477

					case VEH_SHIP:     message = STR_SHIP_AUTORENEW_FAILED;        break;

   478

					case VEH_AIRCRAFT: message = STR_AIRCRAFT_AUTORENEW_FAILED;    break;

   479

						// This should never happen

   480

					default: NOT_REACHED(); message = 0; break;

   481

				}

   482

   483

				AddNewsItem(message, NS_ADVICE, v->index, 0);

   484