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