OpenTTD
vehicle_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 "roadveh.h"
14 #include "news_func.h"
15 #include "airport.h"
16 #include "cmd_helper.h"
17 #include "command_func.h"
18 #include "company_func.h"
19 #include "train.h"
20 #include "aircraft.h"
21 #include "newgrf_text.h"
22 #include "vehicle_func.h"
23 #include "string_func.h"
24 #include "depot_map.h"
25 #include "vehiclelist.h"
26 #include "engine_func.h"
27 #include "articulated_vehicles.h"
28 #include "autoreplace_gui.h"
29 #include "group.h"
30 #include "order_backup.h"
31 #include "ship.h"
32 #include "newgrf.h"
33 #include "company_base.h"
34 #include "core/random_func.hpp"
35 
36 #include "table/strings.h"
37 
38 #include "safeguards.h"
39 
40 /* Tables used in vehicle.h to find the right command for a certain vehicle type */
41 const uint32 _veh_build_proc_table[] = {
42  CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN),
43  CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_ROAD_VEHICLE),
44  CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_SHIP),
45  CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_AIRCRAFT),
46 };
47 
48 const uint32 _veh_sell_proc_table[] = {
49  CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_TRAIN),
50  CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_ROAD_VEHICLE),
51  CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_SHIP),
52  CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_AIRCRAFT),
53 };
54 
55 const uint32 _veh_refit_proc_table[] = {
56  CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_TRAIN),
57  CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_ROAD_VEHICLE),
58  CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_SHIP),
59  CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_AIRCRAFT),
60 };
61 
62 const uint32 _send_to_depot_proc_table[] = {
63  CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_TRAIN_TO_DEPOT),
64  CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_ROAD_VEHICLE_TO_DEPOT),
65  CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_SHIP_TO_DEPOT),
66  CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_AIRCRAFT_TO_HANGAR),
67 };
68 
69 
70 CommandCost CmdBuildRailVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
71 CommandCost CmdBuildRoadVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
72 CommandCost CmdBuildShip (TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
73 CommandCost CmdBuildAircraft (TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
74 
75 CommandCost CmdRefitVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text);
76 
89 CommandCost CmdBuildVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
90 {
91  /* Elementary check for valid location. */
92  if (!IsDepotTile(tile) || !IsTileOwner(tile, _current_company)) return CMD_ERROR;
93 
94  VehicleType type = GetDepotVehicleType(tile);
95 
96  /* Validate the engine type. */
97  EngineID eid = GB(p1, 0, 16);
98  if (!IsEngineBuildable(eid, type, _current_company)) return_cmd_error(STR_ERROR_RAIL_VEHICLE_NOT_AVAILABLE + type);
99 
100  /* Validate the cargo type. */
101  CargoID cargo = GB(p1, 24, 8);
102  if (cargo >= NUM_CARGO && cargo != CT_INVALID) return CMD_ERROR;
103 
104  const Engine *e = Engine::Get(eid);
106 
107  /* Engines without valid cargo should not be available */
108  CargoID default_cargo = e->GetDefaultCargoType();
109  if (default_cargo == CT_INVALID) return CMD_ERROR;
110 
111  bool refitting = cargo != CT_INVALID && cargo != default_cargo;
112 
113  /* Check whether the number of vehicles we need to build can be built according to pool space. */
114  uint num_vehicles;
115  switch (type) {
116  case VEH_TRAIN: num_vehicles = (e->u.rail.railveh_type == RAILVEH_MULTIHEAD ? 2 : 1) + CountArticulatedParts(eid, false); break;
117  case VEH_ROAD: num_vehicles = 1 + CountArticulatedParts(eid, false); break;
118  case VEH_SHIP: num_vehicles = 1; break;
119  case VEH_AIRCRAFT: num_vehicles = e->u.air.subtype & AIR_CTOL ? 2 : 3; break;
120  default: NOT_REACHED(); // Safe due to IsDepotTile()
121  }
122  if (!Vehicle::CanAllocateItem(num_vehicles)) return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
123 
124  /* Check whether we can allocate a unit number. Autoreplace does not allocate
125  * an unit number as it will (always) reuse the one of the replaced vehicle
126  * and (train) wagons don't have an unit number in any scenario. */
127  UnitID unit_num = (flags & DC_AUTOREPLACE || (type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON)) ? 0 : GetFreeUnitNumber(type);
128  if (unit_num == UINT16_MAX) return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
129 
130  /* If we are refitting we need to temporarily purchase the vehicle to be able to
131  * test it. */
132  DoCommandFlag subflags = flags;
133  if (refitting) subflags |= DC_EXEC;
134 
135  /* Vehicle construction needs random bits, so we have to save the random
136  * seeds to prevent desyncs. */
137  SavedRandomSeeds saved_seeds;
138  SaveRandomSeeds(&saved_seeds);
139 
140  Vehicle *v = nullptr;
141  switch (type) {
142  case VEH_TRAIN: value.AddCost(CmdBuildRailVehicle(tile, subflags, e, GB(p1, 16, 8), &v)); break;
143  case VEH_ROAD: value.AddCost(CmdBuildRoadVehicle(tile, subflags, e, GB(p1, 16, 8), &v)); break;
144  case VEH_SHIP: value.AddCost(CmdBuildShip (tile, subflags, e, GB(p1, 16, 8), &v)); break;
145  case VEH_AIRCRAFT: value.AddCost(CmdBuildAircraft (tile, subflags, e, GB(p1, 16, 8), &v)); break;
146  default: NOT_REACHED(); // Safe due to IsDepotTile()
147  }
148 
149  if (value.Succeeded()) {
150  if (refitting || (flags & DC_EXEC)) {
151  v->unitnumber = unit_num;
152  v->value = value.GetCost();
153  }
154 
155  if (refitting) {
156  value.AddCost(CmdRefitVehicle(tile, flags, v->index, cargo, nullptr));
157  } else {
158  /* Fill in non-refitted capacities */
160  }
161 
162  if (flags & DC_EXEC) {
166  if (IsLocalCompany()) {
167  InvalidateAutoreplaceWindow(v->engine_type, v->group_id); // updates the auto replace window (must be called before incrementing num_engines)
168  }
169  }
170 
171  if (refitting || (flags & DC_EXEC)) {
174 
175  if (v->IsPrimaryVehicle()) {
177  OrderBackup::Restore(v, p2);
178  }
179  }
180 
181 
182  /* If we are not in DC_EXEC undo everything */
183  if (refitting && (flags & DC_EXEC) == 0) {
184  DoCommand(0, v->index, 0, DC_EXEC, GetCmdSellVeh(v));
185  }
186  }
187 
188  /* Only restore if we actually did some refitting */
189  if (flags != subflags) RestoreRandomSeeds(saved_seeds);
190 
191  return value;
192 }
193 
194 CommandCost CmdSellRailWagon(DoCommandFlag flags, Vehicle *v, uint16 data, uint32 user);
195 
208 CommandCost CmdSellVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
209 {
210  Vehicle *v = Vehicle::GetIfValid(GB(p1, 0, 20));
211  if (v == nullptr) return CMD_ERROR;
212 
213  Vehicle *front = v->First();
214 
215  CommandCost ret = CheckOwnership(front->owner);
216  if (ret.Failed()) return ret;
217 
218  if (front->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
219 
220  if (!front->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAIN_MUST_BE_STOPPED_INSIDE_DEPOT + front->type);
221 
222  /* Can we actually make the order backup, i.e. are there enough orders? */
223  if (p1 & MAKE_ORDER_BACKUP_FLAG &&
224  front->orders.list != nullptr &&
225  !front->orders.list->IsShared() &&
227  /* Only happens in exceptional cases when there aren't enough orders anyhow.
228  * Thus it should be safe to just drop the orders in that case. */
229  p1 &= ~MAKE_ORDER_BACKUP_FLAG;
230  }
231 
232  if (v->type == VEH_TRAIN) {
233  ret = CmdSellRailWagon(flags, v, GB(p1, 20, 12), p2);
234  } else {
235  ret = CommandCost(EXPENSES_NEW_VEHICLES, -front->value);
236 
237  if (flags & DC_EXEC) {
238  if (front->IsPrimaryVehicle() && p1 & MAKE_ORDER_BACKUP_FLAG) OrderBackup::Backup(front, p2);
239  delete front;
240  }
241  }
242 
243  return ret;
244 }
245 
255 static int GetRefitCostFactor(const Vehicle *v, EngineID engine_type, CargoID new_cid, byte new_subtype, bool *auto_refit_allowed)
256 {
257  /* Prepare callback param with info about the new cargo type. */
258  const Engine *e = Engine::Get(engine_type);
259 
260  /* Is this vehicle a NewGRF vehicle? */
261  if (e->GetGRF() != nullptr) {
262  const CargoSpec *cs = CargoSpec::Get(new_cid);
263  uint32 param1 = (cs->classes << 16) | (new_subtype << 8) | e->GetGRF()->cargo_map[new_cid];
264 
265  uint16 cb_res = GetVehicleCallback(CBID_VEHICLE_REFIT_COST, param1, 0, engine_type, v);
266  if (cb_res != CALLBACK_FAILED) {
267  *auto_refit_allowed = HasBit(cb_res, 14);
268  int factor = GB(cb_res, 0, 14);
269  if (factor >= 0x2000) factor -= 0x4000; // Treat as signed integer.
270  return factor;
271  }
272  }
273 
274  *auto_refit_allowed = e->info.refit_cost == 0;
275  return (v == nullptr || v->cargo_type != new_cid) ? e->info.refit_cost : 0;
276 }
277 
287 static CommandCost GetRefitCost(const Vehicle *v, EngineID engine_type, CargoID new_cid, byte new_subtype, bool *auto_refit_allowed)
288 {
289  ExpensesType expense_type;
290  const Engine *e = Engine::Get(engine_type);
291  Price base_price;
292  int cost_factor = GetRefitCostFactor(v, engine_type, new_cid, new_subtype, auto_refit_allowed);
293  switch (e->type) {
294  case VEH_SHIP:
295  base_price = PR_BUILD_VEHICLE_SHIP;
296  expense_type = EXPENSES_SHIP_RUN;
297  break;
298 
299  case VEH_ROAD:
300  base_price = PR_BUILD_VEHICLE_ROAD;
301  expense_type = EXPENSES_ROADVEH_RUN;
302  break;
303 
304  case VEH_AIRCRAFT:
305  base_price = PR_BUILD_VEHICLE_AIRCRAFT;
306  expense_type = EXPENSES_AIRCRAFT_RUN;
307  break;
308 
309  case VEH_TRAIN:
310  base_price = (e->u.rail.railveh_type == RAILVEH_WAGON) ? PR_BUILD_VEHICLE_WAGON : PR_BUILD_VEHICLE_TRAIN;
311  cost_factor <<= 1;
312  expense_type = EXPENSES_TRAIN_RUN;
313  break;
314 
315  default: NOT_REACHED();
316  }
317  if (cost_factor < 0) {
318  return CommandCost(expense_type, -GetPrice(base_price, -cost_factor, e->GetGRF(), -10));
319  } else {
320  return CommandCost(expense_type, GetPrice(base_price, cost_factor, e->GetGRF(), -10));
321  }
322 }
323 
325 struct RefitResult {
327  uint capacity;
329  byte subtype;
330 };
331 
344 static CommandCost RefitVehicle(Vehicle *v, bool only_this, uint8 num_vehicles, CargoID new_cid, byte new_subtype, DoCommandFlag flags, bool auto_refit)
345 {
346  CommandCost cost(v->GetExpenseType(false));
347  uint total_capacity = 0;
348  uint total_mail_capacity = 0;
349  num_vehicles = num_vehicles == 0 ? UINT8_MAX : num_vehicles;
350 
351  VehicleSet vehicles_to_refit;
352  if (!only_this) {
353  GetVehicleSet(vehicles_to_refit, v, num_vehicles);
354  /* In this case, we need to check the whole chain. */
355  v = v->First();
356  }
357 
358  std::vector<RefitResult> refit_result;
359 
361  byte actual_subtype = new_subtype;
362  for (; v != nullptr; v = (only_this ? nullptr : v->Next())) {
363  /* Reset actual_subtype for every new vehicle */
364  if (!v->IsArticulatedPart()) actual_subtype = new_subtype;
365 
366  if (v->type == VEH_TRAIN && std::find(vehicles_to_refit.begin(), vehicles_to_refit.end(), v->index) == vehicles_to_refit.end() && !only_this) continue;
367 
368  const Engine *e = v->GetEngine();
369  if (!e->CanCarryCargo()) continue;
370 
371  /* If the vehicle is not refittable, or does not allow automatic refitting,
372  * count its capacity nevertheless if the cargo matches */
373  bool refittable = HasBit(e->info.refit_mask, new_cid) && (!auto_refit || HasBit(e->info.misc_flags, EF_AUTO_REFIT));
374  if (!refittable && v->cargo_type != new_cid) continue;
375 
376  /* Determine best fitting subtype if requested */
377  if (actual_subtype == 0xFF) {
378  actual_subtype = GetBestFittingSubType(v, v, new_cid);
379  }
380 
381  /* Back up the vehicle's cargo type */
382  CargoID temp_cid = v->cargo_type;
383  byte temp_subtype = v->cargo_subtype;
384  if (refittable) {
385  v->cargo_type = new_cid;
386  v->cargo_subtype = actual_subtype;
387  }
388 
389  uint16 mail_capacity = 0;
390  uint amount = e->DetermineCapacity(v, &mail_capacity);
391  total_capacity += amount;
392  /* mail_capacity will always be zero if the vehicle is not an aircraft. */
393  total_mail_capacity += mail_capacity;
394 
395  if (!refittable) continue;
396 
397  /* Restore the original cargo type */
398  v->cargo_type = temp_cid;
399  v->cargo_subtype = temp_subtype;
400 
401  bool auto_refit_allowed;
402  CommandCost refit_cost = GetRefitCost(v, v->engine_type, new_cid, actual_subtype, &auto_refit_allowed);
403  if (auto_refit && (flags & DC_QUERY_COST) == 0 && !auto_refit_allowed) {
404  /* Sorry, auto-refitting not allowed, subtract the cargo amount again from the total.
405  * When querrying cost/capacity (for example in order refit GUI), we always assume 'allowed'.
406  * It is not predictable. */
407  total_capacity -= amount;
408  total_mail_capacity -= mail_capacity;
409 
410  if (v->cargo_type == new_cid) {
411  /* Add the old capacity nevertheless, if the cargo matches */
412  total_capacity += v->cargo_cap;
413  if (v->type == VEH_AIRCRAFT) total_mail_capacity += v->Next()->cargo_cap;
414  }
415  continue;
416  }
417  cost.AddCost(refit_cost);
418 
419  /* Record the refitting.
420  * Do not execute the refitting immediately, so DetermineCapacity and GetRefitCost do the same in test and exec run.
421  * (weird NewGRFs)
422  * Note:
423  * - If the capacity of vehicles depends on other vehicles in the chain, the actual capacity is
424  * set after RefitVehicle() via ConsistChanged() and friends. The estimation via _returned_refit_capacity will be wrong.
425  * - We have to call the refit cost callback with the pre-refit configuration of the chain because we want refit and
426  * autorefit to behave the same, and we need its result for auto_refit_allowed.
427  */
428  refit_result.push_back({v, amount, mail_capacity, actual_subtype});
429  }
430 
431  if (flags & DC_EXEC) {
432  /* Store the result */
433  for (RefitResult &result : refit_result) {
434  Vehicle *u = result.v;
435  u->refit_cap = (u->cargo_type == new_cid) ? min(result.capacity, u->refit_cap) : 0;
436  if (u->cargo.TotalCount() > u->refit_cap) u->cargo.Truncate(u->cargo.TotalCount() - u->refit_cap);
437  u->cargo_type = new_cid;
438  u->cargo_cap = result.capacity;
439  u->cargo_subtype = result.subtype;
440  if (u->type == VEH_AIRCRAFT) {
441  Vehicle *w = u->Next();
442  w->refit_cap = min(w->refit_cap, result.mail_capacity);
443  w->cargo_cap = result.mail_capacity;
444  if (w->cargo.TotalCount() > w->refit_cap) w->cargo.Truncate(w->cargo.TotalCount() - w->refit_cap);
445  }
446  }
447  }
448 
449  refit_result.clear();
450  _returned_refit_capacity = total_capacity;
451  _returned_mail_refit_capacity = total_mail_capacity;
452  return cost;
453 }
454 
470 CommandCost CmdRefitVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
471 {
472  Vehicle *v = Vehicle::GetIfValid(p1);
473  if (v == nullptr) return CMD_ERROR;
474 
475  /* Don't allow disasters and sparks and such to be refitted.
476  * We cannot check for IsPrimaryVehicle as autoreplace also refits in free wagon chains. */
478 
479  Vehicle *front = v->First();
480 
481  CommandCost ret = CheckOwnership(front->owner);
482  if (ret.Failed()) return ret;
483 
484  bool auto_refit = HasBit(p2, 24);
485  bool free_wagon = v->type == VEH_TRAIN && Train::From(front)->IsFreeWagon(); // used by autoreplace/renew
486 
487  /* Don't allow shadows and such to be refitted. */
488  if (v != front && (v->type == VEH_SHIP || v->type == VEH_AIRCRAFT)) return CMD_ERROR;
489 
490  /* Allow auto-refitting only during loading and normal refitting only in a depot. */
491  if ((flags & DC_QUERY_COST) == 0 && // used by the refit GUI, including the order refit GUI.
492  !free_wagon && // used by autoreplace/renew
493  (!auto_refit || !front->current_order.IsType(OT_LOADING)) && // refit inside stations
494  !front->IsStoppedInDepot()) { // refit inside depots
495  return_cmd_error(STR_ERROR_TRAIN_MUST_BE_STOPPED_INSIDE_DEPOT + front->type);
496  }
497 
498  if (front->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
499 
500  /* Check cargo */
501  CargoID new_cid = GB(p2, 0, 8);
502  byte new_subtype = GB(p2, 8, 8);
503  if (new_cid >= NUM_CARGO) return CMD_ERROR;
504 
505  /* For ships and aircraft there is always only one. */
506  bool only_this = HasBit(p2, 25) || front->type == VEH_SHIP || front->type == VEH_AIRCRAFT;
507  uint8 num_vehicles = GB(p2, 16, 8);
508 
509  CommandCost cost = RefitVehicle(v, only_this, num_vehicles, new_cid, new_subtype, flags, auto_refit);
510 
511  if (flags & DC_EXEC) {
512  /* Update the cached variables */
513  switch (v->type) {
514  case VEH_TRAIN:
515  Train::From(front)->ConsistChanged(auto_refit ? CCF_AUTOREFIT : CCF_REFIT);
516  break;
517  case VEH_ROAD:
518  RoadVehUpdateCache(RoadVehicle::From(front), auto_refit);
520  break;
521 
522  case VEH_SHIP:
524  Ship::From(v)->UpdateCache();
525  break;
526 
527  case VEH_AIRCRAFT:
530  break;
531 
532  default: NOT_REACHED();
533  }
534  front->MarkDirty();
535 
536  if (!free_wagon) {
539  }
541  } else {
542  /* Always invalidate the cache; querycost might have filled it. */
544  }
545 
546  return cost;
547 }
548 
558 CommandCost CmdStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
559 {
560  /* Disable the effect of p2 bit 0, when DC_AUTOREPLACE is not set */
561  if ((flags & DC_AUTOREPLACE) == 0) SetBit(p2, 0);
562 
563  Vehicle *v = Vehicle::GetIfValid(p1);
564  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
565 
566  CommandCost ret = CheckOwnership(v->owner);
567  if (ret.Failed()) return ret;
568 
569  if (v->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
570 
571  switch (v->type) {
572  case VEH_TRAIN:
573  if ((v->vehstatus & VS_STOPPED) && Train::From(v)->gcache.cached_power == 0) return_cmd_error(STR_ERROR_TRAIN_START_NO_POWER);
574  break;
575 
576  case VEH_SHIP:
577  case VEH_ROAD:
578  break;
579 
580  case VEH_AIRCRAFT: {
581  Aircraft *a = Aircraft::From(v);
582  /* cannot stop airplane when in flight, or when taking off / landing */
583  if (a->state >= STARTTAKEOFF && a->state < TERM7) return_cmd_error(STR_ERROR_AIRCRAFT_IS_IN_FLIGHT);
584  if (HasBit(a->flags, VAF_HELI_DIRECT_DESCENT)) return_cmd_error(STR_ERROR_AIRCRAFT_IS_IN_FLIGHT);
585  break;
586  }
587 
588  default: return CMD_ERROR;
589  }
590 
591  if (HasBit(p2, 0)) {
592  /* Check if this vehicle can be started/stopped. Failure means 'allow'. */
593  uint16 callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);
594  StringID error = STR_NULL;
595  if (callback != CALLBACK_FAILED) {
596  if (v->GetGRF()->grf_version < 8) {
597  /* 8 bit result 0xFF means 'allow' */
598  if (callback < 0x400 && GB(callback, 0, 8) != 0xFF) error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
599  } else {
600  if (callback < 0x400) {
601  error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
602  } else {
603  switch (callback) {
604  case 0x400: // allow
605  break;
606 
607  default: // unknown reason -> disallow
608  error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
609  break;
610  }
611  }
612  }
613  }
614  if (error != STR_NULL) return_cmd_error(error);
615  }
616 
617  if (flags & DC_EXEC) {
618  if (v->IsStoppedInDepot() && (flags & DC_AUTOREPLACE) == 0) DeleteVehicleNews(p1, STR_NEWS_TRAIN_IS_WAITING + v->type);
619 
620  v->vehstatus ^= VS_STOPPED;
621  if (v->type != VEH_TRAIN) v->cur_speed = 0; // trains can stop 'slowly'
622  v->MarkDirty();
627  }
628  return CommandCost();
629 }
630 
642 CommandCost CmdMassStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
643 {
644  VehicleList list;
645  bool do_start = HasBit(p1, 0);
646  bool vehicle_list_window = HasBit(p1, 1);
647 
649  if (!vli.UnpackIfValid(p2)) return CMD_ERROR;
651 
652  if (vehicle_list_window) {
653  if (!GenerateVehicleSortList(&list, vli)) return CMD_ERROR;
654  } else {
655  /* Get the list of vehicles in the depot */
656  BuildDepotVehicleList(vli.vtype, tile, &list, nullptr);
657  }
658 
659  for (uint i = 0; i < list.size(); i++) {
660  const Vehicle *v = list[i];
661 
662  if (!!(v->vehstatus & VS_STOPPED) != do_start) continue;
663 
664  if (!vehicle_list_window && !v->IsChainInDepot()) continue;
665 
666  /* Just try and don't care if some vehicle's can't be stopped. */
667  DoCommand(tile, v->index, 0, flags, CMD_START_STOP_VEHICLE);
668  }
669 
670  return CommandCost();
671 }
672 
682 CommandCost CmdDepotSellAllVehicles(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
683 {
684  VehicleList list;
685 
687  VehicleType vehicle_type = Extract<VehicleType, 0, 3>(p1);
688 
689  if (!IsCompanyBuildableVehicleType(vehicle_type)) return CMD_ERROR;
690 
691  uint sell_command = GetCmdSellVeh(vehicle_type);
692 
693  /* Get the list of vehicles in the depot */
694  BuildDepotVehicleList(vehicle_type, tile, &list, &list);
695 
696  CommandCost last_error = CMD_ERROR;
697  bool had_success = false;
698  for (uint i = 0; i < list.size(); i++) {
699  CommandCost ret = DoCommand(tile, list[i]->index | (1 << 20), 0, flags, sell_command);
700  if (ret.Succeeded()) {
701  cost.AddCost(ret);
702  had_success = true;
703  } else {
704  last_error = ret;
705  }
706  }
707 
708  return had_success ? cost : last_error;
709 }
710 
720 CommandCost CmdDepotMassAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
721 {
722  VehicleList list;
724  VehicleType vehicle_type = Extract<VehicleType, 0, 3>(p1);
725 
726  if (!IsCompanyBuildableVehicleType(vehicle_type)) return CMD_ERROR;
727  if (!IsDepotTile(tile) || !IsTileOwner(tile, _current_company)) return CMD_ERROR;
728 
729  /* Get the list of vehicles in the depot */
730  BuildDepotVehicleList(vehicle_type, tile, &list, &list, true);
731 
732  for (uint i = 0; i < list.size(); i++) {
733  const Vehicle *v = list[i];
734 
735  /* Ensure that the vehicle completely in the depot */
736  if (!v->IsChainInDepot()) continue;
737 
738  CommandCost ret = DoCommand(0, v->index, 0, flags, CMD_AUTOREPLACE_VEHICLE);
739 
740  if (ret.Succeeded()) cost.AddCost(ret);
741  }
742  return cost;
743 }
744 
750 static bool IsUniqueVehicleName(const char *name)
751 {
752  const Vehicle *v;
753 
754  FOR_ALL_VEHICLES(v) {
755  if (v->name != nullptr && strcmp(v->name, name) == 0) return false;
756  }
757 
758  return true;
759 }
760 
766 static void CloneVehicleName(const Vehicle *src, Vehicle *dst)
767 {
768  char buf[256];
769 
770  /* Find the position of the first digit in the last group of digits. */
771  size_t number_position;
772  for (number_position = strlen(src->name); number_position > 0; number_position--) {
773  /* The design of UTF-8 lets this work simply without having to check
774  * for UTF-8 sequences. */
775  if (src->name[number_position - 1] < '0' || src->name[number_position - 1] > '9') break;
776  }
777 
778  /* Format buffer and determine starting number. */
779  int num;
780  byte padding = 0;
781  if (number_position == strlen(src->name)) {
782  /* No digit at the end, so start at number 2. */
783  strecpy(buf, src->name, lastof(buf));
784  strecat(buf, " ", lastof(buf));
785  number_position = strlen(buf);
786  num = 2;
787  } else {
788  /* Found digits, parse them and start at the next number. */
789  strecpy(buf, src->name, lastof(buf));
790  buf[number_position] = '\0';
791  char *endptr;
792  num = strtol(&src->name[number_position], &endptr, 10) + 1;
793  padding = endptr - &src->name[number_position];
794  }
795 
796  /* Check if this name is already taken. */
797  for (int max_iterations = 1000; max_iterations > 0; max_iterations--, num++) {
798  /* Attach the number to the temporary name. */
799  seprintf(&buf[number_position], lastof(buf), "%0*d", padding, num);
800 
801  /* Check the name is unique. */
802  if (IsUniqueVehicleName(buf)) {
803  dst->name = stredup(buf);
804  break;
805  }
806  }
807 
808  /* All done. If we didn't find a name, it'll just use its default. */
809 }
810 
820 CommandCost CmdCloneVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
821 {
823 
824  Vehicle *v = Vehicle::GetIfValid(p1);
825  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
826  Vehicle *v_front = v;
827  Vehicle *w = nullptr;
828  Vehicle *w_front = nullptr;
829  Vehicle *w_rear = nullptr;
830 
831  /*
832  * v_front is the front engine in the original vehicle
833  * v is the car/vehicle of the original vehicle that is currently being copied
834  * w_front is the front engine of the cloned vehicle
835  * w is the car/vehicle currently being cloned
836  * w_rear is the rear end of the cloned train. It's used to add more cars and is only used by trains
837  */
838 
839  CommandCost ret = CheckOwnership(v->owner);
840  if (ret.Failed()) return ret;
841 
842  if (v->type == VEH_TRAIN && (!v->IsFrontEngine() || Train::From(v)->crash_anim_pos >= 4400)) return CMD_ERROR;
843 
844  /* check that we can allocate enough vehicles */
845  if (!(flags & DC_EXEC)) {
846  int veh_counter = 0;
847  do {
848  veh_counter++;
849  } while ((v = v->Next()) != nullptr);
850 
851  if (!Vehicle::CanAllocateItem(veh_counter)) {
852  return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
853  }
854  }
855 
856  v = v_front;
857 
858  do {
859  if (v->type == VEH_TRAIN && Train::From(v)->IsRearDualheaded()) {
860  /* we build the rear ends of multiheaded trains with the front ones */
861  continue;
862  }
863 
864  /* In case we're building a multi headed vehicle and the maximum number of
865  * vehicles is almost reached (e.g. max trains - 1) not all vehicles would
866  * be cloned. When the non-primary engines were build they were seen as
867  * 'new' vehicles whereas they would immediately be joined with a primary
868  * engine. This caused the vehicle to be not build as 'the limit' had been
869  * reached, resulting in partially build vehicles and such. */
870  DoCommandFlag build_flags = flags;
871  if ((flags & DC_EXEC) && !v->IsPrimaryVehicle()) build_flags |= DC_AUTOREPLACE;
872 
873  CommandCost cost = DoCommand(tile, v->engine_type | (1 << 16) | (CT_INVALID << 24), 0, build_flags, GetCmdBuildVeh(v));
874 
875  if (cost.Failed()) {
876  /* Can't build a part, then sell the stuff we already made; clear up the mess */
877  if (w_front != nullptr) DoCommand(w_front->tile, w_front->index | (1 << 20), 0, flags, GetCmdSellVeh(w_front));
878  return cost;
879  }
880 
881  total_cost.AddCost(cost);
882 
883  if (flags & DC_EXEC) {
884  w = Vehicle::Get(_new_vehicle_id);
885 
886  if (v->type == VEH_TRAIN && HasBit(Train::From(v)->flags, VRF_REVERSE_DIRECTION)) {
888  }
889 
890  if (v->type == VEH_TRAIN && !v->IsFrontEngine()) {
891  /* this s a train car
892  * add this unit to the end of the train */
893  CommandCost result = DoCommand(0, w->index | 1 << 20, w_rear->index, flags, CMD_MOVE_RAIL_VEHICLE);
894  if (result.Failed()) {
895  /* The train can't be joined to make the same consist as the original.
896  * Sell what we already made (clean up) and return an error. */
897  DoCommand(w_front->tile, w_front->index | 1 << 20, 0, flags, GetCmdSellVeh(w_front));
898  DoCommand(w_front->tile, w->index | 1 << 20, 0, flags, GetCmdSellVeh(w));
899  return result; // return error and the message returned from CMD_MOVE_RAIL_VEHICLE
900  }
901  } else {
902  /* this is a front engine or not a train. */
903  w_front = w;
905  w->SetServiceIntervalIsCustom(v->ServiceIntervalIsCustom());
906  w->SetServiceIntervalIsPercent(v->ServiceIntervalIsPercent());
907  }
908  w_rear = w; // trains needs to know the last car in the train, so they can add more in next loop
909  }
910  } while (v->type == VEH_TRAIN && (v = v->GetNextVehicle()) != nullptr);
911 
912  if ((flags & DC_EXEC) && v_front->type == VEH_TRAIN) {
913  /* for trains this needs to be the front engine due to the callback function */
914  _new_vehicle_id = w_front->index;
915  }
916 
917  if (flags & DC_EXEC) {
918  /* Cloned vehicles belong to the same group */
919  DoCommand(0, v_front->group_id, w_front->index, flags, CMD_ADD_VEHICLE_GROUP);
920  }
921 
922 
923  /* Take care of refitting. */
924  w = w_front;
925  v = v_front;
926 
927  /* Both building and refitting are influenced by newgrf callbacks, which
928  * makes it impossible to accurately estimate the cloning costs. In
929  * particular, it is possible for engines of the same type to be built with
930  * different numbers of articulated parts, so when refitting we have to
931  * loop over real vehicles first, and then the articulated parts of those
932  * vehicles in a different loop. */
933  do {
934  do {
935  if (flags & DC_EXEC) {
936  assert(w != nullptr);
937 
938  /* Find out what's the best sub type */
939  byte subtype = GetBestFittingSubType(v, w, v->cargo_type);
940  if (w->cargo_type != v->cargo_type || w->cargo_subtype != subtype) {
941  CommandCost cost = DoCommand(0, w->index, v->cargo_type | 1U << 25 | (subtype << 8), flags, GetCmdRefitVeh(v));
942  if (cost.Succeeded()) total_cost.AddCost(cost);
943  }
944 
945  if (w->IsGroundVehicle() && w->HasArticulatedPart()) {
946  w = w->GetNextArticulatedPart();
947  } else {
948  break;
949  }
950  } else {
951  const Engine *e = v->GetEngine();
952  CargoID initial_cargo = (e->CanCarryCargo() ? e->GetDefaultCargoType() : (CargoID)CT_INVALID);
953 
954  if (v->cargo_type != initial_cargo && initial_cargo != CT_INVALID) {
955  bool dummy;
956  total_cost.AddCost(GetRefitCost(nullptr, v->engine_type, v->cargo_type, v->cargo_subtype, &dummy));
957  }
958  }
959 
960  if (v->IsGroundVehicle() && v->HasArticulatedPart()) {
961  v = v->GetNextArticulatedPart();
962  } else {
963  break;
964  }
965  } while (v != nullptr);
966 
967  if ((flags & DC_EXEC) && v->type == VEH_TRAIN) w = w->GetNextVehicle();
968  } while (v->type == VEH_TRAIN && (v = v->GetNextVehicle()) != nullptr);
969 
970  if (flags & DC_EXEC) {
971  /*
972  * Set the orders of the vehicle. Cannot do it earlier as we need
973  * the vehicle refitted before doing this, otherwise the moved
974  * cargo types might not match (passenger vs non-passenger)
975  */
976  DoCommand(0, w_front->index | (p2 & 1 ? CO_SHARE : CO_COPY) << 30, v_front->index, flags, CMD_CLONE_ORDER);
977 
978  /* Now clone the vehicle's name, if it has one. */
979  if (v_front->name != nullptr) CloneVehicleName(v_front, w_front);
980  }
981 
982  /* Since we can't estimate the cost of cloning a vehicle accurately we must
983  * check whether the company has enough money manually. */
984  if (!CheckCompanyHasMoney(total_cost)) {
985  if (flags & DC_EXEC) {
986  /* The vehicle has already been bought, so now it must be sold again. */
987  DoCommand(w_front->tile, w_front->index | 1 << 20, 0, flags, GetCmdSellVeh(w_front));
988  }
989  return total_cost;
990  }
991 
992  return total_cost;
993 }
994 
1003 {
1004  VehicleList list;
1005 
1006  if (!GenerateVehicleSortList(&list, vli)) return CMD_ERROR;
1007 
1008  /* Send all the vehicles to a depot */
1009  bool had_success = false;
1010  for (uint i = 0; i < list.size(); i++) {
1011  const Vehicle *v = list[i];
1012  CommandCost ret = DoCommand(v->tile, v->index | (service ? DEPOT_SERVICE : 0U) | DEPOT_DONT_CANCEL, 0, flags, GetCmdSendToDepot(vli.vtype));
1013 
1014  if (ret.Succeeded()) {
1015  had_success = true;
1016 
1017  /* Return 0 if DC_EXEC is not set this is a valid goto depot command)
1018  * In this case we know that at least one vehicle can be sent to a depot
1019  * and we will issue the command. We can now safely quit the loop, knowing
1020  * it will succeed at least once. With DC_EXEC we really need to send them to the depot */
1021  if (!(flags & DC_EXEC)) break;
1022  }
1023  }
1024 
1025  return had_success ? CommandCost() : CMD_ERROR;
1026 }
1027 
1039 CommandCost CmdSendVehicleToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1040 {
1041  if (p1 & DEPOT_MASS_SEND) {
1042  /* Mass goto depot requested */
1044  if (!vli.UnpackIfValid(p2)) return CMD_ERROR;
1045  return SendAllVehiclesToDepot(flags, (p1 & DEPOT_SERVICE) != 0, vli);
1046  }
1047 
1048  Vehicle *v = Vehicle::GetIfValid(GB(p1, 0, 20));
1049  if (v == nullptr) return CMD_ERROR;
1050  if (!v->IsPrimaryVehicle()) return CMD_ERROR;
1051 
1052  return v->SendToDepot(flags, (DepotCommand)(p1 & DEPOT_COMMAND_MASK));
1053 }
1054 
1064 CommandCost CmdRenameVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1065 {
1066  Vehicle *v = Vehicle::GetIfValid(p1);
1067  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1068 
1069  CommandCost ret = CheckOwnership(v->owner);
1070  if (ret.Failed()) return ret;
1071 
1072  bool reset = StrEmpty(text);
1073 
1074  if (!reset) {
1076  if (!(flags & DC_AUTOREPLACE) && !IsUniqueVehicleName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
1077  }
1078 
1079  if (flags & DC_EXEC) {
1080  free(v->name);
1081  v->name = reset ? nullptr : stredup(text);
1084  }
1085 
1086  return CommandCost();
1087 }
1088 
1089 
1102 CommandCost CmdChangeServiceInt(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1103 {
1104  Vehicle *v = Vehicle::GetIfValid(p1);
1105  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1106 
1107  CommandCost ret = CheckOwnership(v->owner);
1108  if (ret.Failed()) return ret;
1109 
1110  const Company *company = Company::Get(v->owner);
1111  bool iscustom = HasBit(p2, 16);
1112  bool ispercent = iscustom ? HasBit(p2, 17) : company->settings.vehicle.servint_ispercent;
1113 
1114  uint16 serv_int;
1115  if (iscustom) {
1116  serv_int = GB(p2, 0, 16);
1117  if (serv_int != GetServiceIntervalClamped(serv_int, ispercent)) return CMD_ERROR;
1118  } else {
1119  serv_int = CompanyServiceInterval(company, v->type);
1120  }
1121 
1122  if (flags & DC_EXEC) {
1123  v->SetServiceInterval(serv_int);
1124  v->SetServiceIntervalIsCustom(iscustom);
1125  v->SetServiceIntervalIsPercent(ispercent);
1127  }
1128 
1129  return CommandCost();
1130 }
bool IsEngineBuildable(EngineID engine, VehicleType type, CompanyID company)
Check if an engine is buildable.
Definition: engine.cpp:1078
Road vehicle states.
CommandCost CmdBuildShip(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v)
Build a ship.
Definition: ship_cmd.cpp:828
VehicleSettings vehicle
options for vehicles
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
int CompanyServiceInterval(const Company *c, VehicleType type)
Get the service interval for the given company and vehicle type.
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:81
Definition of stuff that is very close to a company, like the company struct itself.
CommandCost CmdBuildVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Build a vehicle.
Definition: vehicle_cmd.cpp:89
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:257
Money value
Value of the vehicle.
Definition: vehicle_base.h:241
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
virtual void MarkDirty()
Marks the vehicles to be redrawn and updates cached variables.
Definition: vehicle_base.h:364
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:3199
static char * strecat(char *dst, const char *src, const char *last)
Appends characters from one string to another.
Definition: depend.cpp:99
Functions related to the autoreplace GUIs.
uint16 GetServiceIntervalClamped(uint interval, bool ispercent)
Clamp the service interval to the correct min/max.
Definition: order_cmd.cpp:1920
Don&#39;t cancel current goto depot command if any.
Definition: vehicle_type.h:70
Functions and type for generating vehicle lists.
CommandCost CmdSellRailWagon(DoCommandFlag flags, Vehicle *v, uint16 data, uint32 user)
Sell a (single) train wagon/engine.
Definition: train_cmd.cpp:1349
Train vehicle type.
Definition: vehicle_type.h:26
union Vehicle::@49 orders
The orders currently assigned to the vehicle.
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:94
Vehicle * v
Vehicle to refit.
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:409
Helper structure for RefitVehicle()
Base for the train class.
Stores the state of all random number generators.
Definition: random_func.hpp:35
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
uint16 cur_speed
current speed
Definition: vehicle_base.h:293
query cost only, don&#39;t build.
Definition: command_type.h:348
uint Truncate(uint max_move=UINT_MAX)
Truncates the cargo in this list to the given amount.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:25
Ship vehicle type.
Definition: vehicle_type.h:28
Depot view; Window numbers:
Definition: window_type.h:346
Base class for groups and group functions.
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
bool CheckCompanyHasMoney(CommandCost &cost)
Verify whether the company can pay the bill.
uint16 _returned_refit_capacity
Stores the capacity after a refit operation.
Definition: vehicle.cpp:87
Specification of a cargo type.
Definition: cargotype.h:57
VehicleType
Available vehicle types.
Definition: vehicle_type.h:23
OrderList * list
Pointer to the order list for this vehicle.
Definition: vehicle_base.h:321
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.
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition: aircraft.h:76
CommandCost CmdDepotSellAllVehicles(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Sells all vehicles in a depot.
Called when the company (or AI) tries to start or stop a vehicle.
Price
Enumeration of all base prices for use with Prices.
Definition: economy_type.h:67
Vehicle data structure.
Definition: vehicle_base.h:212
bool UnpackIfValid(uint32 data)
Unpack a VehicleListIdentifier from a single uint32.
Definition: vehiclelist.cpp:40
static int GetRefitCostFactor(const Vehicle *v, EngineID engine_type, CargoID new_cid, byte new_subtype, bool *auto_refit_allowed)
Helper to run the refit cost callback.
Start or stop this vehicle, and show information about the current state.
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
uint TotalCount() const
Returns sum of cargo, including reserved cargo.
Definition: cargopacket.h:375
Helper functions to extract data from command parameters.
void BuildDepotVehicleList(VehicleType type, TileIndex tile, VehicleList *engines, VehicleList *wagons, bool individual_wagons)
Generate a list of vehicles inside a depot.
Definition: vehiclelist.cpp:71
bool GenerateVehicleSortList(VehicleList *list, const VehicleListIdentifier &vli)
Generate a list of vehicles based on window type.
Base for aircraft.
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
clone (and share) an order
Definition: command_type.h:272
StringID GetGRFStringID(uint32 grfid, StringID stringid)
Returns the index for this stringid associated with its grfID.
void CargoChanged()
Recalculates the cached weight of a vehicle and its parts.
Common return value for all commands.
Definition: command_type.h:25
uint32 cached_power
Total power of the consist (valid only for the first engine).
CommandCost CmdMassStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Starts or stops a lot of vehicles.
uint16 classes
Classes of this cargo type.
Definition: cargotype.h:80
byte vehstatus
Status.
Definition: vehicle_base.h:317
UnitID GetFreeUnitNumber(VehicleType type)
Get an unused unit number for a vehicle (if allowed).
Definition: vehicle.cpp:1731
static Train * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
CompanySettings settings
settings specific for each company
Definition: company_base.h:129
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition: vehicle.cpp:745
CargoID GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition: engine_base.h:81
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition: economy.cpp:966
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Definition: command_type.h:64
CommandCost CmdDepotMassAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Autoreplace all vehicles in the depot.
CommandCost CmdRenameVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Give a custom name to your vehicle.
DepotCommand
Flags to add to p1 for goto depot commands.
Definition: vehicle_type.h:67
CommandCost CmdCloneVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Clone a vehicle.
replace/renew a vehicle while it is in a depot
Definition: command_type.h:315
Pseudo random number generator.
start or stop a vehicle
Definition: command_type.h:313
Running costs aircraft.
Definition: economy_type.h:155
Invalid cargo type.
Definition: cargo_type.h:70
uint16 service_interval
The interval for (automatic) servicing; either in days or %.
Definition: base_consist.h:27
Called to determine the cost factor for refitting a vehicle.
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3318
uint16 cargo_cap
total capacity
Definition: vehicle_base.h:307
Various declarations for airports.
static bool IsTileOwner(TileIndex tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition: tile_map.h:216
Header of Action 04 "universal holder" structure and functions.
Map related accessors for depots.
static const uint32 MAKE_ORDER_BACKUP_FLAG
Flag to pass to the vehicle construction command when an order should be preserved.
Definition: order_backup.h:31
Functions related to low-level strings.
Vehicle is crashed.
Definition: vehicle_base.h:39
void UpdateCache()
Update the caches of this ship.
Definition: ship_cmd.cpp:205
Money GetCost() const
Return how much a new engine costs.
Definition: engine.cpp:321
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: vehicle_base.h:433
static const uint MAX_LENGTH_VEHICLE_NAME_CHARS
The maximum length of a vehicle name in characters including &#39;\0&#39;.
Definition: vehicle_type.h:75
UnitID unitnumber
unit number, for display purposes only
Definition: vehicle_base.h:291
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:443
byte cargo_subtype
Used for livery refits (NewGRF variations)
Definition: vehicle_base.h:306
byte subtype
Type of aircraft.
Definition: engine_type.h:103
uint16 crash_anim_pos
Crash animation counter.
Definition: train.h:93
void UpdateAircraftCache(Aircraft *v, bool update_range=false)
Update cached values of an aircraft.
void DeleteVehicleNews(VehicleID vid, StringID news)
Delete a news item type about a vehicle.
Definition: news_gui.cpp:850
void ConsistChanged(ConsistChangeFlags allowed_changes)
Recalculates the cached stuff of a train.
Definition: train_cmd.cpp:109
VehicleDefaultSettings vehicle
default settings for vehicles
Functions related to engines.
Heading for terminal 7.
Definition: airport.h:82
refit the cargo space of a vehicle
Definition: command_type.h:218
byte subtype
cargo subtype to refit to
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:63
DoCommandFlag
List of flags for a command.
Definition: command_type.h:344
simple wagon, not motorized
Definition: engine_type.h:31
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:152
static CommandCost GetRefitCost(const Vehicle *v, EngineID engine_type, CargoID new_cid, byte new_subtype, bool *auto_refit_allowed)
Learn the price of refitting a certain engine.
Definition of base types and functions in a cross-platform compatible way.
virtual ExpensesType GetExpenseType(bool income) const
Sets the expense type associated to this vehicle type.
Definition: vehicle_base.h:423
Tells that it&#39;s a mass send to depot command (type in VLW flag)
Definition: vehicle_type.h:69
build a vehicle
Definition: command_type.h:216
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.
void InvalidateNewGRFCacheOfChain()
Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle) ...
Definition: vehicle_base.h:460
Vehicle * GetNextVehicle() const
Get the next real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:954
VehicleType type
Vehicle type, ie VEH_ROAD, VEH_TRAIN, etc.
Definition: engine_base.h:42
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:305
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:138
Vehicle view; Window numbers:
Definition: window_type.h:334
static CommandCost RefitVehicle(Vehicle *v, bool only_this, uint8 num_vehicles, CargoID new_cid, byte new_subtype, DoCommandFlag flags, bool auto_refit)
Refits a vehicle (chain).
Functions related to order backups.
bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition: vehicle_base.h:883
bool IsShared() const
Is this a shared order list?
Definition: order_base.h:331
byte misc_flags
Miscellaneous flags.
Definition: engine_type.h:144
TileIndex tile
Current tile index.
Definition: vehicle_base.h:230
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
Valid changes for autorefitting in stations.
Definition: train.h:52
static void CountVehicle(const Vehicle *v, int delta)
Update num_vehicle when adding or removing a vehicle.
Definition: group_cmd.cpp:138
bool HasArticulatedPart() const
Check if an engine has an articulated part.
Definition: vehicle_base.h:901
uint capacity
New capacity of vehicle.
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:273
uint8 cargo_map[NUM_CARGO]
Inverse cargo translation table (CargoID -> local ID)
Definition: newgrf.h:129
Airplane has arrived at a runway for take-off.
Definition: airport.h:74
static VehicleType GetDepotVehicleType(TileIndex t)
Get the type of vehicles that can use a depot.
Definition: depot_map.h:67
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
uint16 refit_cap
Capacity left over from before last refit.
Definition: vehicle_base.h:308
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
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
static CommandCost SendAllVehiclesToDepot(DoCommandFlag flags, bool service, const VehicleListIdentifier &vli)
Send all vehicles of type to depots.
CommandCost CmdBuildRoadVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v)
Build a road vehicle.
void InvalidateAutoreplaceWindow(EngineID e, GroupID id_g)
Rebuild the left autoreplace list if an engine is removed or added.
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:35
byte state
State of the airport.
Definition: aircraft.h:81
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:353
CommandCost CmdBuildAircraft(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v)
Build an aircraft.
uint CountArticulatedParts(EngineID engine_type, bool purchase_window)
Count the number of articulated parts of an engine.
char * name
Name of vehicle.
Definition: base_consist.h:20
execute the given command
Definition: command_type.h:346
The vehicle will leave the depot right after arrival (service only)
Definition: vehicle_type.h:68
Functions related to companies.
Functions related to articulated vehicles.
add a vehicle to a group
Definition: command_type.h:322
Automatic refitting is allowed.
Definition: engine_type.h:160
The helicopter is descending directly at its destination (helipad or in front of hangar) ...
Definition: aircraft.h:49
bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
Definition: vehicle_base.h:471
sell a vehicle
Definition: command_type.h:217
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition: engine_base.h:140
Running costs trains.
Definition: economy_type.h:153
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
Definition: window.cpp:3213
void RoadVehUpdateCache(RoadVehicle *v, bool same_length=false)
Update the cache of a road vehicle.
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:59
size_t Utf8StringLength(const char *s)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition: string.cpp:312
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:23
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:119
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
void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8 num_vehicles)
Calculates the set of vehicles that will be affected by a given selection.
Definition: vehicle.cpp:2896
bool servint_ispercent
service intervals are in percents
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Definition: openttd.cpp:114
indicates a combination of two locomotives
Definition: engine_type.h:30
Vehicle * GetNextArticulatedPart() const
Get the next part of an articulated engine.
Definition: vehicle_base.h:911
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.
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: depend.cpp:68
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:54
uint mail_capacity
New mail capacity of aircraft.
Reverse the visible direction of the vehicle.
Definition: train.h:30
uint16 _returned_mail_refit_capacity
Stores the mail capacity after a refit operation (Aircraft only).
Definition: vehicle.cpp:88
uint GetDisplayDefaultCapacity(uint16 *mail_capacity=nullptr) const
Determines the default cargo capacity of an engine for display purposes.
Definition: engine_base.h:101
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() ...
Definition: pool_type.hpp:216
Vehicle details; Window numbers:
Definition: window_type.h:195
Functions related to commands.
CommandCost CmdSendVehicleToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Send a vehicle to the depot.
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
static void CountEngine(const Vehicle *v, int delta)
Update num_engines when adding/removing an engine.
Definition: group_cmd.cpp:161
uint32 GetGRFID() const
Retrieve the GRF ID of the NewGRF the vehicle is tied to.
Definition: vehicle.cpp:765
uint16 UnitID
Type for the company global vehicle unit number.
Base for ships.
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:93
CommandCost CmdRefitVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Refits a vehicle to the specified cargo type.
Running costs ships.
Definition: economy_type.h:156
CommandCost SendToDepot(DoCommandFlag flags, DepotCommand command)
Send this vehicle to the depot using the given command(s).
Definition: vehicle.cpp:2313
uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v)
Evaluate a newgrf callback for vehicles.
Aircraft vehicle type.
Definition: vehicle_type.h:29
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:131
bool IsFreeWagon() const
Check if the vehicle is a free wagon (got no engine in front of it).
uint8 roadveh_acceleration_model
realistic acceleration for road vehicles
CommandCost CmdChangeServiceInt(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Change the service interval of a vehicle.
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.
#define FOR_ALL_VEHICLES(var)
Iterate over all vehicles.
Definition: vehicle_base.h:987
static void SaveRandomSeeds(SavedRandomSeeds *storage)
Saves the current seeds.
Definition: random_func.hpp:44
const GRFFile * GetGRF() const
Retrieve the NewGRF the vehicle is tied to.
Definition: vehicle.cpp:755
send a vehicle to a depot
Definition: command_type.h:219
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:370
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
New vehicles.
Definition: economy_type.h:152
byte flags
Aircraft flags.
Definition: aircraft.h:85
virtual bool IsChainInDepot() const
Check whether the whole vehicle chain is in the depot.
Definition: vehicle_base.h:510
static bool IsDepotTile(TileIndex tile)
Is the given tile a tile with a depot on it?
Definition: depot_map.h:43
static void Restore(Vehicle *v, uint32 user)
Restore the data of this order to the given vehicle.
static void Backup(const Vehicle *v, uint32 user)
Create an order backup for the given vehicle.
int do_start
flag for starting playback of next_file at next opportunity
Definition: win32_m.cpp:39
std::vector< const Vehicle * > VehicleList
A list of vehicles.
Definition: vehiclelist.h:55
move a rail vehicle (in the depot)
Definition: command_type.h:222
Running costs road vehicles.
Definition: economy_type.h:154
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3227
uint DetermineCapacity(const Vehicle *v, uint16 *mail_capacity=nullptr) const
Determines capacity of a given vehicle from scratch.
Definition: engine.cpp:206
Functions related to news.
Company view; Window numbers:
Definition: window_type.h:364
VehicleType vtype
The vehicle type associated with this list.
Definition: vehiclelist.h:33
ExpensesType
Types of expenses.
Definition: economy_type.h:150
static void CloneVehicleName(const Vehicle *src, Vehicle *dst)
Clone the custom name of a vehicle, adding or incrementing a number.
CommandCost CmdSellVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Sell a vehicle.
static bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Definition: vehicle_func.h:91
Road vehicle type.
Definition: vehicle_type.h:27
Order current_order
The current order (+ status, like: loading)
Definition: vehicle_base.h:318
VehicleOrderID GetNumOrders() const
Get number of orders in the order list.
Definition: order_base.h:312
GroupID group_id
Index of group Pool array.
Definition: vehicle_base.h:326
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3300
Valid changes for refitting in a depot.
Definition: train.h:53
GroundVehicleCache gcache
Cache of often calculated values.
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1459
static bool IsUniqueVehicleName(const char *name)
Test if a name is unique among vehicle names.
CommandCost CmdBuildRailVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v)
Build a railroad vehicle.
Definition: train_cmd.cpp:719
CommandCost CmdStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Start/Stop a vehicle.
Base for the NewGRF implementation.