1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "roadveh.h"

     6

#include "ship.h"

     7

#include "news_func.h"

     8

#include "player_func.h"

     9

#include "debug.h"

    10

#include "vehicle_gui.h"

    11

#include "train.h"

    12

#include "aircraft.h"

    13

#include "cargotype.h"

    14

#include "group.h"

    15

#include "strings_func.h"

    16

#include "command_func.h"

    17

#include "vehicle_func.h"

    18

#include "functions.h"

    19

#include "variables.h"

    20

#include "autoreplace_func.h"

    21

#include "articulated_vehicles.h"

    22

    23

#include "table/strings.h"

    24

    25

    26

/*

    27

 * move the cargo from one engine to another if possible

    28

 */

    29

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

    30

{

    31

	Vehicle *v = dest;

    32

    33

	do {

    34

		do {

    35

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

    36

				continue; // cargo not compatible

    37

    38

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

    39

				continue; // the destination vehicle is already full

    40

    41

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

    42

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

    43

    44

			// copy the age of the cargo

    45

			dest->day_counter  = source->day_counter;

    46

			dest->tick_counter = source->tick_counter;

    47

    48

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

    49

		dest = v;

    50

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

    51

    52

	/*

    53

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

    54

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

    55

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

    56

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

    57

	 */

    58

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

    59

}

    60

    61

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

    62

{

    63

	const Order *o;

    64

	const Vehicle *u;

    65

    66

	if (v->type == VEH_TRAIN) {

    67

		u = v->First();

    68

	} else {

    69

		u = v;

    70

	}

    71

    72

	FOR_VEHICLE_ORDERS(u, o) {

    73

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

    74

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

    75

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

    76

	}

    77

    78

	return true;

    79

}

    80

    81

/**

    82

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

    83

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

    84

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

    85

 * @return The cargo type to replace to

    86

 *    CT_NO_REFIT is returned if no refit is needed

    87

 *    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

    88

 */

    89

static CargoID GetNewCargoTypeForReplace(Vehicle *v, EngineID engine_type)

    90

{

    91

	CargoID new_cargo_type = GetEngineCargoType(engine_type);

    92

    93

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

    94

    95

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

    96

		if (VerifyAutoreplaceRefitForOrders(v, engine_type)) {

    97

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

    98

		} else {

    99

			return CT_INVALID;

   100

		}

   101

	}

   102

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

   103

   104

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

   105

   106

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

   107

   108

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

   109

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

   110

	v = v->First();

   111

	do {

   112

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

   113

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

   114

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

   115

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

   116

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

   117

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

   118

}

   119

   120

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

   121

 * This function is only called from MaybeReplaceVehicle()

   122

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

   123

 * @param w Vehicle to replace

   124

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

   125

 * @return value is cost of the replacement or CMD_ERROR

   126

 */

   127

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

   128

{

   129

	CommandCost cost;

   130

	CommandCost sell_value;

   131

	Vehicle *old_v = *w;

   132

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

   133

	EngineID new_engine_type;

   134

	const UnitID cached_unitnumber = old_v->unitnumber;

   135

	bool new_front = false;

   136

	Vehicle *new_v = NULL;

   137

	char *vehicle_name = NULL;

   138

	CargoID replacement_cargo_type;

   139

   140

	/* Check if there is a autoreplacement set for the vehicle */

   141

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

   142

	/* if not, just renew to the same type */

   143

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

   144

   145

	replacement_cargo_type = GetNewCargoTypeForReplace(old_v, new_engine_type);

   146

   147

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

   148

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

   149

   150

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

   151

   152

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

   153

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

   154

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

   155

	SubtractMoneyFromPlayer(sell_value);

   156

   157

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

   158

	if (CmdFailed(cost)) {

   159

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

   160

		sell_value.MultiplyCost(-1);

   161

		SubtractMoneyFromPlayer(sell_value);

   162

		return cost;

   163

	}

   164

   165

	if (replacement_cargo_type != CT_NO_REFIT) {

   166

		/* add refit cost */

   167

		CommandCost refit_cost = GetRefitCost(new_engine_type);

   168

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

   169

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

   170

			refit_cost.AddCost(refit_cost);

   171

		}

   172

		cost.AddCost(refit_cost);

   173

	}

   174

   175

	if (flags & DC_EXEC) {

   176

		new_v = GetVehicle(_new_vehicle_id);

   177

		*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

   178

   179

		/* refit if needed */

   180

		if (replacement_cargo_type != CT_NO_REFIT) {

   181

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

   182

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

   183

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

   184

			}

   185

		}

   186

   187

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

   188

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

   189

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

   190

		}

   191

   192

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

   193

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

   194

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

   195

			 * sell the old engine in a moment

   196

			 */

   197

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

   198

			Vehicle *front = old_v->Previous();

   199

			if (front == NULL) {

   200

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

   201

				Vehicle *next = old_v->Next();

   202

				if (next != NULL) {

   203

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

   204

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

   205

				}

   206

			} else {

   207

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

   208

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

   209

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

   210

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

   211

				/* Add the new vehicle */

   212

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

   213

			}

   214

		} else {

   215

			// copy/clone the orders

   216

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

   217

			new_v->cur_order_index = old_v->cur_order_index;

   218

			ChangeVehicleViewWindow(old_v, new_v);

   219

			new_v->profit_this_year = old_v->profit_this_year;

   220

			new_v->profit_last_year = old_v->profit_last_year;

   221

			new_v->service_interval = old_v->service_interval;

   222

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

   223

			new_front = true;

   224

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

   225

			new_v->dest_tile  = old_v->dest_tile;

   226

   227

			new_v->current_order = old_v->current_order;

   228

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

   229

				Vehicle *temp_v = GetNextVehicle(old_v);

   230

   231

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

   232

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

   233

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

   234

					temp_v = GetNextVehicle(temp_v);

   235

				}

   236

   237

				if (temp_v != NULL) {

   238

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

   239

				}

   240

			}

   241

		}

   242

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

   243

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

   244

   245

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

   246

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

   247

	} else { // flags & DC_EXEC not set

   248

		CommandCost tmp_move;

   249

   250

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

   251

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

   252

			if (next_veh != NULL) {

   253

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

   254

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

   255

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

   256

				Vehicle *temp = GetVehicle(_new_vehicle_id);

   257

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

   258

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

   259

			}

   260

		}

   261

   262

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

   263

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

   264

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

   265

			/* Pay back the loan */

   266

			sell_value.MultiplyCost(-1);

   267

			SubtractMoneyFromPlayer(sell_value);

   268

			return CMD_ERROR;

   269

		}

   270

	}

   271

   272

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

   273

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

   274

	sell_value.MultiplyCost(-1);

   275

	SubtractMoneyFromPlayer(sell_value);

   276

   277

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

   278

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

   279

   280

	if (new_front) {

   281

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

   282

		new_v->unitnumber = cached_unitnumber;

   283

	}

   284

   285

	/* Transfer the name of the old vehicle */

   286

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

   287

		_cmd_text = vehicle_name;

   288

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

   289

		free(vehicle_name);

   290

	}

   291

   292

	return cost;

   293

}

   294

   295

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

   296

 * (used to be called autorenew)

   297

 * @param v The vehicle to replace

   298

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

   299

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

   300

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

   301

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

   302

 */

   303

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

   304

{

   305

	Vehicle *w;

   306

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

   307

	byte flags = 0;

   308

	CommandCost cost, temp_cost;

   309

	bool stopped;

   310

   311

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

   312

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

   313

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

   314

	 * Useful when newGRF uses custom length */

   315

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

   316

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

   317

		-1

   318

	);

   319

   320

   321

	_current_player = v->owner;

   322

   323

	assert(IsPlayerBuildableVehicleType(v));

   324

   325

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

   326

   327

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

   328

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

   329

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

   330

	stopped = v->leave_depot_instantly;

   331

	v->leave_depot_instantly = false;

   332

   333

	for (;;) {

   334

		cost = CommandCost(EXPENSES_NEW_VEHICLES);

   335

		w = v;

   336

		do {

   337

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

   338

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

   339

				continue;

   340

			}

   341

   342

			// check if the vehicle should be replaced

   343

			if (!w->NeedsAutorenewing(p) || // replace if engine is too old

   344

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

   345

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

   346

			}

   347

   348

			/* Now replace the vehicle */

   349

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

   350

   351

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

   352

   353

			if (flags & DC_EXEC &&

   354

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

   355

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

   356

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

   357

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

   358

				 */

   359

				v = w;

   360

			}

   361

			cost.AddCost(temp_cost);

   362

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

   363

   364

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

   365

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

   366

				StringID message;

   367

				SetDParam(0, v->unitnumber);

   368

				switch (v->type) {

   369

					case VEH_TRAIN:    message = STR_TRAIN_AUTORENEW_FAILED;       break;

   370

					case VEH_ROAD:     message = STR_ROADVEHICLE_AUTORENEW_FAILED; break;

   371

					case VEH_SHIP:     message = STR_SHIP_AUTORENEW_FAILED;        break;

   372

					case VEH_AIRCRAFT: message = STR_AIRCRAFT_AUTORENEW_FAILED;    break;

   373

						// This should never happen

   374

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

   375

				}

   376

   377

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

   378

			}

   379

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

   380

			if (display_costs) _current_player = OWNER_NONE;

   381

			return CMD_ERROR;

   382

		}

   383

   384

		if (flags & DC_EXEC) {

   385

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

   386

		} else if (check) {

   387

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

   388

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

   389

			return cost;

   390

		}

   391

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

   392

		flags |= DC_EXEC;

   393

	}

   394

   395

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

   396

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

   397

		Vehicle *temp;

   398

		w = v;

   399

   400

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

   401

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

   402

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

   403

				w = GetNextVehicle(w);

   404

			}

   405

			if (w == NULL) {

   406

				// we failed to make the train short enough

   407

				SetDParam(0, v->unitnumber);

   408

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

   409

				break;

   410

			}

   411

			temp = w;

   412

			w = GetNextVehicle(w);

   413

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

   414

			MoveVehicleCargo(v, temp);

   415

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

   416

		}

   417

	}

   418

   419

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

   420

	if (display_costs) {

   421

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

   422

		_current_player = OWNER_NONE;

   423

	}

   424

	return cost;

   425

}