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