1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "roadveh.h"

     6

#include "ship.h"

     7

#include "table/strings.h"

     8

#include "functions.h"

     9

#include "news.h"

    10

#include "command.h"

    11

#include "player.h"

    12

#include "engine.h"

    13

#include "debug.h"

    14

#include "vehicle_gui.h"

    15

#include "depot.h"

    16

#include "train.h"

    17

#include "aircraft.h"

    18

#include "cargotype.h"

    19

#include "group.h"

    20

#include "strings.h"

    21

    22

    23

/*

    24

 * move the cargo from one engine to another if possible

    25

 */

    26

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

    27

{

    28

	Vehicle *v = dest;

    29

    30

	do {

    31

		do {

    32

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

    33

				continue; // cargo not compatible

    34

    35

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

    36

				continue; // the destination vehicle is already full

    37

    38

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

    39

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

    40

    41

			// copy the age of the cargo

    42

			dest->day_counter  = source->day_counter;

    43

			dest->tick_counter = source->tick_counter;

    44

    45

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

    46

		dest = v;

    47

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

    48

    49

	/*

    50

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

    51

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

    52

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

    53

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

    54

	 */

    55

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

    56

}

    57

    58

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

    59

{

    60

	const Order *o;

    61

	const Vehicle *u;

    62

    63

	if (v->type == VEH_TRAIN) {

    64

		u = v->First();

    65

	} else {

    66

		u = v;

    67

	}

    68

    69

	FOR_VEHICLE_ORDERS(u, o) {

    70

		if (!(o->refit_cargo < NUM_CARGO)) continue;

    71

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

    72

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

    73

	}

    74

    75

	return true;

    76

}

    77

    78

/**

    79

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

    80

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

    81

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

    82

 * @return The cargo type to replace to

    83

 *    CT_NO_REFIT is returned if no refit is needed

    84

 *    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

    85

 */

    86

static CargoID GetNewCargoTypeForReplace(Vehicle *v, EngineID engine_type)

    87

{

    88

	CargoID new_cargo_type = GetEngineCargoType(engine_type);

    89

    90

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

    91

    92

	if (v->cargo_type == new_cargo_type || CanRefitTo(engine_type, v->cargo_type)) {

    93

		if (VerifyAutoreplaceRefitForOrders(v, engine_type)) {

    94

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

    95

		} else {

    96

			return CT_INVALID;

    97

		}

    98

	}

    99

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

   100

   101

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

   102

   103

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

   104

   105

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

   106

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

   107

	v = v->First();

   108

	do {

   109

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

   110

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

   111

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

   112

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

   113

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

   114

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

   115

}

   116

   117

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

   118

 * This function is only called from MaybeReplaceVehicle()

   119

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

   120

 * @param w Vehicle to replace

   121

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

   122

 * @return value is cost of the replacement or CMD_ERROR

   123

 */

   124

static CommandCost ReplaceVehicle(Vehicle **w, byte flags, Money total_cost)

   125

{

   126

	CommandCost cost;

   127

	CommandCost sell_value;

   128

	Vehicle *old_v = *w;

   129

	const Player *p = GetPlayer(old_v->owner);

   130

	EngineID new_engine_type;

   131

	const UnitID cached_unitnumber = old_v->unitnumber;

   132

	bool new_front = false;

   133

	Vehicle *new_v = NULL;

   134

	char vehicle_name[32];

   135

	CargoID replacement_cargo_type;

   136

   137

	/* If the vehicle belongs to a group, check if the group is protected from the global autoreplace.

   138

	 *  If not, chek if an global auto replacement is defined */

   139

	new_engine_type = (IsValidGroupID(old_v->group_id) && GetGroup(old_v->group_id)->replace_protection) ?

   140

			INVALID_ENGINE :

   141

			EngineReplacementForPlayer(p, old_v->engine_type, ALL_GROUP);

   142

   143

	/* If we don't set new_egnine_type previously, we try to check if an autoreplacement was defined

   144

	 *  for the group and the engine_type of the vehicle */

   145

	if (new_engine_type == INVALID_ENGINE && !IsAllGroupID(old_v->group_id)) {

   146

		new_engine_type = EngineReplacementForPlayer(p, old_v->engine_type, old_v->group_id);

   147

	}

   148

   149

	if (new_engine_type == INVALID_ENGINE) new_engine_type = old_v->engine_type;

   150

   151

	replacement_cargo_type = GetNewCargoTypeForReplace(old_v, new_engine_type);

   152

   153

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

   154

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

   155

   156

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

   157

   158

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

   159

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

   160

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

   161

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   162

	SubtractMoneyFromPlayer(sell_value);

   163

   164

	cost = DoCommand(old_v->tile, new_engine_type, 3, flags, GetCmdBuildVeh(old_v));

   165

	if (CmdFailed(cost)) {

   166

		SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   167

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

   168

		sell_value.MultiplyCost(-1);

   169

		SubtractMoneyFromPlayer(sell_value);

   170

		return cost;

   171

	}

   172

   173

	if (replacement_cargo_type != CT_NO_REFIT) {

   174

		/* add refit cost */

   175

		CommandCost refit_cost = GetRefitCost(new_engine_type);

   176

		if (old_v->type == VEH_TRAIN && IsMultiheaded(old_v)) refit_cost.AddCost(refit_cost); // pay for both ends

   177

		cost.AddCost(refit_cost);

   178

	}

   179

   180

	if (flags & DC_EXEC) {

   181

		new_v = GetVehicle(_new_vehicle_id);

   182

		*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

   183

   184

		/* refit if needed */

   185

		if (replacement_cargo_type != CT_NO_REFIT) {

   186

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

   187

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

   188

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

   189

			}

   190

		}

   191

   192

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

   193

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

   195

		}

   196

   197

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

   198

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

   199

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

   200

			 * sell the old engine in a moment

   201

			 */

   202

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

   203

			Vehicle *front = old_v->Previous();

   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

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

   210

		} else {

   211

			// copy/clone the orders

   212

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

   213

			new_v->cur_order_index = old_v->cur_order_index;

   214

			ChangeVehicleViewWindow(old_v, new_v);

   215

			new_v->profit_this_year = old_v->profit_this_year;

   216

			new_v->profit_last_year = old_v->profit_last_year;

   217

			new_v->service_interval = old_v->service_interval;

   218

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

   219

			new_front = true;

   220

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

   221

			new_v->dest_tile  = old_v->dest_tile;

   222

   223

			new_v->current_order = old_v->current_order;

   224

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

   225

				Vehicle *temp_v = GetNextVehicle(old_v);

   226

   227

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

   228

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

   229

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

   230

					temp_v = GetNextVehicle(temp_v);

   231

				}

   232

   233

				if (temp_v != NULL) {

   234

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

   235

				}

   236

			}

   237

		}

   238

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

   239

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

   240

   241

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

   242

		if (!IsCustomName(old_v->string_id)) {

   243

			vehicle_name[0] = '\0';

   244

		} else {

   245

			SetDParam(0, old_v->index);

   246

			GetString(vehicle_name, STR_VEHICLE_NAME, lastof(vehicle_name));

   247

		}

   248

	} else { // flags & DC_EXEC not set

   249

		CommandCost tmp_move;

   250

   251

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

   252

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

   253

			if (next_veh != NULL) {

   254

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

   255

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

   256

				DoCommand(old_v->tile, new_engine_type, 3, DC_EXEC, GetCmdBuildVeh(old_v));

   257

				Vehicle *temp = GetVehicle(_new_vehicle_id);

   258

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

   259

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

   260

			}

   261

		}

   262

   263

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

   264

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

   265

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

   266

			SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   267

			/* Pay back the loan */

   268

			sell_value.MultiplyCost(-1);

   269

			SubtractMoneyFromPlayer(sell_value);

   270

			return CMD_ERROR;

   271

		}

   272

	}

   273

   274

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

   275

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

   276

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   277

	sell_value.MultiplyCost(-1);

   278

	SubtractMoneyFromPlayer(sell_value);

   279

   280

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

   281

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

   282

   283

	if (new_front) {

   284

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

   285

		new_v->unitnumber = cached_unitnumber;

   286

	}

   287

   288

	/* Transfer the name of the old vehicle */

   289

	if ((flags & DC_EXEC) && vehicle_name[0] != '\0') {

   290

		_cmd_text = vehicle_name;

   291

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

   292

	}

   293

   294

	return cost;

   295

}

   296

   297

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

   298

 * (used to be called autorenew)

   299

 * @param v The vehicle to replace

   300

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

   301

 * @param check Checks if the replace is valid. No action is done at all

   302

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

   303

 * @return CMD_ERROR if something went wrong. Otherwise the price of the replace

   304

 */

   305

CommandCost MaybeReplaceVehicle(Vehicle *v, bool check, bool display_costs)

   306

{

   307

	Vehicle *w;

   308

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

   309

	byte flags = 0;

   310

	CommandCost cost, temp_cost;

   311

	bool stopped;

   312

   313

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

   314

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

   315

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

   316

	 * Useful when newGRF uses custom length */

   317

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

   318

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

   319

		-1

   320

	);

   321

   322

   323

	_current_player = v->owner;

   324

   325

	assert(IsPlayerBuildableVehicleType(v));

   326

   327

	assert(v->vehstatus & VS_STOPPED); // the vehicle should have been stopped in VehicleEnteredDepotThisTick() if needed

   328

   329

	/* Remember the flag v->leave_depot_instantly because if we replace the vehicle, the vehicle holding this flag will be sold

   330

	 * If it is set, then we only stopped the vehicle to replace it (if needed) and we will need to start it again.

   331

	 * We also need to reset the flag since it should remain false except from when the vehicle enters a depot until autoreplace is handled in the same tick */

   332

	stopped = v->leave_depot_instantly;

   333

	v->leave_depot_instantly = false;

   334

   335

	for (;;) {

   336

		cost = CommandCost();

   337

		w = v;

   338

		do {

   339

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

   340

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

   341

				continue;

   342

			}

   343

   344

			// check if the vehicle should be replaced

   345

			if (!p->engine_renew ||

   346

					w->age - w->max_age < (p->engine_renew_months * 30) || // replace if engine is too old

   347

					w->max_age == 0) { // rail cars got a max age of 0

   348

				/* If the vehicle belongs to a group, check if the group is protected from the global autoreplace.

   349

				   If not, chek if an global auto remplacement is defined */

   350

				if (IsValidGroupID(w->group_id)) {

   351

					if (!EngineHasReplacementForPlayer(p, w->engine_type, w->group_id) && (

   352

							GetGroup(w->group_id)->replace_protection ||

   353

							!EngineHasReplacementForPlayer(p, w->engine_type, ALL_GROUP))) {

   354

						continue;

   355

					}

   356

				} else if (IsDefaultGroupID(w->group_id)) {

   357

					if (!EngineHasReplacementForPlayer(p, w->engine_type, DEFAULT_GROUP) &&

   358

							!EngineHasReplacementForPlayer(p, w->engine_type, ALL_GROUP)) {

   359

						continue;

   360

					}

   361

				} else if (!EngineHasReplacementForPlayer(p, w->engine_type, ALL_GROUP)) {

   362

					continue;

   363

				}

   364

			}

   365

   366

			/* Now replace the vehicle */

   367

			temp_cost = ReplaceVehicle(&w, flags, cost.GetCost());

   368

   369

			if (CmdFailed(temp_cost)) break; // replace failed for some reason. Leave the vehicle alone

   370

   371

			if (flags & DC_EXEC &&

   372

					(w->type != VEH_TRAIN || w->u.rail.first_engine == INVALID_ENGINE)) {

   373

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

   374

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

   375

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

   376

				 */

   377

				v = w;

   378

			}

   379

			cost.AddCost(temp_cost);

   380

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

   381

   382

		if (!(flags & DC_EXEC) && (p->player_money < (cost.GetCost() + p->engine_renew_money) || cost.GetCost() == 0)) {

   383

			if (!check && p->player_money < (cost.GetCost() + p->engine_renew_money) && ( _local_player == v->owner ) && cost.GetCost() != 0) {

   384

				StringID message;

   385

				SetDParam(0, v->unitnumber);

   386

				switch (v->type) {

   387

					case VEH_TRAIN:    message = STR_TRAIN_AUTORENEW_FAILED;       break;

   388

					case VEH_ROAD:     message = STR_ROADVEHICLE_AUTORENEW_FAILED; break;

   389

					case VEH_SHIP:     message = STR_SHIP_AUTORENEW_FAILED;        break;

   390

					case VEH_AIRCRAFT: message = STR_AIRCRAFT_AUTORENEW_FAILED;    break;

   391

						// This should never happen

   392

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

   393

				}

   394

   395

				AddNewsItem(message, NEWS_FLAGS(NM_SMALL, NF_VIEWPORT|NF_VEHICLE, NT_ADVICE, 0), v->index, 0);

   396

			}

   397

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

   398

			if (display_costs) _current_player = OWNER_NONE;

   399

			return CMD_ERROR;

   400

		}

   401

   402

		if (flags & DC_EXEC) {

   403

			break; // we are done replacing since the loop ran once with DC_EXEC

   404

		} else if (check) {

   405

			/* It's a test only and we know that we can do this

   406

			 * NOTE: payment for wagon removal is NOT included in this price */

   407

			return cost;

   408

		}

   409

		// now we redo the loop, but this time we actually do stuff since we know that we can do it

   410

		flags |= DC_EXEC;

   411

	}

   412

   413

	/* If setting is on to try not to exceed the old length of the train with the replacement */

   414

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

   415

		Vehicle *temp;

   416

		w = v;

   417

   418

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

   419

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

   420

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

   421

				w = GetNextVehicle(w);

   422

			}

   423

			if (w == NULL) {

   424

				// we failed to make the train short enough

   425

				SetDParam(0, v->unitnumber);

   426

				AddNewsItem(STR_TRAIN_TOO_LONG_AFTER_REPLACEMENT, NEWS_FLAGS(NM_SMALL, NF_VIEWPORT|NF_VEHICLE, NT_ADVICE, 0), v->index, 0);

   427

				break;

   428

			}

   429

			temp = w;

   430

			w = GetNextVehicle(w);

   431

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

   432

			MoveVehicleCargo(v, temp);

   433

			cost.AddCost(DoCommand(0, temp->index, 0, DC_EXEC, CMD_SELL_RAIL_WAGON));

   434

		}

   435

	}

   436

   437

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

   438

	if (display_costs) {

   439

		if (IsLocalPlayer()) ShowCostOrIncomeAnimation(v->x_pos, v->y_pos, v->z_pos, cost.GetCost());

   440

		_current_player = OWNER_NONE;

   441

	}

   442

	return cost;

   443

}