OpenTTD
autoreplace_cmd.cpp
Go to the documentation of this file.
1 /* $Id$ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "stdafx.h"
13 #include "company_func.h"
14 #include "train.h"
15 #include "command_func.h"
16 #include "engine_func.h"
17 #include "vehicle_func.h"
18 #include "autoreplace_func.h"
19 #include "autoreplace_gui.h"
20 #include "articulated_vehicles.h"
21 #include "core/random_func.hpp"
22 #include "vehiclelist.h"
23 
24 #include "table/strings.h"
25 
26 #include "safeguards.h"
27 
28 extern void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index);
29 extern void ChangeVehicleNews(VehicleID from_index, VehicleID to_index);
30 extern void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index);
31 
38 static bool EnginesHaveCargoInCommon(EngineID engine_a, EngineID engine_b)
39 {
40  CargoTypes available_cargoes_a = GetUnionOfArticulatedRefitMasks(engine_a, true);
41  CargoTypes available_cargoes_b = GetUnionOfArticulatedRefitMasks(engine_b, true);
42  return (available_cargoes_a == 0 || available_cargoes_b == 0 || (available_cargoes_a & available_cargoes_b) != 0);
43 }
44 
53 {
54  assert(Engine::IsValidID(from) && Engine::IsValidID(to));
55 
56  /* we can't replace an engine into itself (that would be autorenew) */
57  if (from == to) return false;
58 
59  const Engine *e_from = Engine::Get(from);
60  const Engine *e_to = Engine::Get(to);
61  VehicleType type = e_from->type;
62 
63  /* check that the new vehicle type is available to the company and its type is the same as the original one */
64  if (!IsEngineBuildable(to, type, company)) return false;
65 
66  switch (type) {
67  case VEH_TRAIN: {
68  /* make sure the railtypes are compatible */
69  if ((GetRailTypeInfo(e_from->u.rail.railtype)->compatible_railtypes & GetRailTypeInfo(e_to->u.rail.railtype)->compatible_railtypes) == 0) return false;
70 
71  /* make sure we do not replace wagons with engines or vice versa */
72  if ((e_from->u.rail.railveh_type == RAILVEH_WAGON) != (e_to->u.rail.railveh_type == RAILVEH_WAGON)) return false;
73  break;
74  }
75 
76  case VEH_ROAD:
77  /* make sure that we do not replace a tram with a normal road vehicles or vice versa */
78  if (HasBit(e_from->info.misc_flags, EF_ROAD_TRAM) != HasBit(e_to->info.misc_flags, EF_ROAD_TRAM)) return false;
79  break;
80 
81  case VEH_AIRCRAFT:
82  /* make sure that we do not replace a plane with a helicopter or vice versa */
83  if ((e_from->u.air.subtype & AIR_CTOL) != (e_to->u.air.subtype & AIR_CTOL)) return false;
84  break;
85 
86  default: break;
87  }
88 
89  /* the engines needs to be able to carry the same cargo */
90  return EnginesHaveCargoInCommon(from, to);
91 }
92 
100 {
101  assert(v == NULL || v->First() == v);
102 
103  for (Vehicle *src = v; src != NULL; src = src->Next()) {
104  assert(src->cargo.TotalCount() == src->cargo.ActionCount(VehicleCargoList::MTA_KEEP));
105 
106  /* Do we need to more cargo away? */
107  if (src->cargo.TotalCount() <= src->cargo_cap) continue;
108 
109  /* We need to move a particular amount. Try that on the other vehicles. */
110  uint to_spread = src->cargo.TotalCount() - src->cargo_cap;
111  for (Vehicle *dest = v; dest != NULL && to_spread != 0; dest = dest->Next()) {
112  assert(dest->cargo.TotalCount() == dest->cargo.ActionCount(VehicleCargoList::MTA_KEEP));
113  if (dest->cargo.TotalCount() >= dest->cargo_cap || dest->cargo_type != src->cargo_type) continue;
114 
115  uint amount = min(to_spread, dest->cargo_cap - dest->cargo.TotalCount());
116  src->cargo.Shift(amount, &dest->cargo);
117  to_spread -= amount;
118  }
119 
120  /* Any left-overs will be thrown away, but not their feeder share. */
121  if (src->cargo_cap < src->cargo.TotalCount()) src->cargo.Truncate(src->cargo.TotalCount() - src->cargo_cap);
122  }
123 }
124 
134 static void TransferCargo(Vehicle *old_veh, Vehicle *new_head, bool part_of_chain)
135 {
136  assert(!part_of_chain || new_head->IsPrimaryVehicle());
137  /* Loop through source parts */
138  for (Vehicle *src = old_veh; src != NULL; src = src->Next()) {
139  assert(src->cargo.TotalCount() == src->cargo.ActionCount(VehicleCargoList::MTA_KEEP));
140  if (!part_of_chain && src->type == VEH_TRAIN && src != old_veh && src != Train::From(old_veh)->other_multiheaded_part && !src->IsArticulatedPart()) {
141  /* Skip vehicles, which do not belong to old_veh */
142  src = src->GetLastEnginePart();
143  continue;
144  }
145  if (src->cargo_type >= NUM_CARGO || src->cargo.TotalCount() == 0) continue;
146 
147  /* Find free space in the new chain */
148  for (Vehicle *dest = new_head; dest != NULL && src->cargo.TotalCount() > 0; dest = dest->Next()) {
149  assert(dest->cargo.TotalCount() == dest->cargo.ActionCount(VehicleCargoList::MTA_KEEP));
150  if (!part_of_chain && dest->type == VEH_TRAIN && dest != new_head && dest != Train::From(new_head)->other_multiheaded_part && !dest->IsArticulatedPart()) {
151  /* Skip vehicles, which do not belong to new_head */
152  dest = dest->GetLastEnginePart();
153  continue;
154  }
155  if (dest->cargo_type != src->cargo_type) continue;
156 
157  uint amount = min(src->cargo.TotalCount(), dest->cargo_cap - dest->cargo.TotalCount());
158  if (amount <= 0) continue;
159 
160  src->cargo.Shift(amount, &dest->cargo);
161  }
162  }
163 
164  /* Update train weight etc., the old vehicle will be sold anyway */
165  if (part_of_chain && new_head->type == VEH_TRAIN) Train::From(new_head)->ConsistChanged(CCF_LOADUNLOAD);
166 }
167 
174 static bool VerifyAutoreplaceRefitForOrders(const Vehicle *v, EngineID engine_type)
175 {
176  CargoTypes union_refit_mask_a = GetUnionOfArticulatedRefitMasks(v->engine_type, false);
177  CargoTypes union_refit_mask_b = GetUnionOfArticulatedRefitMasks(engine_type, false);
178 
179  const Order *o;
180  const Vehicle *u = (v->type == VEH_TRAIN) ? v->First() : v;
181  FOR_VEHICLE_ORDERS(u, o) {
182  if (!o->IsRefit() || o->IsAutoRefit()) continue;
183  CargoID cargo_type = o->GetRefitCargo();
184 
185  if (!HasBit(union_refit_mask_a, cargo_type)) continue;
186  if (!HasBit(union_refit_mask_b, cargo_type)) return false;
187  }
188 
189  return true;
190 }
191 
201 static CargoID GetNewCargoTypeForReplace(Vehicle *v, EngineID engine_type, bool part_of_chain)
202 {
203  CargoTypes available_cargo_types, union_mask;
204  GetArticulatedRefitMasks(engine_type, true, &union_mask, &available_cargo_types);
205 
206  if (union_mask == 0) return CT_NO_REFIT; // Don't try to refit an engine with no cargo capacity
207 
208  CargoID cargo_type;
209  if (IsArticulatedVehicleCarryingDifferentCargoes(v, &cargo_type)) return CT_INVALID; // We cannot refit to mixed cargoes in an automated way
210 
211  if (cargo_type == CT_INVALID) {
212  if (v->type != VEH_TRAIN) return CT_NO_REFIT; // If the vehicle does not carry anything at all, every replacement is fine.
213 
214  if (!part_of_chain) return CT_NO_REFIT;
215 
216  /* the old engine didn't have cargo capacity, but the new one does
217  * now we will figure out what cargo the train is carrying and refit to fit this */
218 
219  for (v = v->First(); v != NULL; v = v->Next()) {
220  if (!v->GetEngine()->CanCarryCargo()) continue;
221  /* Now we found a cargo type being carried on the train and we will see if it is possible to carry to this one */
222  if (HasBit(available_cargo_types, v->cargo_type)) return v->cargo_type;
223  }
224 
225  return CT_NO_REFIT; // We failed to find a cargo type on the old vehicle and we will not refit the new one
226  } else {
227  if (!HasBit(available_cargo_types, cargo_type)) return CT_INVALID; // We can't refit the vehicle to carry the cargo we want
228 
229  if (part_of_chain && !VerifyAutoreplaceRefitForOrders(v, engine_type)) return CT_INVALID; // Some refit orders lose their effect
230 
231  return cargo_type;
232  }
233 }
234 
243 static CommandCost GetNewEngineType(const Vehicle *v, const Company *c, bool always_replace, EngineID &e)
244 {
245  assert(v->type != VEH_TRAIN || !v->IsArticulatedPart());
246 
247  e = INVALID_ENGINE;
248 
249  if (v->type == VEH_TRAIN && Train::From(v)->IsRearDualheaded()) {
250  /* we build the rear ends of multiheaded trains with the front ones */
251  return CommandCost();
252  }
253 
254  bool replace_when_old;
255  e = EngineReplacementForCompany(c, v->engine_type, v->group_id, &replace_when_old);
256  if (!always_replace && replace_when_old && !v->NeedsAutorenewing(c, false)) e = INVALID_ENGINE;
257 
258  /* Autoreplace, if engine is available */
260  return CommandCost();
261  }
262 
263  /* Autorenew if needed */
264  if (v->NeedsAutorenewing(c)) e = v->engine_type;
265 
266  /* Nothing to do or all is fine? */
267  if (e == INVALID_ENGINE || IsEngineBuildable(e, v->type, _current_company)) return CommandCost();
268 
269  /* The engine we need is not available. Report error to user */
270  return CommandCost(STR_ERROR_RAIL_VEHICLE_NOT_AVAILABLE + v->type);
271 }
272 
281 static CommandCost BuildReplacementVehicle(Vehicle *old_veh, Vehicle **new_vehicle, bool part_of_chain)
282 {
283  *new_vehicle = NULL;
284 
285  /* Shall the vehicle be replaced? */
287  EngineID e;
288  CommandCost cost = GetNewEngineType(old_veh, c, true, e);
289  if (cost.Failed()) return cost;
290  if (e == INVALID_ENGINE) return CommandCost(); // neither autoreplace is set, nor autorenew is triggered
291 
292  /* Does it need to be refitted */
293  CargoID refit_cargo = GetNewCargoTypeForReplace(old_veh, e, part_of_chain);
294  if (refit_cargo == CT_INVALID) return CommandCost(); // incompatible cargoes
295 
296  /* Build the new vehicle */
297  cost = DoCommand(old_veh->tile, e, 0, DC_EXEC | DC_AUTOREPLACE, GetCmdBuildVeh(old_veh));
298  if (cost.Failed()) return cost;
299 
300  Vehicle *new_veh = Vehicle::Get(_new_vehicle_id);
301  *new_vehicle = new_veh;
302 
303  /* Refit the vehicle if needed */
304  if (refit_cargo != CT_NO_REFIT) {
305  byte subtype = GetBestFittingSubType(old_veh, new_veh, refit_cargo);
306 
307  cost.AddCost(DoCommand(0, new_veh->index, refit_cargo | (subtype << 8), DC_EXEC, GetCmdRefitVeh(new_veh)));
308  assert(cost.Succeeded()); // This should be ensured by GetNewCargoTypeForReplace()
309  }
310 
311  /* Try to reverse the vehicle, but do not care if it fails as the new type might not be reversible */
312  if (new_veh->type == VEH_TRAIN && HasBit(Train::From(old_veh)->flags, VRF_REVERSE_DIRECTION)) {
313  DoCommand(0, new_veh->index, true, DC_EXEC, CMD_REVERSE_TRAIN_DIRECTION);
314  }
315 
316  return cost;
317 }
318 
325 static inline CommandCost CmdStartStopVehicle(const Vehicle *v, bool evaluate_callback)
326 {
327  return DoCommand(0, v->index, evaluate_callback ? 1 : 0, DC_EXEC | DC_AUTOREPLACE, CMD_START_STOP_VEHICLE);
328 }
329 
338 static inline CommandCost CmdMoveVehicle(const Vehicle *v, const Vehicle *after, DoCommandFlag flags, bool whole_chain)
339 {
340  return DoCommand(0, v->index | (whole_chain ? 1 : 0) << 20, after != NULL ? after->index : INVALID_VEHICLE, flags | DC_NO_CARGO_CAP_CHECK, CMD_MOVE_RAIL_VEHICLE);
341 }
342 
350 {
351  CommandCost cost = CommandCost();
352 
353  /* Share orders */
354  if (cost.Succeeded() && old_head != new_head) cost.AddCost(DoCommand(0, new_head->index | CO_SHARE << 30, old_head->index, DC_EXEC, CMD_CLONE_ORDER));
355 
356  /* Copy group membership */
357  if (cost.Succeeded() && old_head != new_head) cost.AddCost(DoCommand(0, old_head->group_id, new_head->index, DC_EXEC, CMD_ADD_VEHICLE_GROUP));
358 
359  /* Perform start/stop check whether the new vehicle suits newgrf restrictions etc. */
360  if (cost.Succeeded()) {
361  /* Start the vehicle, might be denied by certain things */
362  assert((new_head->vehstatus & VS_STOPPED) != 0);
363  cost.AddCost(CmdStartStopVehicle(new_head, true));
364 
365  /* Stop the vehicle again, but do not care about evil newgrfs allowing starting but not stopping :p */
366  if (cost.Succeeded()) cost.AddCost(CmdStartStopVehicle(new_head, false));
367  }
368 
369  /* Last do those things which do never fail (resp. we do not care about), but which are not undo-able */
370  if (cost.Succeeded() && old_head != new_head && (flags & DC_EXEC) != 0) {
371  /* Copy other things which cannot be copied by a command and which shall not stay resetted from the build vehicle command */
372  new_head->CopyVehicleConfigAndStatistics(old_head);
373 
374  /* Switch vehicle windows/news to the new vehicle, so they are not closed/deleted when the old vehicle is sold */
375  ChangeVehicleViewports(old_head->index, new_head->index);
376  ChangeVehicleViewWindow(old_head->index, new_head->index);
377  ChangeVehicleNews(old_head->index, new_head->index);
378  }
379 
380  return cost;
381 }
382 
390 static CommandCost ReplaceFreeUnit(Vehicle **single_unit, DoCommandFlag flags, bool *nothing_to_do)
391 {
392  Train *old_v = Train::From(*single_unit);
393  assert(!old_v->IsArticulatedPart() && !old_v->IsRearDualheaded());
394 
396 
397  /* Build and refit replacement vehicle */
398  Vehicle *new_v = NULL;
399  cost.AddCost(BuildReplacementVehicle(old_v, &new_v, false));
400 
401  /* Was a new vehicle constructed? */
402  if (cost.Succeeded() && new_v != NULL) {
403  *nothing_to_do = false;
404 
405  if ((flags & DC_EXEC) != 0) {
406  /* Move the new vehicle behind the old */
407  CmdMoveVehicle(new_v, old_v, DC_EXEC, false);
408 
409  /* Take over cargo
410  * Note: We do only transfer cargo from the old to the new vehicle.
411  * I.e. we do not transfer remaining cargo to other vehicles.
412  * Else you would also need to consider moving cargo to other free chains,
413  * or doing the same in ReplaceChain(), which would be quite troublesome.
414  */
415  TransferCargo(old_v, new_v, false);
416 
417  *single_unit = new_v;
418  }
419 
420  /* Sell the old vehicle */
421  cost.AddCost(DoCommand(0, old_v->index, 0, flags, GetCmdSellVeh(old_v)));
422 
423  /* If we are not in DC_EXEC undo everything */
424  if ((flags & DC_EXEC) == 0) {
425  DoCommand(0, new_v->index, 0, DC_EXEC, GetCmdSellVeh(new_v));
426  }
427  }
428 
429  return cost;
430 }
431 
440 static CommandCost ReplaceChain(Vehicle **chain, DoCommandFlag flags, bool wagon_removal, bool *nothing_to_do)
441 {
442  Vehicle *old_head = *chain;
443  assert(old_head->IsPrimaryVehicle());
444 
446 
447  if (old_head->type == VEH_TRAIN) {
448  /* Store the length of the old vehicle chain, rounded up to whole tiles */
449  uint16 old_total_length = CeilDiv(Train::From(old_head)->gcache.cached_total_length, TILE_SIZE) * TILE_SIZE;
450 
451  int num_units = 0;
452  for (Train *w = Train::From(old_head); w != NULL; w = w->GetNextUnit()) num_units++;
453 
454  Train **old_vehs = CallocT<Train *>(num_units);
455  Train **new_vehs = CallocT<Train *>(num_units);
456  Money *new_costs = MallocT<Money>(num_units);
457 
458  /* Collect vehicles and build replacements
459  * Note: The replacement vehicles can only successfully build as long as the old vehicles are still in their chain */
460  int i;
461  Train *w;
462  for (w = Train::From(old_head), i = 0; w != NULL; w = w->GetNextUnit(), i++) {
463  assert(i < num_units);
464  old_vehs[i] = w;
465 
466  CommandCost ret = BuildReplacementVehicle(old_vehs[i], (Vehicle**)&new_vehs[i], true);
467  cost.AddCost(ret);
468  if (cost.Failed()) break;
469 
470  new_costs[i] = ret.GetCost();
471  if (new_vehs[i] != NULL) *nothing_to_do = false;
472  }
473  Train *new_head = (new_vehs[0] != NULL ? new_vehs[0] : old_vehs[0]);
474 
475  /* Note: When autoreplace has already failed here, old_vehs[] is not completely initialized. But it is also not needed. */
476  if (cost.Succeeded()) {
477  /* Separate the head, so we can start constructing the new chain */
478  Train *second = Train::From(old_head)->GetNextUnit();
479  if (second != NULL) cost.AddCost(CmdMoveVehicle(second, NULL, DC_EXEC | DC_AUTOREPLACE, true));
480 
481  assert(Train::From(new_head)->GetNextUnit() == NULL);
482 
483  /* Append engines to the new chain
484  * We do this from back to front, so that the head of the temporary vehicle chain does not change all the time.
485  * That way we also have less trouble when exceeding the unitnumber limit.
486  * OTOH the vehicle attach callback is more expensive this way :s */
487  Train *last_engine = NULL;
488  if (cost.Succeeded()) {
489  for (int i = num_units - 1; i > 0; i--) {
490  Train *append = (new_vehs[i] != NULL ? new_vehs[i] : old_vehs[i]);
491 
492  if (RailVehInfo(append->engine_type)->railveh_type == RAILVEH_WAGON) continue;
493 
494  if (new_vehs[i] != NULL) {
495  /* Move the old engine to a separate row with DC_AUTOREPLACE. Else
496  * moving the wagon in front may fail later due to unitnumber limit.
497  * (We have to attach wagons without DC_AUTOREPLACE.) */
498  CmdMoveVehicle(old_vehs[i], NULL, DC_EXEC | DC_AUTOREPLACE, false);
499  }
500 
501  if (last_engine == NULL) last_engine = append;
502  cost.AddCost(CmdMoveVehicle(append, new_head, DC_EXEC, false));
503  if (cost.Failed()) break;
504  }
505  if (last_engine == NULL) last_engine = new_head;
506  }
507 
508  /* When wagon removal is enabled and the new engines without any wagons are already longer than the old, we have to fail */
509  if (cost.Succeeded() && wagon_removal && new_head->gcache.cached_total_length > old_total_length) cost = CommandCost(STR_ERROR_TRAIN_TOO_LONG_AFTER_REPLACEMENT);
510 
511  /* Append/insert wagons into the new vehicle chain
512  * We do this from back to front, so we can stop when wagon removal or maximum train length (i.e. from mammoth-train setting) is triggered.
513  */
514  if (cost.Succeeded()) {
515  for (int i = num_units - 1; i > 0; i--) {
516  assert(last_engine != NULL);
517  Vehicle *append = (new_vehs[i] != NULL ? new_vehs[i] : old_vehs[i]);
518 
519  if (RailVehInfo(append->engine_type)->railveh_type == RAILVEH_WAGON) {
520  /* Insert wagon after 'last_engine' */
521  CommandCost res = CmdMoveVehicle(append, last_engine, DC_EXEC, false);
522 
523  /* When we allow removal of wagons, either the move failing due
524  * to the train becoming too long, or the train becoming longer
525  * would move the vehicle to the empty vehicle chain. */
526  if (wagon_removal && (res.Failed() ? res.GetErrorMessage() == STR_ERROR_TRAIN_TOO_LONG : new_head->gcache.cached_total_length > old_total_length)) {
527  CmdMoveVehicle(append, NULL, DC_EXEC | DC_AUTOREPLACE, false);
528  break;
529  }
530 
531  cost.AddCost(res);
532  if (cost.Failed()) break;
533  } else {
534  /* We have reached 'last_engine', continue with the next engine towards the front */
535  assert(append == last_engine);
536  last_engine = last_engine->GetPrevUnit();
537  }
538  }
539  }
540 
541  /* Sell superfluous new vehicles that could not be inserted. */
542  if (cost.Succeeded() && wagon_removal) {
544  for (int i = 1; i < num_units; i++) {
545  Vehicle *wagon = new_vehs[i];
546  if (wagon == NULL) continue;
547  if (wagon->First() == new_head) break;
548 
549  assert(RailVehInfo(wagon->engine_type)->railveh_type == RAILVEH_WAGON);
550 
551  /* Sell wagon */
552  CommandCost ret = DoCommand(0, wagon->index, 0, DC_EXEC, GetCmdSellVeh(wagon));
553  assert(ret.Succeeded());
554  new_vehs[i] = NULL;
555 
556  /* Revert the money subtraction when the vehicle was built.
557  * This value is different from the sell value, esp. because of refitting */
558  cost.AddCost(-new_costs[i]);
559  }
560  }
561 
562  /* The new vehicle chain is constructed, now take over orders and everything... */
563  if (cost.Succeeded()) cost.AddCost(CopyHeadSpecificThings(old_head, new_head, flags));
564 
565  if (cost.Succeeded()) {
566  /* Success ! */
567  if ((flags & DC_EXEC) != 0 && new_head != old_head) {
568  *chain = new_head;
569  }
570 
571  /* Transfer cargo of old vehicles and sell them */
572  for (int i = 0; i < num_units; i++) {
573  Vehicle *w = old_vehs[i];
574  /* Is the vehicle again part of the new chain?
575  * Note: We cannot test 'new_vehs[i] != NULL' as wagon removal might cause to remove both */
576  if (w->First() == new_head) continue;
577 
578  if ((flags & DC_EXEC) != 0) TransferCargo(w, new_head, true);
579 
580  /* Sell the vehicle.
581  * Note: This might temporarly construct new trains, so use DC_AUTOREPLACE to prevent
582  * it from failing due to engine limits. */
583  cost.AddCost(DoCommand(0, w->index, 0, flags | DC_AUTOREPLACE, GetCmdSellVeh(w)));
584  if ((flags & DC_EXEC) != 0) {
585  old_vehs[i] = NULL;
586  if (i == 0) old_head = NULL;
587  }
588  }
589 
590  if ((flags & DC_EXEC) != 0) CheckCargoCapacity(new_head);
591  }
592 
593  /* If we are not in DC_EXEC undo everything, i.e. rearrange old vehicles.
594  * We do this from back to front, so that the head of the temporary vehicle chain does not change all the time.
595  * Note: The vehicle attach callback is disabled here :) */
596  if ((flags & DC_EXEC) == 0) {
597  /* Separate the head, so we can reattach the old vehicles */
598  Train *second = Train::From(old_head)->GetNextUnit();
599  if (second != NULL) CmdMoveVehicle(second, NULL, DC_EXEC | DC_AUTOREPLACE, true);
600 
601  assert(Train::From(old_head)->GetNextUnit() == NULL);
602 
603  for (int i = num_units - 1; i > 0; i--) {
604  CommandCost ret = CmdMoveVehicle(old_vehs[i], old_head, DC_EXEC | DC_AUTOREPLACE, false);
605  assert(ret.Succeeded());
606  }
607  }
608  }
609 
610  /* Finally undo buying of new vehicles */
611  if ((flags & DC_EXEC) == 0) {
612  for (int i = num_units - 1; i >= 0; i--) {
613  if (new_vehs[i] != NULL) {
614  DoCommand(0, new_vehs[i]->index, 0, DC_EXEC, GetCmdSellVeh(new_vehs[i]));
615  new_vehs[i] = NULL;
616  }
617  }
618  }
619 
620  free(old_vehs);
621  free(new_vehs);
622  free(new_costs);
623  } else {
624  /* Build and refit replacement vehicle */
625  Vehicle *new_head = NULL;
626  cost.AddCost(BuildReplacementVehicle(old_head, &new_head, true));
627 
628  /* Was a new vehicle constructed? */
629  if (cost.Succeeded() && new_head != NULL) {
630  *nothing_to_do = false;
631 
632  /* The new vehicle is constructed, now take over orders and everything... */
633  cost.AddCost(CopyHeadSpecificThings(old_head, new_head, flags));
634 
635  if (cost.Succeeded()) {
636  /* The new vehicle is constructed, now take over cargo */
637  if ((flags & DC_EXEC) != 0) {
638  TransferCargo(old_head, new_head, true);
639  *chain = new_head;
640  }
641 
642  /* Sell the old vehicle */
643  cost.AddCost(DoCommand(0, old_head->index, 0, flags, GetCmdSellVeh(old_head)));
644  }
645 
646  /* If we are not in DC_EXEC undo everything */
647  if ((flags & DC_EXEC) == 0) {
648  DoCommand(0, new_head->index, 0, DC_EXEC, GetCmdSellVeh(new_head));
649  }
650  }
651  }
652 
653  return cost;
654 }
655 
666 CommandCost CmdAutoreplaceVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
667 {
668  Vehicle *v = Vehicle::GetIfValid(p1);
669  if (v == NULL) return CMD_ERROR;
670 
671  CommandCost ret = CheckOwnership(v->owner);
672  if (ret.Failed()) return ret;
673 
674  if (!v->IsChainInDepot()) return CMD_ERROR;
675  if (v->vehstatus & VS_CRASHED) return CMD_ERROR;
676 
677  bool free_wagon = false;
678  if (v->type == VEH_TRAIN) {
679  Train *t = Train::From(v);
680  if (t->IsArticulatedPart() || t->IsRearDualheaded()) return CMD_ERROR;
681  free_wagon = !t->IsFrontEngine();
682  if (free_wagon && t->First()->IsFrontEngine()) return CMD_ERROR;
683  } else {
684  if (!v->IsPrimaryVehicle()) return CMD_ERROR;
685  }
686 
688  bool wagon_removal = c->settings.renew_keep_length;
689 
690  /* Test whether any replacement is set, before issuing a whole lot of commands that would end in nothing changed */
691  Vehicle *w = v;
692  bool any_replacements = false;
693  while (w != NULL) {
694  EngineID e;
695  CommandCost cost = GetNewEngineType(w, c, false, e);
696  if (cost.Failed()) return cost;
697  any_replacements |= (e != INVALID_ENGINE);
698  w = (!free_wagon && w->type == VEH_TRAIN ? Train::From(w)->GetNextUnit() : NULL);
699  }
700 
702  bool nothing_to_do = true;
703 
704  if (any_replacements) {
705  bool was_stopped = free_wagon || ((v->vehstatus & VS_STOPPED) != 0);
706 
707  /* Stop the vehicle */
708  if (!was_stopped) cost.AddCost(CmdStartStopVehicle(v, true));
709  if (cost.Failed()) return cost;
710 
711  assert(free_wagon || v->IsStoppedInDepot());
712 
713  /* We have to construct the new vehicle chain to test whether it is valid.
714  * Vehicle construction needs random bits, so we have to save the random seeds
715  * to prevent desyncs and to replay newgrf callbacks during DC_EXEC */
716  SavedRandomSeeds saved_seeds;
717  SaveRandomSeeds(&saved_seeds);
718  if (free_wagon) {
719  cost.AddCost(ReplaceFreeUnit(&v, flags & ~DC_EXEC, &nothing_to_do));
720  } else {
721  cost.AddCost(ReplaceChain(&v, flags & ~DC_EXEC, wagon_removal, &nothing_to_do));
722  }
723  RestoreRandomSeeds(saved_seeds);
724 
725  if (cost.Succeeded() && (flags & DC_EXEC) != 0) {
726  CommandCost ret;
727  if (free_wagon) {
728  ret = ReplaceFreeUnit(&v, flags, &nothing_to_do);
729  } else {
730  ret = ReplaceChain(&v, flags, wagon_removal, &nothing_to_do);
731  }
732  assert(ret.Succeeded() && ret.GetCost() == cost.GetCost());
733  }
734 
735  /* Restart the vehicle */
736  if (!was_stopped) cost.AddCost(CmdStartStopVehicle(v, false));
737  }
738 
739  if (cost.Succeeded() && nothing_to_do) cost = CommandCost(STR_ERROR_AUTOREPLACE_NOTHING_TO_DO);
740  return cost;
741 }
742 
756 CommandCost CmdSetAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
757 {
759  if (c == NULL) return CMD_ERROR;
760 
761  EngineID old_engine_type = GB(p2, 0, 16);
762  EngineID new_engine_type = GB(p2, 16, 16);
763  GroupID id_g = GB(p1, 16, 16);
764  CommandCost cost;
765 
766  if (Group::IsValidID(id_g) ? Group::Get(id_g)->owner != _current_company : !IsAllGroupID(id_g) && !IsDefaultGroupID(id_g)) return CMD_ERROR;
767  if (!Engine::IsValidID(old_engine_type)) return CMD_ERROR;
768 
769  if (new_engine_type != INVALID_ENGINE) {
770  if (!Engine::IsValidID(new_engine_type)) return CMD_ERROR;
771  if (!CheckAutoreplaceValidity(old_engine_type, new_engine_type, _current_company)) return CMD_ERROR;
772 
773  cost = AddEngineReplacementForCompany(c, old_engine_type, new_engine_type, id_g, HasBit(p1, 0), flags);
774  } else {
775  cost = RemoveEngineReplacementForCompany(c, old_engine_type, id_g, flags);
776  }
777 
778  if (flags & DC_EXEC) {
780  if (IsLocalCompany()) SetWindowDirty(WC_REPLACE_VEHICLE, Engine::Get(old_engine_type)->type);
781 
782  const VehicleType vt = Engine::Get(old_engine_type)->type;
784  }
785  if ((flags & DC_EXEC) && IsLocalCompany()) InvalidateAutoreplaceWindow(old_engine_type, id_g);
786 
787  return cost;
788 }
789 
bool IsEngineBuildable(EngineID engine, VehicleType type, CompanyID company)
Check if an engine is buildable.
Definition: engine.cpp:1074
bool CheckAutoreplaceValidity(EngineID from, EngineID to, CompanyID company)
Checks some basic properties whether autoreplace is allowed.
VehicleSettings vehicle
options for vehicles
static CommandCost GetNewEngineType(const Vehicle *v, const Company *c, bool always_replace, EngineID &e)
Get the EngineID of the replacement for a vehicle.
static bool IsLocalCompany()
Is the current company the local company?
Definition: company_func.h:45
Vehicle is stopped by the player.
Definition: vehicle_base.h:33
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition: vehicle_base.h:309
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:257
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:298
The information about a vehicle list.
Definition: vehiclelist.h:31
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3201
Functions related to the autoreplace GUIs.
Functions and type for generating vehicle lists.
static EngineID EngineReplacementForCompany(const Company *c, EngineID engine, GroupID group, bool *replace_when_old=NULL)
Retrieve the engine replacement for the given company and original engine type.
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
bool CanCarryCargo() const
Determines whether an engine can carry something.
Definition: engine.cpp:173
Conventional Take Off and Landing, i.e. planes.
Definition: engine_type.h:93
Base for the train class.
Stores the state of all random number generators.
Definition: random_func.hpp:35
Train * GetPrevUnit()
Get the previous real (non-articulated part and non rear part of dualheaded engine) vehicle in the co...
Definition: train.h:158
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:25
Replace vehicle window; Window numbers:
Definition: window_type.h:213
Maximal number of cargo types in a game.
Definition: cargo_type.h:66
bool IsStoppedInDepot() const
Check whether the vehicle is in the depot and stopped.
Definition: vehicle_base.h:516
Train * GetNextUnit() const
Get the next real (non-articulated part and non rear part of dualheaded engine) vehicle in the consis...
Definition: train.h:146
static void RestoreRandomSeeds(const SavedRandomSeeds &storage)
Restores previously saved seeds.
Definition: random_func.hpp:54
byte GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoID dest_cargo_type)
Get the best fitting subtype when &#39;cloning&#39;/&#39;replacing&#39; v_from with v_for.
Functions related to vehicles.
CargoTypes GetUnionOfArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type)
Ors the refit_masks of all articulated parts.
static CommandCost AddEngineReplacementForCompany(Company *c, EngineID old_engine, EngineID new_engine, GroupID group, bool replace_when_old, DoCommandFlag flags)
Add an engine replacement for the company.
Vehicle data structure.
Definition: vehicle_base.h:212
void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index)
Report a change in vehicle IDs (due to autoreplace) to affected vehicle windows.
static bool EnginesHaveCargoInCommon(EngineID engine_a, EngineID engine_b)
Figure out if two engines got at least one type of cargo in common (refitting if needed) ...
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
T * First() const
Get the first vehicle in the chain.
uint TotalCount() const
Returns sum of cargo, including reserved cargo.
Definition: cargopacket.h:375
clone (and share) an order
Definition: command_type.h:271
Money GetCost() const
The costs as made up to this moment.
Definition: command_type.h:84
RailTypes compatible_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel ...
Definition: rail.h:182
bool IsArticulatedVehicleCarryingDifferentCargoes(const Vehicle *v, CargoID *cargo_type)
Tests if all parts of an articulated vehicle are refitted to the same cargo.
Common return value for all commands.
Definition: command_type.h:25
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:59
byte vehstatus
Status.
Definition: vehicle_base.h:317
static Train * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
CompanySettings settings
settings specific for each company
Definition: company_base.h:126
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition: vehicle.cpp:744
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:15
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Definition: command_type.h:64
Do not refit cargo of a vehicle (used in vehicle orders and auto-replace/auto-new).
Definition: cargo_type.h:69
when autoreplace/autorenew is in progress, this shall prevent truncating the amount of cargo in the v...
Definition: command_type.h:353
bool IsAutoRefit() const
Is this order a auto-refit order.
Definition: order_base.h:117
Pseudo random number generator.
start or stop a vehicle
Definition: command_type.h:312
Invalid cargo type.
Definition: cargo_type.h:70
static bool IsAllGroupID(GroupID id_g)
Checks if a GroupID stands for all vehicles of a company.
Definition: group.h:93
Aircraft vehicle type.
Definition: vehicle_type.h:29
Vehicle is crashed.
Definition: vehicle_base.h:39
static CommandCost BuildReplacementVehicle(Vehicle *old_veh, Vehicle **new_vehicle, bool part_of_chain)
Builds and refits a replacement vehicle Important: The old vehicle is still in the original vehicle c...
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: vehicle_base.h:433
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:440
byte subtype
Type of aircraft.
Definition: engine_type.h:102
void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index)
Switches viewports following vehicles, which get autoreplaced.
Definition: window.cpp:3533
void ConsistChanged(ConsistChangeFlags allowed_changes)
Recalculates the cached stuff of a train.
Definition: train_cmd.cpp:109
bool IsRefit() const
Is this order a refit order.
Definition: order_base.h:110
Functions related to engines.
VehicleType
Available vehicle types.
Definition: vehicle_type.h:23
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
StringID GetErrorMessage() const
Returns the error message of a command.
Definition: command_type.h:142
DoCommandFlag
List of flags for a command.
Definition: command_type.h:343
simple wagon, not motorized
Definition: engine_type.h:30
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:152
Definition of base types and functions in a cross-platform compatible way.
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
Definition: vehicle_base.h:892
A number of safeguards to prevent using unsafe methods.
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:316
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:15
VehicleType type
Vehicle type, ie VEH_ROAD, VEH_TRAIN, etc.
Definition: engine_base.h:42
static CargoID GetNewCargoTypeForReplace(Vehicle *v, EngineID engine_type, bool part_of_chain)
Function to find what type of cargo to refit to when autoreplacing.
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:305
bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition: vehicle_base.h:883
byte misc_flags
Miscellaneous flags.
Definition: engine_type.h:142
TileIndex tile
Current tile index.
Definition: vehicle_base.h:230
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
bool IsRearDualheaded() const
Tell if we are dealing with the rear end of a multiheaded engine.
bool renew_keep_length
sell some wagons if after autoreplace the train is longer than before
Road vehicle type.
Definition: vehicle_type.h:27
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
CommandCost CmdSetAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Change engine renewal parameters.
Vehicle * First() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:594
bool Failed() const
Did this command fail?
Definition: command_type.h:161
void ChangeVehicleNews(VehicleID from_index, VehicleID to_index)
Report a change in vehicle IDs (due to autoreplace) to affected vehicle news.
Definition: news_gui.cpp:883
void CheckCargoCapacity(Vehicle *v)
Check the capacity of all vehicles in a chain and spread cargo if needed.
void InvalidateAutoreplaceWindow(EngineID e, GroupID id_g)
Rebuild the left autoreplace list if an engine is removed or added.
autoreplace/autorenew is in progress, this shall disable vehicle limits when building, and ignore certain restrictions when undoing things (like vehicle attach callback)
Definition: command_type.h:352
static bool VerifyAutoreplaceRefitForOrders(const Vehicle *v, EngineID engine_type)
Tests whether refit orders that applied to v will also apply to the new vehicle type.
&#39;Train&#39; is either a loco or a wagon.
Definition: train.h:88
execute the given command
Definition: command_type.h:345
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
Definition: engine_type.h:174
static void TransferCargo(Vehicle *old_veh, Vehicle *new_head, bool part_of_chain)
Transfer cargo from a single (articulated )old vehicle to the new vehicle chain.
static CommandCost CmdStartStopVehicle(const Vehicle *v, bool evaluate_callback)
Issue a start/stop command.
Functions related to companies.
Functions related to articulated vehicles.
add a vehicle to a group
Definition: command_type.h:321
bool NeedsAutorenewing(const Company *c, bool use_renew_setting=true) const
Function to tell if a vehicle needs to be autorenewed.
Definition: vehicle.cpp:142
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:22
CompanyByte _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
Vehicle * Next() const
Get the next vehicle of this vehicle.
Definition: vehicle_base.h:581
OwnerByte owner
Which company owns the vehicle?
Definition: vehicle_base.h:273
turn a train around
Definition: command_type.h:223
void GetArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type, CargoTypes *union_mask, CargoTypes *intersection_mask)
Merges the refit_masks of all articulated parts.
static void UpdateAutoreplace(CompanyID company)
Update autoreplace_defined and autoreplace_finished of all statistics of a company.
Definition: group_cmd.cpp:212
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
uint16 cached_total_length
Length of the whole vehicle (valid only for the first engine).
Valid changes while vehicle is loading/unloading.
Definition: train.h:52
Reverse the visible direction of the vehicle.
Definition: train.h:30
void CopyVehicleConfigAndStatistics(const Vehicle *src)
Copy certain configurations and statistics of a vehicle after successful autoreplace/renew The functi...
Definition: vehicle_base.h:712
Functions related to commands.
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-NULL) Titem.
Definition: pool_type.hpp:235
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:85
New vehicles.
Definition: economy_type.h:152
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:114
CommandCost CmdAutoreplaceVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Autoreplaces a vehicle Trains are replaced as a whole chain, free wagons in depot are replaced on the...
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:288
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
static void SaveRandomSeeds(SavedRandomSeeds *storage)
Saves the current seeds.
Definition: random_func.hpp:44
static CommandCost CmdMoveVehicle(const Vehicle *v, const Vehicle *after, DoCommandFlag flags, bool whole_chain)
Issue a train vehicle move command.
static CommandCost ReplaceFreeUnit(Vehicle **single_unit, DoCommandFlag flags, bool *nothing_to_do)
Replace a single unit in a free wagon chain.
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
Road vehicle is a tram/light rail vehicle.
Definition: engine_type.h:154
Owner
Enum for all companies/owners.
Definition: company_type.h:20
virtual bool IsChainInDepot() const
Check whether the whole vehicle chain is in the depot.
Definition: vehicle_base.h:510
static CommandCost ReplaceChain(Vehicle **chain, DoCommandFlag flags, bool wagon_removal, bool *nothing_to_do)
Replace a whole vehicle chain.
move a rail vehicle (in the depot)
Definition: command_type.h:221
static CommandCost RemoveEngineReplacementForCompany(Company *c, EngineID engine, GroupID group, DoCommandFlag flags)
Remove an engine replacement for the company.
static CommandCost CopyHeadSpecificThings(Vehicle *old_head, Vehicle *new_head, DoCommandFlag flags)
Copy head specific things to the new vehicle chain after it was successfully constructed.
Functions related to autoreplacing.
VehicleTypeByte type
Type of vehicle.
Definition: vehicle_type.h:56
GroupID group_id
Index of group Pool array.
Definition: vehicle_base.h:326
GroundVehicleCache gcache
Cache of often calculated values.
CargoID GetRefitCargo() const
Get the cargo to to refit to.
Definition: order_base.h:124
Train vehicle type.
Definition: vehicle_type.h:26
uint8 max_train_length
maximum length for trains