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

    21

    22

/*

    23

 * move the cargo from one engine to another if possible

    24

 */

    25

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

    26

{

    27

	Vehicle *v = dest;

    28

	int units_moved;

    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

			units_moved = min(source->cargo_count, dest->cargo_cap - dest->cargo_count);

    39

			source->cargo_count -= units_moved;

    40

			dest->cargo_count   += units_moved;

    41

			dest->cargo_source   = source->cargo_source;

    42

    43

			// copy the age of the cargo

    44

			dest->cargo_days   = source->cargo_days;

    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 = GetFirstVehicleInChain(v);

    68

	} else {

    69

		u = v;

    70

	}

    71

    72

	FOR_VEHICLE_ORDERS(u, o) {

    73

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

    74

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

    75

		if (!CanRefitTo(engine_type, o->refit_cargo)) 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_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 = GetFirstVehicleInChain(v);

   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 int32 ReplaceVehicle(Vehicle **w, byte flags, int32 total_cost)

   128

{

   129

	int32 cost;

   130

	int32 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[32];

   138

	CargoID replacement_cargo_type;

   139

   140

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

   141

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

   142

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

   143

			INVALID_ENGINE :

   144

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

   145

   146

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

   147

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

   148

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

   149

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

   150

	}

   151

   154

	replacement_cargo_type = GetNewCargoTypeForReplace(old_v, new_engine_type);

   155

   156

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

   157

	if (replacement_cargo_type == CT_INVALID) return 0;

   158

   159

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

   160

   161

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

   162

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

   163

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

   164

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   165

	SubtractMoneyFromPlayer(sell_value);

   166

   167

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

   168

	if (CmdFailed(cost)) {

   169

		SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   170

		SubtractMoneyFromPlayer(-sell_value); // Take back the money we just gave the player

   171

		return cost;

   172

	}

   173

   174

	if (replacement_cargo_type != CT_NO_REFIT) cost += GetRefitCost(new_engine_type); // add refit cost

   175

   176

	if (flags & DC_EXEC) {

   177

		new_v = GetVehicle(_new_vehicle_id);

   178

		*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

   179

   180

		/* refit if needed */

   181

		if (replacement_cargo_type != CT_NO_REFIT) {

   182

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

   183

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

   184

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

   185

			}

   186

		}

   187

   188

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

   189

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

   190

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

   191

		}

   192

   193

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

   194

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

   195

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

   196

			 * sell the old engine in a moment

   197

			 */

   198

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

   199

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

   200

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

   201

		} else {

   202

			// copy/clone the orders

   203

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

   204

			new_v->cur_order_index = old_v->cur_order_index;

   205

			ChangeVehicleViewWindow(old_v, new_v);

   206

			new_v->profit_this_year = old_v->profit_this_year;

   207

			new_v->profit_last_year = old_v->profit_last_year;

   208

			new_v->service_interval = old_v->service_interval;

   209

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

   210

			new_front = true;

   211

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

   212

			new_v->dest_tile  = old_v->dest_tile;

   213

   214

			new_v->current_order = old_v->current_order;

   215

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

   216

				Vehicle *temp_v = GetNextVehicle(old_v);

   217

   218

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

   219

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

   220

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

   221

					temp_v = GetNextVehicle(temp_v);

   222

				}

   223

   224

				if (temp_v != NULL) {

   225

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

   226

				}

   227

			} else if (!IsDefaultGroupID(old_v->group_id) && IsValidGroupID(old_v->group_id)) {

   228

				/* Increase the new num engines of the group for the ships, aircraft, and road vehicles

   229

					The old new num engine is decrease in the destroyvehicle function */

   230

				GetGroup(old_v->group_id)->num_engines[new_v->engine_type]++;

   231

			}

   232

		}

   233

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

   234

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

   235

   236

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

   237

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

   238

			vehicle_name[0] = '\0';

   239

		} else {

   240

			GetName(vehicle_name, old_v->string_id & 0x7FF, lastof(vehicle_name));

   241

		}

   242

	} else { // flags & DC_EXEC not set

   243

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

   244

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

   245

		if (p->money64 < (cost + total_cost)) {

   246

			SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   247

			SubtractMoneyFromPlayer(-sell_value); // Pay back the loan

   248

			return CMD_ERROR;

   249

		}

   250

	}

   251

   252

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

   253

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

   254

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   255

	SubtractMoneyFromPlayer(-sell_value);

   256

   257

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

   258

	cost += DoCommand(0, old_v->index, 0, flags, GetCmdSellVeh(old_v));

   259

   260

	if (new_front) {

   261

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

   262

		new_v->unitnumber = cached_unitnumber;

   263

	}

   264

   265

	/* Transfer the name of the old vehicle */

   266

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

   267

		_cmd_text = vehicle_name;

   268

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

   269

	}

   270

   271

	return cost;

   272

}

   273

   274

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

   275

 * (used to be called autorenew)

   276

 * @param v The vehicle to replace

   277

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

   278

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

   279

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

   280

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

   281

 */

   282

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

   283

{

   284

	Vehicle *w;

   285

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

   286

	byte flags = 0;

   287

	int32 cost, temp_cost = 0;

   288

	bool stopped;

   289

   290

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

   291

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

   292

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

   293

	 * Useful when newGRF uses custom length */

   294

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

   295

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

   296

		-1

   297

	);

   298

   299

   300

	_current_player = v->owner;

   301

   302

	assert(IsPlayerBuildableVehicleType(v));

   303

   304

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

   305

   306

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

   307

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

   308

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

   309

	stopped = v->leave_depot_instantly;

   310

	v->leave_depot_instantly = false;

   311

   312

	for (;;) {

   313

		cost = 0;

   314

		w = v;

   315

		do {

   316

			if (w->type == VEH_TRAIN && IsMultiheaded(w) && !IsTrainEngine(w)) {

   317

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

   318

				continue;

   319

			}

   320

   321

			// check if the vehicle should be replaced

   322

			if (!p->engine_renew ||

   323

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

   324

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

   325

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

   326

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

   327

				if (IsValidGroupID(w->group_id)) {

   328

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

   329

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

   330

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

   331

						continue;

   332

					}

   333

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

   334

					continue;

   335

				}

   336

			}

   337

   338

			/* Now replace the vehicle */

   339

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

   340

   341

			if (flags & DC_EXEC &&

   342

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

   343

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

   344

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

   345

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

   346

				 */

   347

				v = w;

   348

			}

   349

   350

			if (!CmdFailed(temp_cost)) {

   351

				cost += temp_cost;

   352

			}

   353

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

   354

   355

		if (!(flags & DC_EXEC) && (p->money64 < (int32)(cost + p->engine_renew_money) || cost == 0)) {

   356

			if (!check && p->money64 < (int32)(cost + p->engine_renew_money) && ( _local_player == v->owner ) && cost != 0) {

   357

				StringID message;

   358

				SetDParam(0, v->unitnumber);

   359

				switch (v->type) {

   360

					case VEH_TRAIN:    message = STR_TRAIN_AUTORENEW_FAILED;       break;

   361

					case VEH_ROAD:     message = STR_ROADVEHICLE_AUTORENEW_FAILED; break;

   362

					case VEH_SHIP:     message = STR_SHIP_AUTORENEW_FAILED;        break;

   363

					case VEH_AIRCRAFT: message = STR_AIRCRAFT_AUTORENEW_FAILED;    break;

   364

						// This should never happen

   365

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

   366

				}

   367

   368

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

   369

			}

   370

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

   371

			if (display_costs) _current_player = OWNER_NONE;

   372

			return CMD_ERROR;

   373

		}

   374

   375

		if (flags & DC_EXEC) {

   376

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

   377

		} else if (check) {

   378

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

   379

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

   380

			return cost;

   381

		}

   382

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

   383

		flags |= DC_EXEC;

   384

	}

   385

   386

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

   387

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

   388

		Vehicle *temp;

   389

		w = v;

   390

   391

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

   392

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

   393

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

   394

				w = GetNextVehicle(w);

   395

			}

   396

			if (w == NULL) {

   397

				// we failed to make the train short enough

   398

				SetDParam(0, v->unitnumber);

   399

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

   400

				break;

   401

			}

   402

			temp = w;

   403

			w = GetNextVehicle(w);

   404

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

   405

			MoveVehicleCargo(v, temp);

   406

			cost += DoCommand(0, temp->index, 0, DC_EXEC, CMD_SELL_RAIL_WAGON);

   407

		}

   408

	}

   409

   410

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

   411

	if (display_costs) {

   412

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

   413

		_current_player = OWNER_NONE;

   414

	}

   415

	return cost;

   416

}