OpenTTD Source  14.0-RC3
order_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 "debug.h"
12 #include "command_func.h"
13 #include "company_func.h"
14 #include "news_func.h"
15 #include "strings_func.h"
16 #include "timetable.h"
17 #include "vehicle_func.h"
18 #include "depot_base.h"
19 #include "core/pool_func.hpp"
20 #include "core/random_func.hpp"
21 #include "aircraft.h"
22 #include "roadveh.h"
23 #include "station_base.h"
24 #include "waypoint_base.h"
25 #include "company_base.h"
26 #include "order_backup.h"
27 #include "cheat_type.h"
28 #include "order_cmd.h"
29 #include "train_cmd.h"
30 
31 #include "table/strings.h"
32 
33 #include "safeguards.h"
34 
35 /* DestinationID must be at least as large as every these below, because it can
36  * be any of them
37  */
38 static_assert(sizeof(DestinationID) >= sizeof(DepotID));
39 static_assert(sizeof(DestinationID) >= sizeof(StationID));
40 
41 OrderPool _order_pool("Order");
43 OrderListPool _orderlist_pool("OrderList");
45 
46 
48 {
49  if (CleaningPool()) return;
50 
51  /* We can visit oil rigs and buoys that are not our own. They will be shown in
52  * the list of stations. So, we need to invalidate that window if needed. */
53  if (this->IsType(OT_GOTO_STATION) || this->IsType(OT_GOTO_WAYPOINT)) {
54  BaseStation *bs = BaseStation::GetIfValid(this->GetDestination());
55  if (bs != nullptr && bs->owner == OWNER_NONE) InvalidateWindowClassesData(WC_STATION_LIST, 0);
56  }
57 }
58 
64 {
65  this->type = OT_NOTHING;
66  this->flags = 0;
67  this->dest = 0;
68  this->next = nullptr;
69 }
70 
75 void Order::MakeGoToStation(StationID destination)
76 {
77  this->type = OT_GOTO_STATION;
78  this->flags = 0;
79  this->dest = destination;
80 }
81 
91 {
92  this->type = OT_GOTO_DEPOT;
93  this->SetDepotOrderType(order);
94  this->SetDepotActionType(action);
95  this->SetNonStopType(non_stop_type);
96  this->dest = destination;
97  this->SetRefit(cargo);
98 }
99 
104 void Order::MakeGoToWaypoint(StationID destination)
105 {
106  this->type = OT_GOTO_WAYPOINT;
107  this->flags = 0;
108  this->dest = destination;
109 }
110 
115 void Order::MakeLoading(bool ordered)
116 {
117  this->type = OT_LOADING;
118  if (!ordered) this->flags = 0;
119 }
120 
125 {
126  this->type = OT_LEAVESTATION;
127  this->flags = 0;
128 }
129 
134 {
135  this->type = OT_DUMMY;
136  this->flags = 0;
137 }
138 
144 {
145  this->type = OT_CONDITIONAL;
146  this->flags = order;
147  this->dest = 0;
148 }
149 
154 void Order::MakeImplicit(StationID destination)
155 {
156  this->type = OT_IMPLICIT;
157  this->dest = destination;
158 }
159 
166 {
167  this->refit_cargo = cargo;
168 }
169 
175 bool Order::Equals(const Order &other) const
176 {
177  /* In case of go to nearest depot orders we need "only" compare the flags
178  * with the other and not the nearest depot order bit or the actual
179  * destination because those get clear/filled in during the order
180  * evaluation. If we do not do this the order will continuously be seen as
181  * a different order and it will try to find a "nearest depot" every tick. */
182  if ((this->IsType(OT_GOTO_DEPOT) && this->type == other.type) &&
183  ((this->GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0 ||
184  (other.GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0)) {
185  return this->GetDepotOrderType() == other.GetDepotOrderType() &&
187  }
188 
189  return this->type == other.type && this->flags == other.flags && this->dest == other.dest;
190 }
191 
198 uint32_t Order::Pack() const
199 {
200  return this->dest << 16 | this->flags << 8 | this->type;
201 }
202 
208 uint16_t Order::MapOldOrder() const
209 {
210  uint16_t order = this->GetType();
211  switch (this->type) {
212  case OT_GOTO_STATION:
213  if (this->GetUnloadType() & OUFB_UNLOAD) SetBit(order, 5);
214  if (this->GetLoadType() & OLFB_FULL_LOAD) SetBit(order, 6);
216  order |= GB(this->GetDestination(), 0, 8) << 8;
217  break;
218  case OT_GOTO_DEPOT:
219  if (!(this->GetDepotOrderType() & ODTFB_PART_OF_ORDERS)) SetBit(order, 6);
220  SetBit(order, 7);
221  order |= GB(this->GetDestination(), 0, 8) << 8;
222  break;
223  case OT_LOADING:
224  if (this->GetLoadType() & OLFB_FULL_LOAD) SetBit(order, 6);
225  break;
226  }
227  return order;
228 }
229 
234 Order::Order(uint32_t packed)
235 {
236  this->type = (OrderType)GB(packed, 0, 8);
237  this->flags = GB(packed, 8, 8);
238  this->dest = GB(packed, 16, 16);
239  this->next = nullptr;
240  this->refit_cargo = CARGO_NO_REFIT;
241  this->wait_time = 0;
242  this->travel_time = 0;
243  this->max_speed = UINT16_MAX;
244 }
245 
251 void InvalidateVehicleOrder(const Vehicle *v, int data)
252 {
254 
255  if (data != 0) {
256  /* Calls SetDirty() too */
259  return;
260  }
261 
264 }
265 
273 void Order::AssignOrder(const Order &other)
274 {
275  this->type = other.type;
276  this->flags = other.flags;
277  this->dest = other.dest;
278 
279  this->refit_cargo = other.refit_cargo;
280 
281  this->wait_time = other.wait_time;
282  this->travel_time = other.travel_time;
283  this->max_speed = other.max_speed;
284 }
285 
292 {
293  this->first = chain;
294  this->first_shared = v;
295 
296  this->num_orders = 0;
297  this->num_manual_orders = 0;
298  this->num_vehicles = 1;
299  this->timetable_duration = 0;
300 
301  for (Order *o = this->first; o != nullptr; o = o->next) {
302  ++this->num_orders;
303  if (!o->IsType(OT_IMPLICIT)) ++this->num_manual_orders;
304  this->total_duration += o->GetWaitTime() + o->GetTravelTime();
305  }
306 
308 
309  for (Vehicle *u = this->first_shared->PreviousShared(); u != nullptr; u = u->PreviousShared()) {
310  ++this->num_vehicles;
311  this->first_shared = u;
312  }
313 
314  for (const Vehicle *u = v->NextShared(); u != nullptr; u = u->NextShared()) ++this->num_vehicles;
315 }
316 
322 {
323  this->timetable_duration = 0;
324  for (Order *o = this->first; o != nullptr; o = o->next) {
325  this->timetable_duration += o->GetTimetabledWait() + o->GetTimetabledTravel();
326  }
327 }
328 
334 void OrderList::FreeChain(bool keep_orderlist)
335 {
336  Order *next;
337  for (Order *o = this->first; o != nullptr; o = next) {
338  next = o->next;
339  delete o;
340  }
341 
342  if (keep_orderlist) {
343  this->first = nullptr;
344  this->num_orders = 0;
345  this->num_manual_orders = 0;
346  this->timetable_duration = 0;
347  } else {
348  delete this;
349  }
350 }
351 
357 Order *OrderList::GetOrderAt(int index) const
358 {
359  if (index < 0) return nullptr;
360 
361  Order *order = this->first;
362 
363  while (order != nullptr && index-- > 0) {
364  order = order->next;
365  }
366  return order;
367 }
368 
380 const Order *OrderList::GetNextDecisionNode(const Order *next, uint hops) const
381 {
382  if (hops > this->GetNumOrders() || next == nullptr) return nullptr;
383 
384  if (next->IsType(OT_CONDITIONAL)) {
385  if (next->GetConditionVariable() != OCV_UNCONDITIONALLY) return next;
386 
387  /* We can evaluate trivial conditions right away. They're conceptually
388  * the same as regular order progression. */
389  return this->GetNextDecisionNode(
390  this->GetOrderAt(next->GetConditionSkipToOrder()),
391  hops + 1);
392  }
393 
394  if (next->IsType(OT_GOTO_DEPOT)) {
395  if (next->GetDepotActionType() == ODATFB_HALT) return nullptr;
396  if (next->IsRefit()) return next;
397  }
398 
399  if (!next->CanLoadOrUnload()) {
400  return this->GetNextDecisionNode(this->GetNext(next), hops + 1);
401  }
402 
403  return next;
404 }
405 
415 StationIDStack OrderList::GetNextStoppingStation(const Vehicle *v, const Order *first, uint hops) const
416 {
417 
418  const Order *next = first;
419  if (first == nullptr) {
420  next = this->GetOrderAt(v->cur_implicit_order_index);
421  if (next == nullptr) {
422  next = this->GetFirstOrder();
423  if (next == nullptr) return INVALID_STATION;
424  } else {
425  /* GetNext never returns nullptr if there is a valid station in the list.
426  * As the given "next" is already valid and a station in the list, we
427  * don't have to check for nullptr here. */
428  next = this->GetNext(next);
429  assert(next != nullptr);
430  }
431  }
432 
433  do {
434  next = this->GetNextDecisionNode(next, ++hops);
435 
436  /* Resolve possibly nested conditionals by estimation. */
437  while (next != nullptr && next->IsType(OT_CONDITIONAL)) {
438  /* We return both options of conditional orders. */
439  const Order *skip_to = this->GetNextDecisionNode(
440  this->GetOrderAt(next->GetConditionSkipToOrder()), hops);
441  const Order *advance = this->GetNextDecisionNode(
442  this->GetNext(next), hops);
443  if (advance == nullptr || advance == first || skip_to == advance) {
444  next = (skip_to == first) ? nullptr : skip_to;
445  } else if (skip_to == nullptr || skip_to == first) {
446  next = (advance == first) ? nullptr : advance;
447  } else {
448  StationIDStack st1 = this->GetNextStoppingStation(v, skip_to, hops);
449  StationIDStack st2 = this->GetNextStoppingStation(v, advance, hops);
450  while (!st2.IsEmpty()) st1.Push(st2.Pop());
451  return st1;
452  }
453  ++hops;
454  }
455 
456  /* Don't return a next stop if the vehicle has to unload everything. */
457  if (next == nullptr || ((next->IsType(OT_GOTO_STATION) || next->IsType(OT_IMPLICIT)) &&
458  next->GetDestination() == v->last_station_visited &&
459  (next->GetUnloadType() & (OUFB_TRANSFER | OUFB_UNLOAD)) != 0)) {
460  return INVALID_STATION;
461  }
462  } while (next->IsType(OT_GOTO_DEPOT) || next->GetDestination() == v->last_station_visited);
463 
464  return next->GetDestination();
465 }
466 
472 void OrderList::InsertOrderAt(Order *new_order, int index)
473 {
474  if (this->first == nullptr) {
475  this->first = new_order;
476  } else {
477  if (index == 0) {
478  /* Insert as first or only order */
479  new_order->next = this->first;
480  this->first = new_order;
481  } else if (index >= this->num_orders) {
482  /* index is after the last order, add it to the end */
483  this->GetLastOrder()->next = new_order;
484  } else {
485  /* Put the new order in between */
486  Order *order = this->GetOrderAt(index - 1);
487  new_order->next = order->next;
488  order->next = new_order;
489  }
490  }
491  ++this->num_orders;
492  if (!new_order->IsType(OT_IMPLICIT)) ++this->num_manual_orders;
493  this->timetable_duration += new_order->GetTimetabledWait() + new_order->GetTimetabledTravel();
494  this->total_duration += new_order->GetWaitTime() + new_order->GetTravelTime();
495 
496  /* We can visit oil rigs and buoys that are not our own. They will be shown in
497  * the list of stations. So, we need to invalidate that window if needed. */
498  if (new_order->IsType(OT_GOTO_STATION) || new_order->IsType(OT_GOTO_WAYPOINT)) {
499  BaseStation *bs = BaseStation::Get(new_order->GetDestination());
501  }
502 
503 }
504 
505 
511 {
512  if (index >= this->num_orders) return;
513 
514  Order *to_remove;
515 
516  if (index == 0) {
517  to_remove = this->first;
518  this->first = to_remove->next;
519  } else {
520  Order *prev = GetOrderAt(index - 1);
521  to_remove = prev->next;
522  prev->next = to_remove->next;
523  }
524  --this->num_orders;
525  if (!to_remove->IsType(OT_IMPLICIT)) --this->num_manual_orders;
526  this->timetable_duration -= (to_remove->GetTimetabledWait() + to_remove->GetTimetabledTravel());
527  this->total_duration -= (to_remove->GetWaitTime() + to_remove->GetTravelTime());
528  delete to_remove;
529 }
530 
536 void OrderList::MoveOrder(int from, int to)
537 {
538  if (from >= this->num_orders || to >= this->num_orders || from == to) return;
539 
540  Order *moving_one;
541 
542  /* Take the moving order out of the pointer-chain */
543  if (from == 0) {
544  moving_one = this->first;
545  this->first = moving_one->next;
546  } else {
547  Order *one_before = GetOrderAt(from - 1);
548  moving_one = one_before->next;
549  one_before->next = moving_one->next;
550  }
551 
552  /* Insert the moving_order again in the pointer-chain */
553  if (to == 0) {
554  moving_one->next = this->first;
555  this->first = moving_one;
556  } else {
557  Order *one_before = GetOrderAt(to - 1);
558  moving_one->next = one_before->next;
559  one_before->next = moving_one;
560  }
561 }
562 
569 {
570  --this->num_vehicles;
571  if (v == this->first_shared) this->first_shared = v->NextShared();
572 }
573 
579 {
580  for (Order *o = this->first; o != nullptr; o = o->next) {
581  /* Implicit orders are, by definition, not timetabled. */
582  if (o->IsType(OT_IMPLICIT)) continue;
583  if (!o->IsCompletelyTimetabled()) return false;
584  }
585  return true;
586 }
587 
588 #ifdef WITH_ASSERT
589 
592 void OrderList::DebugCheckSanity() const
593 {
594  VehicleOrderID check_num_orders = 0;
595  VehicleOrderID check_num_manual_orders = 0;
596  uint check_num_vehicles = 0;
597  TimerGameTick::Ticks check_timetable_duration = 0;
598  TimerGameTick::Ticks check_total_duration = 0;
599 
600  Debug(misc, 6, "Checking OrderList {} for sanity...", this->index);
601 
602  for (const Order *o = this->first; o != nullptr; o = o->next) {
603  ++check_num_orders;
604  if (!o->IsType(OT_IMPLICIT)) ++check_num_manual_orders;
605  check_timetable_duration += o->GetTimetabledWait() + o->GetTimetabledTravel();
606  check_total_duration += o->GetWaitTime() + o->GetTravelTime();
607  }
608  assert(this->num_orders == check_num_orders);
609  assert(this->num_manual_orders == check_num_manual_orders);
610  assert(this->timetable_duration == check_timetable_duration);
611  assert(this->total_duration == check_total_duration);
612 
613  for (const Vehicle *v = this->first_shared; v != nullptr; v = v->NextShared()) {
614  ++check_num_vehicles;
615  assert(v->orders == this);
616  }
617  assert(this->num_vehicles == check_num_vehicles);
618  Debug(misc, 6, "... detected {} orders ({} manual), {} vehicles, {} timetabled, {} total",
619  (uint)this->num_orders, (uint)this->num_manual_orders,
620  this->num_vehicles, this->timetable_duration, this->total_duration);
621 }
622 #endif
623 
631 static inline bool OrderGoesToStation(const Vehicle *v, const Order *o)
632 {
633  return o->IsType(OT_GOTO_STATION) ||
634  (v->type == VEH_AIRCRAFT && o->IsType(OT_GOTO_DEPOT) && o->GetDestination() != INVALID_STATION);
635 }
636 
643 static void DeleteOrderWarnings(const Vehicle *v)
644 {
645  DeleteVehicleNews(v->index, STR_NEWS_VEHICLE_HAS_TOO_FEW_ORDERS);
646  DeleteVehicleNews(v->index, STR_NEWS_VEHICLE_HAS_VOID_ORDER);
647  DeleteVehicleNews(v->index, STR_NEWS_VEHICLE_HAS_DUPLICATE_ENTRY);
648  DeleteVehicleNews(v->index, STR_NEWS_VEHICLE_HAS_INVALID_ENTRY);
649  DeleteVehicleNews(v->index, STR_NEWS_PLANE_USES_TOO_SHORT_RUNWAY);
650 }
651 
658 TileIndex Order::GetLocation(const Vehicle *v, bool airport) const
659 {
660  switch (this->GetType()) {
661  case OT_GOTO_WAYPOINT:
662  case OT_GOTO_STATION:
663  case OT_IMPLICIT:
664  if (airport && v->type == VEH_AIRCRAFT) return Station::Get(this->GetDestination())->airport.tile;
665  return BaseStation::Get(this->GetDestination())->xy;
666 
667  case OT_GOTO_DEPOT:
668  if (this->GetDestination() == INVALID_DEPOT) return INVALID_TILE;
669  return (v->type == VEH_AIRCRAFT) ? Station::Get(this->GetDestination())->xy : Depot::Get(this->GetDestination())->xy;
670 
671  default:
672  return INVALID_TILE;
673  }
674 }
675 
685 uint GetOrderDistance(const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth)
686 {
687  if (cur->IsType(OT_CONDITIONAL)) {
688  if (conditional_depth > v->GetNumOrders()) return 0;
689 
690  conditional_depth++;
691 
692  int dist1 = GetOrderDistance(prev, v->GetOrder(cur->GetConditionSkipToOrder()), v, conditional_depth);
693  int dist2 = GetOrderDistance(prev, cur->next == nullptr ? v->orders->GetFirstOrder() : cur->next, v, conditional_depth);
694  return std::max(dist1, dist2);
695  }
696 
697  TileIndex prev_tile = prev->GetLocation(v, true);
698  TileIndex cur_tile = cur->GetLocation(v, true);
699  if (prev_tile == INVALID_TILE || cur_tile == INVALID_TILE) return 0;
700  return v->type == VEH_AIRCRAFT ? DistanceSquare(prev_tile, cur_tile) : DistanceManhattan(prev_tile, cur_tile);
701 }
702 
714 {
715  Vehicle *v = Vehicle::GetIfValid(veh);
716  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
717 
718  CommandCost ret = CheckOwnership(v->owner);
719  if (ret.Failed()) return ret;
720 
721  /* Validate properties we don't want to have different from default as they are set by other commands. */
722  if (new_order.GetRefitCargo() != CARGO_NO_REFIT || new_order.GetWaitTime() != 0 || new_order.GetTravelTime() != 0 || new_order.GetMaxSpeed() != UINT16_MAX) return CMD_ERROR;
723 
724  /* Check if the inserted order is to the correct destination (owner, type),
725  * and has the correct flags if any */
726  switch (new_order.GetType()) {
727  case OT_GOTO_STATION: {
728  const Station *st = Station::GetIfValid(new_order.GetDestination());
729  if (st == nullptr) return CMD_ERROR;
730 
731  if (st->owner != OWNER_NONE) {
732  ret = CheckOwnership(st->owner);
733  if (ret.Failed()) return ret;
734  }
735 
736  if (!CanVehicleUseStation(v, st)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, GetVehicleCannotUseStationReason(v, st));
737  for (Vehicle *u = v->FirstShared(); u != nullptr; u = u->NextShared()) {
738  if (!CanVehicleUseStation(u, st)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER_SHARED, GetVehicleCannotUseStationReason(u, st));
739  }
740 
741  /* Non stop only allowed for ground vehicles. */
742  if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && !v->IsGroundVehicle()) return CMD_ERROR;
743 
744  /* Filter invalid load/unload types. */
745  switch (new_order.GetLoadType()) {
747  case OLFB_NO_LOAD:
748  break;
749 
750  case OLFB_FULL_LOAD:
751  case OLF_FULL_LOAD_ANY:
752  if (v->HasUnbunchingOrder()) return_cmd_error(STR_ERROR_UNBUNCHING_NO_FULL_LOAD);
753  break;
754 
755  default:
756  return CMD_ERROR;
757  }
758  switch (new_order.GetUnloadType()) {
759  case OUF_UNLOAD_IF_POSSIBLE: case OUFB_UNLOAD: case OUFB_TRANSFER: case OUFB_NO_UNLOAD: break;
760  default: return CMD_ERROR;
761  }
762 
763  /* Filter invalid stop locations */
764  switch (new_order.GetStopLocation()) {
766  case OSL_PLATFORM_MIDDLE:
767  if (v->type != VEH_TRAIN) return CMD_ERROR;
768  [[fallthrough]];
769 
771  break;
772 
773  default:
774  return CMD_ERROR;
775  }
776 
777  break;
778  }
779 
780  case OT_GOTO_DEPOT: {
781  if ((new_order.GetDepotActionType() & ODATFB_NEAREST_DEPOT) == 0) {
782  if (v->type == VEH_AIRCRAFT) {
783  const Station *st = Station::GetIfValid(new_order.GetDestination());
784 
785  if (st == nullptr) return CMD_ERROR;
786 
787  ret = CheckOwnership(st->owner);
788  if (ret.Failed()) return ret;
789 
790  if (!CanVehicleUseStation(v, st) || !st->airport.HasHangar()) {
791  return CMD_ERROR;
792  }
793  } else {
794  const Depot *dp = Depot::GetIfValid(new_order.GetDestination());
795 
796  if (dp == nullptr) return CMD_ERROR;
797 
798  ret = CheckOwnership(GetTileOwner(dp->xy));
799  if (ret.Failed()) return ret;
800 
801  switch (v->type) {
802  case VEH_TRAIN:
803  if (!IsRailDepotTile(dp->xy)) return CMD_ERROR;
804  break;
805 
806  case VEH_ROAD:
807  if (!IsRoadDepotTile(dp->xy)) return CMD_ERROR;
808  break;
809 
810  case VEH_SHIP:
811  if (!IsShipDepotTile(dp->xy)) return CMD_ERROR;
812  break;
813 
814  default: return CMD_ERROR;
815  }
816  }
817  }
818 
819  if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && !v->IsGroundVehicle()) return CMD_ERROR;
820  if (new_order.GetDepotOrderType() & ~(ODTFB_PART_OF_ORDERS | ((new_order.GetDepotOrderType() & ODTFB_PART_OF_ORDERS) != 0 ? ODTFB_SERVICE : 0))) return CMD_ERROR;
822 
823  /* Vehicles cannot have a "service if needed" order that also has a depot action. */
824  if ((new_order.GetDepotOrderType() & ODTFB_SERVICE) && (new_order.GetDepotActionType() & (ODATFB_HALT | ODATFB_UNBUNCH))) return CMD_ERROR;
825 
826  /* Check if we're allowed to have a new unbunching order. */
827  if ((new_order.GetDepotActionType() & ODATFB_UNBUNCH)) {
828  if (v->HasFullLoadOrder()) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, STR_ERROR_UNBUNCHING_NO_UNBUNCHING_FULL_LOAD);
829  if (v->HasUnbunchingOrder()) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, STR_ERROR_UNBUNCHING_ONLY_ONE_ALLOWED);
830  if (v->HasConditionalOrder()) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, STR_ERROR_UNBUNCHING_NO_UNBUNCHING_CONDITIONAL);
831  }
832  break;
833  }
834 
835  case OT_GOTO_WAYPOINT: {
836  const Waypoint *wp = Waypoint::GetIfValid(new_order.GetDestination());
837  if (wp == nullptr) return CMD_ERROR;
838 
839  switch (v->type) {
840  default: return CMD_ERROR;
841 
842  case VEH_TRAIN: {
843  if (!(wp->facilities & FACIL_TRAIN)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, STR_ERROR_NO_RAIL_WAYPOINT);
844 
845  ret = CheckOwnership(wp->owner);
846  if (ret.Failed()) return ret;
847  break;
848  }
849 
850  case VEH_SHIP:
851  if (!(wp->facilities & FACIL_DOCK)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, STR_ERROR_NO_BUOY);
852  if (wp->owner != OWNER_NONE) {
853  ret = CheckOwnership(wp->owner);
854  if (ret.Failed()) return ret;
855  }
856  break;
857  }
858 
859  /* Order flags can be any of the following for waypoints:
860  * [non-stop]
861  * non-stop orders (if any) are only valid for trains */
862  if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN) return CMD_ERROR;
863  break;
864  }
865 
866  case OT_CONDITIONAL: {
867  VehicleOrderID skip_to = new_order.GetConditionSkipToOrder();
868  if (skip_to != 0 && skip_to >= v->GetNumOrders()) return CMD_ERROR; // Always allow jumping to the first (even when there is no order).
869  if (new_order.GetConditionVariable() >= OCV_END) return CMD_ERROR;
870  if (v->HasUnbunchingOrder()) return_cmd_error(STR_ERROR_UNBUNCHING_NO_CONDITIONAL);
871 
873  if (occ >= OCC_END) return CMD_ERROR;
874  switch (new_order.GetConditionVariable()) {
876  if (occ != OCC_IS_TRUE && occ != OCC_IS_FALSE) return CMD_ERROR;
877  break;
878 
879  case OCV_UNCONDITIONALLY:
880  if (occ != OCC_EQUALS) return CMD_ERROR;
881  if (new_order.GetConditionValue() != 0) return CMD_ERROR;
882  break;
883 
884  case OCV_LOAD_PERCENTAGE:
885  case OCV_RELIABILITY:
886  if (new_order.GetConditionValue() > 100) return CMD_ERROR;
887  [[fallthrough]];
888 
889  default:
890  if (occ == OCC_IS_TRUE || occ == OCC_IS_FALSE) return CMD_ERROR;
891  break;
892  }
893  break;
894  }
895 
896  default: return CMD_ERROR;
897  }
898 
899  if (sel_ord > v->GetNumOrders()) return CMD_ERROR;
900 
901  if (v->GetNumOrders() >= MAX_VEH_ORDER_ID) return_cmd_error(STR_ERROR_TOO_MANY_ORDERS);
902  if (!Order::CanAllocateItem()) return_cmd_error(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
903  if (v->orders == nullptr && !OrderList::CanAllocateItem()) return_cmd_error(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
904 
905  if (flags & DC_EXEC) {
906  Order *new_o = new Order();
907  new_o->AssignOrder(new_order);
908  InsertOrder(v, new_o, sel_ord);
909  }
910 
911  return CommandCost();
912 }
913 
920 void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord)
921 {
922  /* Create new order and link in list */
923  if (v->orders == nullptr) {
924  v->orders = new OrderList(new_o, v);
925  } else {
926  v->orders->InsertOrderAt(new_o, sel_ord);
927  }
928 
929  Vehicle *u = v->FirstShared();
931  for (; u != nullptr; u = u->NextShared()) {
932  assert(v->orders == u->orders);
933 
934  /* If there is added an order before the current one, we need
935  * to update the selected order. We do not change implicit/real order indices though.
936  * If the new order is between the current implicit order and real order, the implicit order will
937  * later skip the inserted order. */
938  if (sel_ord <= u->cur_real_order_index) {
939  uint cur = u->cur_real_order_index + 1;
940  /* Check if we don't go out of bound */
941  if (cur < u->GetNumOrders()) {
942  u->cur_real_order_index = cur;
943  }
944  }
945  if (sel_ord == u->cur_implicit_order_index && u->IsGroundVehicle()) {
946  /* We are inserting an order just before the current implicit order.
947  * We do not know whether we will reach current implicit or the newly inserted order first.
948  * So, disable creation of implicit orders until we are on track again. */
949  uint16_t &gv_flags = u->GetGroundVehicleFlags();
951  }
952  if (sel_ord <= u->cur_implicit_order_index) {
953  uint cur = u->cur_implicit_order_index + 1;
954  /* Check if we don't go out of bound */
955  if (cur < u->GetNumOrders()) {
956  u->cur_implicit_order_index = cur;
957  }
958  }
959  /* Unbunching data is no longer valid. */
961 
962  /* Update any possible open window of the vehicle */
963  InvalidateVehicleOrder(u, INVALID_VEH_ORDER_ID | (sel_ord << 8));
964  }
965 
966  /* As we insert an order, the order to skip to will be 'wrong'. */
967  VehicleOrderID cur_order_id = 0;
968  for (Order *order : v->Orders()) {
969  if (order->IsType(OT_CONDITIONAL)) {
970  VehicleOrderID order_id = order->GetConditionSkipToOrder();
971  if (order_id >= sel_ord) {
972  order->SetConditionSkipToOrder(order_id + 1);
973  }
974  if (order_id == cur_order_id) {
975  order->SetConditionSkipToOrder((order_id + 1) % v->GetNumOrders());
976  }
977  }
978  cur_order_id++;
979  }
980 
981  /* Make sure to rebuild the whole list */
983 }
984 
991 {
992  if (flags & DC_EXEC) {
993  DeleteVehicleOrders(dst);
996  }
997  return CommandCost();
998 }
999 
1008 {
1009  Vehicle *v = Vehicle::GetIfValid(veh_id);
1010 
1011  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1012 
1013  CommandCost ret = CheckOwnership(v->owner);
1014  if (ret.Failed()) return ret;
1015 
1016  /* If we did not select an order, we maybe want to de-clone the orders */
1017  if (sel_ord >= v->GetNumOrders()) return DecloneOrder(v, flags);
1018 
1019  if (v->GetOrder(sel_ord) == nullptr) return CMD_ERROR;
1020 
1021  if (flags & DC_EXEC) DeleteOrder(v, sel_ord);
1022  return CommandCost();
1023 }
1024 
1030 {
1031  assert(v->current_order.IsType(OT_LOADING));
1032  /* NON-stop flag is misused to see if a train is in a station that is
1033  * on its order list or not */
1035  /* When full loading, "cancel" that order so the vehicle doesn't
1036  * stay indefinitely at this station anymore. */
1038 }
1039 
1046 {
1047  v->orders->DeleteOrderAt(sel_ord);
1048 
1049  Vehicle *u = v->FirstShared();
1051  for (; u != nullptr; u = u->NextShared()) {
1052  assert(v->orders == u->orders);
1053 
1054  if (sel_ord == u->cur_real_order_index && u->current_order.IsType(OT_LOADING)) {
1056  }
1057 
1058  if (sel_ord < u->cur_real_order_index) {
1059  u->cur_real_order_index--;
1060  } else if (sel_ord == u->cur_real_order_index) {
1061  u->UpdateRealOrderIndex();
1062  }
1063 
1064  if (sel_ord < u->cur_implicit_order_index) {
1066  } else if (sel_ord == u->cur_implicit_order_index) {
1067  /* Make sure the index is valid */
1069 
1070  /* Skip non-implicit orders for the implicit-order-index (e.g. if the current implicit order was deleted */
1071  while (u->cur_implicit_order_index != u->cur_real_order_index && !u->GetOrder(u->cur_implicit_order_index)->IsType(OT_IMPLICIT)) {
1074  }
1075  }
1076  /* Unbunching data is no longer valid. */
1077  u->ResetDepotUnbunching();
1078 
1079  /* Update any possible open window of the vehicle */
1080  InvalidateVehicleOrder(u, sel_ord | (INVALID_VEH_ORDER_ID << 8));
1081  }
1082 
1083  /* As we delete an order, the order to skip to will be 'wrong'. */
1084  VehicleOrderID cur_order_id = 0;
1085  for (Order *order : v->Orders()) {
1086  if (order->IsType(OT_CONDITIONAL)) {
1087  VehicleOrderID order_id = order->GetConditionSkipToOrder();
1088  if (order_id >= sel_ord) {
1089  order_id = std::max(order_id - 1, 0);
1090  }
1091  if (order_id == cur_order_id) {
1092  order_id = (order_id + 1) % v->GetNumOrders();
1093  }
1094  order->SetConditionSkipToOrder(order_id);
1095  }
1096  cur_order_id++;
1097  }
1098 
1100 }
1101 
1110 {
1111  Vehicle *v = Vehicle::GetIfValid(veh_id);
1112 
1113  if (v == nullptr || !v->IsPrimaryVehicle() || sel_ord == v->cur_implicit_order_index || sel_ord >= v->GetNumOrders() || v->GetNumOrders() < 2) return CMD_ERROR;
1114 
1115  CommandCost ret = CheckOwnership(v->owner);
1116  if (ret.Failed()) return ret;
1117 
1118  if (flags & DC_EXEC) {
1119  if (v->current_order.IsType(OT_LOADING)) v->LeaveStation();
1120 
1122  v->UpdateRealOrderIndex();
1123 
1124  /* Unbunching data is no longer valid. */
1125  v->ResetDepotUnbunching();
1126 
1128 
1129  /* We have an aircraft/ship, they have a mini-schedule, so update them all */
1132  }
1133 
1134  return CommandCost();
1135 }
1136 
1148 {
1149  Vehicle *v = Vehicle::GetIfValid(veh);
1150  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1151 
1152  CommandCost ret = CheckOwnership(v->owner);
1153  if (ret.Failed()) return ret;
1154 
1155  /* Don't make senseless movements */
1156  if (moving_order >= v->GetNumOrders() || target_order >= v->GetNumOrders() ||
1157  moving_order == target_order || v->GetNumOrders() <= 1) return CMD_ERROR;
1158 
1159  Order *moving_one = v->GetOrder(moving_order);
1160  /* Don't move an empty order */
1161  if (moving_one == nullptr) return CMD_ERROR;
1162 
1163  if (flags & DC_EXEC) {
1164  v->orders->MoveOrder(moving_order, target_order);
1165 
1166  /* Update shared list */
1167  Vehicle *u = v->FirstShared();
1168 
1170 
1171  for (; u != nullptr; u = u->NextShared()) {
1172  /* Update the current order.
1173  * There are multiple ways to move orders, which result in cur_implicit_order_index
1174  * and cur_real_order_index to not longer make any sense. E.g. moving another
1175  * real order between them.
1176  *
1177  * Basically one could choose to preserve either of them, but not both.
1178  * While both ways are suitable in this or that case from a human point of view, neither
1179  * of them makes really sense.
1180  * However, from an AI point of view, preserving cur_real_order_index is the most
1181  * predictable and transparent behaviour.
1182  *
1183  * With that decision it basically does not matter what we do to cur_implicit_order_index.
1184  * If we change orders between the implicit- and real-index, the implicit orders are mostly likely
1185  * completely out-dated anyway. So, keep it simple and just keep cur_implicit_order_index as well.
1186  * The worst which can happen is that a lot of implicit orders are removed when reaching current_order.
1187  */
1188  if (u->cur_real_order_index == moving_order) {
1189  u->cur_real_order_index = target_order;
1190  } else if (u->cur_real_order_index > moving_order && u->cur_real_order_index <= target_order) {
1191  u->cur_real_order_index--;
1192  } else if (u->cur_real_order_index < moving_order && u->cur_real_order_index >= target_order) {
1193  u->cur_real_order_index++;
1194  }
1195 
1196  if (u->cur_implicit_order_index == moving_order) {
1197  u->cur_implicit_order_index = target_order;
1198  } else if (u->cur_implicit_order_index > moving_order && u->cur_implicit_order_index <= target_order) {
1200  } else if (u->cur_implicit_order_index < moving_order && u->cur_implicit_order_index >= target_order) {
1202  }
1203  /* Unbunching data is no longer valid. */
1204  u->ResetDepotUnbunching();
1205 
1206 
1207  assert(v->orders == u->orders);
1208  /* Update any possible open window of the vehicle */
1209  InvalidateVehicleOrder(u, moving_order | (target_order << 8));
1210  }
1211 
1212  /* As we move an order, the order to skip to will be 'wrong'. */
1213  for (Order *order : v->Orders()) {
1214  if (order->IsType(OT_CONDITIONAL)) {
1215  VehicleOrderID order_id = order->GetConditionSkipToOrder();
1216  if (order_id == moving_order) {
1217  order_id = target_order;
1218  } else if (order_id > moving_order && order_id <= target_order) {
1219  order_id--;
1220  } else if (order_id < moving_order && order_id >= target_order) {
1221  order_id++;
1222  }
1223  order->SetConditionSkipToOrder(order_id);
1224  }
1225  }
1226 
1227  /* Make sure to rebuild the whole list */
1229  }
1230 
1231  return CommandCost();
1232 }
1233 
1246 {
1247  if (mof >= MOF_END) return CMD_ERROR;
1248 
1249  Vehicle *v = Vehicle::GetIfValid(veh);
1250  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1251 
1252  CommandCost ret = CheckOwnership(v->owner);
1253  if (ret.Failed()) return ret;
1254 
1255  /* Is it a valid order? */
1256  if (sel_ord >= v->GetNumOrders()) return CMD_ERROR;
1257 
1258  Order *order = v->GetOrder(sel_ord);
1259  assert(order != nullptr);
1260  switch (order->GetType()) {
1261  case OT_GOTO_STATION:
1262  if (mof != MOF_NON_STOP && mof != MOF_STOP_LOCATION && mof != MOF_UNLOAD && mof != MOF_LOAD) return CMD_ERROR;
1263  break;
1264 
1265  case OT_GOTO_DEPOT:
1266  if (mof != MOF_NON_STOP && mof != MOF_DEPOT_ACTION) return CMD_ERROR;
1267  break;
1268 
1269  case OT_GOTO_WAYPOINT:
1270  if (mof != MOF_NON_STOP) return CMD_ERROR;
1271  break;
1272 
1273  case OT_CONDITIONAL:
1274  if (mof != MOF_COND_VARIABLE && mof != MOF_COND_COMPARATOR && mof != MOF_COND_VALUE && mof != MOF_COND_DESTINATION) return CMD_ERROR;
1275  break;
1276 
1277  default:
1278  return CMD_ERROR;
1279  }
1280 
1281  switch (mof) {
1282  default: NOT_REACHED();
1283 
1284  case MOF_NON_STOP:
1285  if (!v->IsGroundVehicle()) return CMD_ERROR;
1286  if (data >= ONSF_END) return CMD_ERROR;
1287  if (data == order->GetNonStopType()) return CMD_ERROR;
1288  break;
1289 
1290  case MOF_STOP_LOCATION:
1291  if (v->type != VEH_TRAIN) return CMD_ERROR;
1292  if (data >= OSL_END) return CMD_ERROR;
1293  break;
1294 
1295  case MOF_UNLOAD:
1297  if ((data & ~(OUFB_UNLOAD | OUFB_TRANSFER | OUFB_NO_UNLOAD)) != 0) return CMD_ERROR;
1298  /* Unload and no-unload are mutual exclusive and so are transfer and no unload. */
1299  if (data != 0 && ((data & (OUFB_UNLOAD | OUFB_TRANSFER)) != 0) == ((data & OUFB_NO_UNLOAD) != 0)) return CMD_ERROR;
1300  if (data == order->GetUnloadType()) return CMD_ERROR;
1301  break;
1302 
1303  case MOF_LOAD:
1305  if (data > OLFB_NO_LOAD || data == 1) return CMD_ERROR;
1306  if (data == order->GetLoadType()) return CMD_ERROR;
1307  if ((data & (OLFB_FULL_LOAD | OLF_FULL_LOAD_ANY)) && v->HasUnbunchingOrder()) return_cmd_error(STR_ERROR_UNBUNCHING_NO_FULL_LOAD);
1308  break;
1309 
1310  case MOF_DEPOT_ACTION:
1311  if (data >= DA_END) return CMD_ERROR;
1312  /* Check if we are allowed to add unbunching. We are always allowed to remove it. */
1313  if (data == DA_UNBUNCH) {
1314  /* Only one unbunching order is allowed in a vehicle's orders. If this order already has an unbunching action, no error is needed. */
1315  if (v->HasUnbunchingOrder() && !(order->GetDepotActionType() & ODATFB_UNBUNCH)) return_cmd_error(STR_ERROR_UNBUNCHING_ONLY_ONE_ALLOWED);
1316  /* We don't allow unbunching if the vehicle has a conditional order. */
1317  if (v->HasConditionalOrder()) return_cmd_error(STR_ERROR_UNBUNCHING_NO_UNBUNCHING_CONDITIONAL);
1318  /* We don't allow unbunching if the vehicle has a full load order. */
1319  if (v->HasFullLoadOrder()) return_cmd_error(STR_ERROR_UNBUNCHING_NO_UNBUNCHING_FULL_LOAD);
1320  }
1321  break;
1322 
1323  case MOF_COND_VARIABLE:
1324  if (data >= OCV_END) return CMD_ERROR;
1325  break;
1326 
1327  case MOF_COND_COMPARATOR:
1328  if (data >= OCC_END) return CMD_ERROR;
1329  switch (order->GetConditionVariable()) {
1330  case OCV_UNCONDITIONALLY: return CMD_ERROR;
1331 
1332  case OCV_REQUIRES_SERVICE:
1333  if (data != OCC_IS_TRUE && data != OCC_IS_FALSE) return CMD_ERROR;
1334  break;
1335 
1336  default:
1337  if (data == OCC_IS_TRUE || data == OCC_IS_FALSE) return CMD_ERROR;
1338  break;
1339  }
1340  break;
1341 
1342  case MOF_COND_VALUE:
1343  switch (order->GetConditionVariable()) {
1344  case OCV_UNCONDITIONALLY:
1345  case OCV_REQUIRES_SERVICE:
1346  return CMD_ERROR;
1347 
1348  case OCV_LOAD_PERCENTAGE:
1349  case OCV_RELIABILITY:
1350  if (data > 100) return CMD_ERROR;
1351  break;
1352 
1353  default:
1354  if (data > 2047) return CMD_ERROR;
1355  break;
1356  }
1357  break;
1358 
1359  case MOF_COND_DESTINATION:
1360  if (data >= v->GetNumOrders()) return CMD_ERROR;
1361  break;
1362  }
1363 
1364  if (flags & DC_EXEC) {
1365  switch (mof) {
1366  case MOF_NON_STOP:
1367  order->SetNonStopType((OrderNonStopFlags)data);
1369  order->SetRefit(CARGO_NO_REFIT);
1372  }
1373  break;
1374 
1375  case MOF_STOP_LOCATION:
1376  order->SetStopLocation((OrderStopLocation)data);
1377  break;
1378 
1379  case MOF_UNLOAD:
1380  order->SetUnloadType((OrderUnloadFlags)data);
1381  break;
1382 
1383  case MOF_LOAD:
1384  order->SetLoadType((OrderLoadFlags)data);
1385  if (data & OLFB_NO_LOAD) order->SetRefit(CARGO_NO_REFIT);
1386  break;
1387 
1388  case MOF_DEPOT_ACTION: {
1389  switch (data) {
1390  case DA_ALWAYS_GO:
1394  break;
1395 
1396  case DA_SERVICE:
1400  order->SetRefit(CARGO_NO_REFIT);
1401  break;
1402 
1403  case DA_STOP:
1407  order->SetRefit(CARGO_NO_REFIT);
1408  break;
1409 
1410  case DA_UNBUNCH:
1414  break;
1415 
1416  default:
1417  NOT_REACHED();
1418  }
1419  break;
1420  }
1421 
1422  case MOF_COND_VARIABLE: {
1424 
1426  switch (order->GetConditionVariable()) {
1427  case OCV_UNCONDITIONALLY:
1429  order->SetConditionValue(0);
1430  break;
1431 
1432  case OCV_REQUIRES_SERVICE:
1433  if (occ != OCC_IS_TRUE && occ != OCC_IS_FALSE) order->SetConditionComparator(OCC_IS_TRUE);
1434  order->SetConditionValue(0);
1435  break;
1436 
1437  case OCV_LOAD_PERCENTAGE:
1438  case OCV_RELIABILITY:
1439  if (order->GetConditionValue() > 100) order->SetConditionValue(100);
1440  [[fallthrough]];
1441 
1442  default:
1443  if (occ == OCC_IS_TRUE || occ == OCC_IS_FALSE) order->SetConditionComparator(OCC_EQUALS);
1444  break;
1445  }
1446  break;
1447  }
1448 
1449  case MOF_COND_COMPARATOR:
1451  break;
1452 
1453  case MOF_COND_VALUE:
1454  order->SetConditionValue(data);
1455  break;
1456 
1457  case MOF_COND_DESTINATION:
1458  order->SetConditionSkipToOrder(data);
1459  break;
1460 
1461  default: NOT_REACHED();
1462  }
1463 
1464  /* Update the windows and full load flags, also for vehicles that share the same order list */
1465  Vehicle *u = v->FirstShared();
1467  for (; u != nullptr; u = u->NextShared()) {
1468  /* Toggle u->current_order "Full load" flag if it changed.
1469  * However, as the same flag is used for depot orders, check
1470  * whether we are not going to a depot as there are three
1471  * cases where the full load flag can be active and only
1472  * one case where the flag is used for depot orders. In the
1473  * other cases for the OrderType the flags are not used,
1474  * so do not care and those orders should not be active
1475  * when this function is called.
1476  */
1477  if (sel_ord == u->cur_real_order_index &&
1478  (u->current_order.IsType(OT_GOTO_STATION) || u->current_order.IsType(OT_LOADING)) &&
1479  u->current_order.GetLoadType() != order->GetLoadType()) {
1480  u->current_order.SetLoadType(order->GetLoadType());
1481  }
1482 
1483  /* Unbunching data is no longer valid. */
1484  u->ResetDepotUnbunching();
1485 
1487  }
1488  }
1489 
1490  return CommandCost();
1491 }
1492 
1500 static bool CheckAircraftOrderDistance(const Aircraft *v_new, const Vehicle *v_order, const Order *first)
1501 {
1502  if (first == nullptr || v_new->acache.cached_max_range == 0) return true;
1503 
1504  /* Iterate over all orders to check the distance between all
1505  * 'goto' orders and their respective next order (of any type). */
1506  for (const Order *o = first; o != nullptr; o = o->next) {
1507  switch (o->GetType()) {
1508  case OT_GOTO_STATION:
1509  case OT_GOTO_DEPOT:
1510  case OT_GOTO_WAYPOINT:
1511  /* If we don't have a next order, we've reached the end and must check the first order instead. */
1512  if (GetOrderDistance(o, o->next != nullptr ? o->next : first, v_order) > v_new->acache.cached_max_range_sqr) return false;
1513  break;
1514 
1515  default: break;
1516  }
1517  }
1518 
1519  return true;
1520 }
1521 
1531 {
1532  Vehicle *dst = Vehicle::GetIfValid(veh_dst);
1533  if (dst == nullptr || !dst->IsPrimaryVehicle()) return CMD_ERROR;
1534 
1535  CommandCost ret = CheckOwnership(dst->owner);
1536  if (ret.Failed()) return ret;
1537 
1538  switch (action) {
1539  case CO_SHARE: {
1540  Vehicle *src = Vehicle::GetIfValid(veh_src);
1541 
1542  /* Sanity checks */
1543  if (src == nullptr || !src->IsPrimaryVehicle() || dst->type != src->type || dst == src) return CMD_ERROR;
1544 
1545  ret = CheckOwnership(src->owner);
1546  if (ret.Failed()) return ret;
1547 
1548  /* Trucks can't share orders with busses (and visa versa) */
1549  if (src->type == VEH_ROAD && RoadVehicle::From(src)->IsBus() != RoadVehicle::From(dst)->IsBus()) {
1550  return CMD_ERROR;
1551  }
1552 
1553  /* Is the vehicle already in the shared list? */
1554  if (src->FirstShared() == dst->FirstShared()) return CMD_ERROR;
1555 
1556  for (const Order *order : src->Orders()) {
1557  if (!OrderGoesToStation(dst, order)) continue;
1558 
1559  /* Allow copying unreachable destinations if they were already unreachable for the source.
1560  * This is basically to allow cloning / autorenewing / autoreplacing vehicles, while the stations
1561  * are temporarily invalid due to reconstruction. */
1562  const Station *st = Station::Get(order->GetDestination());
1563  if (CanVehicleUseStation(src, st) && !CanVehicleUseStation(dst, st)) {
1564  return CommandCost(STR_ERROR_CAN_T_COPY_SHARE_ORDER, GetVehicleCannotUseStationReason(dst, st));
1565  }
1566  }
1567 
1568  /* Check for aircraft range limits. */
1569  if (dst->type == VEH_AIRCRAFT && !CheckAircraftOrderDistance(Aircraft::From(dst), src, src->GetFirstOrder())) {
1570  return_cmd_error(STR_ERROR_AIRCRAFT_NOT_ENOUGH_RANGE);
1571  }
1572 
1573  if (src->orders == nullptr && !OrderList::CanAllocateItem()) {
1574  return_cmd_error(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
1575  }
1576 
1577  if (flags & DC_EXEC) {
1578  /* If the destination vehicle had a OrderList, destroy it.
1579  * We only reset the order indices, if the new orders are obviously different.
1580  * (We mainly do this to keep the order indices valid and in range.) */
1581  DeleteVehicleOrders(dst, false, dst->GetNumOrders() != src->GetNumOrders());
1582 
1583  dst->orders = src->orders;
1584 
1585  /* Link this vehicle in the shared-list */
1586  dst->AddToShared(src);
1587 
1590 
1592  }
1593  break;
1594  }
1595 
1596  case CO_COPY: {
1597  Vehicle *src = Vehicle::GetIfValid(veh_src);
1598 
1599  /* Sanity checks */
1600  if (src == nullptr || !src->IsPrimaryVehicle() || dst->type != src->type || dst == src) return CMD_ERROR;
1601 
1602  ret = CheckOwnership(src->owner);
1603  if (ret.Failed()) return ret;
1604 
1605  /* Trucks can't copy all the orders from busses (and visa versa),
1606  * and neither can helicopters and aircraft. */
1607  for (const Order *order : src->Orders()) {
1608  if (!OrderGoesToStation(dst, order)) continue;
1609  Station *st = Station::Get(order->GetDestination());
1610  if (!CanVehicleUseStation(dst, st)) {
1611  return CommandCost(STR_ERROR_CAN_T_COPY_SHARE_ORDER, GetVehicleCannotUseStationReason(dst, st));
1612  }
1613  }
1614 
1615  /* Check for aircraft range limits. */
1616  if (dst->type == VEH_AIRCRAFT && !CheckAircraftOrderDistance(Aircraft::From(dst), src, src->GetFirstOrder())) {
1617  return_cmd_error(STR_ERROR_AIRCRAFT_NOT_ENOUGH_RANGE);
1618  }
1619 
1620  /* make sure there are orders available */
1622  return_cmd_error(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
1623  }
1624 
1625  if (flags & DC_EXEC) {
1626  Order *first = nullptr;
1627  Order **order_dst;
1628 
1629  /* If the destination vehicle had an order list, destroy the chain but keep the OrderList.
1630  * We only reset the order indices, if the new orders are obviously different.
1631  * (We mainly do this to keep the order indices valid and in range.) */
1632  DeleteVehicleOrders(dst, true, dst->GetNumOrders() != src->GetNumOrders());
1633 
1634  order_dst = &first;
1635  for (const Order *order : src->Orders()) {
1636  *order_dst = new Order();
1637  (*order_dst)->AssignOrder(*order);
1638  order_dst = &(*order_dst)->next;
1639  }
1640  if (dst->orders == nullptr) {
1641  dst->orders = new OrderList(first, dst);
1642  } else {
1643  assert(dst->orders->GetFirstOrder() == nullptr);
1644  assert(!dst->orders->IsShared());
1645  delete dst->orders;
1646  assert(OrderList::CanAllocateItem());
1647  dst->orders = new OrderList(first, dst);
1648  }
1649 
1651 
1653  }
1654  break;
1655  }
1656 
1657  case CO_UNSHARE: return DecloneOrder(dst, flags);
1658  default: return CMD_ERROR;
1659  }
1660 
1661  return CommandCost();
1662 }
1663 
1673 {
1674  if (cargo >= NUM_CARGO && cargo != CARGO_NO_REFIT && cargo != CARGO_AUTO_REFIT) return CMD_ERROR;
1675 
1676  const Vehicle *v = Vehicle::GetIfValid(veh);
1677  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1678 
1679  CommandCost ret = CheckOwnership(v->owner);
1680  if (ret.Failed()) return ret;
1681 
1682  Order *order = v->GetOrder(order_number);
1683  if (order == nullptr) return CMD_ERROR;
1684 
1685  /* Automatic refit cargo is only supported for goto station orders. */
1686  if (cargo == CARGO_AUTO_REFIT && !order->IsType(OT_GOTO_STATION)) return CMD_ERROR;
1687 
1688  if (order->GetLoadType() & OLFB_NO_LOAD) return CMD_ERROR;
1689 
1690  if (flags & DC_EXEC) {
1691  order->SetRefit(cargo);
1692 
1693  /* Make the depot order an 'always go' order. */
1694  if (cargo != CARGO_NO_REFIT && order->IsType(OT_GOTO_DEPOT)) {
1697  }
1698 
1699  for (Vehicle *u = v->FirstShared(); u != nullptr; u = u->NextShared()) {
1700  /* Update any possible open window of the vehicle */
1702 
1703  /* If the vehicle already got the current depot set as current order, then update current order as well */
1704  if (u->cur_real_order_index == order_number && (u->current_order.GetDepotOrderType() & ODTFB_PART_OF_ORDERS)) {
1705  u->current_order.SetRefit(cargo);
1706  }
1707  }
1708  }
1709 
1710  return CommandCost();
1711 }
1712 
1713 
1719 void CheckOrders(const Vehicle *v)
1720 {
1721  /* Does the user wants us to check things? */
1722  if (_settings_client.gui.order_review_system == 0) return;
1723 
1724  /* Do nothing for crashed vehicles */
1725  if (v->vehstatus & VS_CRASHED) return;
1726 
1727  /* Do nothing for stopped vehicles if setting is '1' */
1728  if (_settings_client.gui.order_review_system == 1 && (v->vehstatus & VS_STOPPED)) return;
1729 
1730  /* do nothing we we're not the first vehicle in a share-chain */
1731  if (v->FirstShared() != v) return;
1732 
1733  /* Only check every 20 days, so that we don't flood the message log */
1734  if (v->owner == _local_company && v->day_counter % 20 == 0) {
1735  StringID message = INVALID_STRING_ID;
1736 
1737  /* Check the order list */
1738  int n_st = 0;
1739 
1740  for (const Order *order : v->Orders()) {
1741  /* Dummy order? */
1742  if (order->IsType(OT_DUMMY)) {
1743  message = STR_NEWS_VEHICLE_HAS_VOID_ORDER;
1744  break;
1745  }
1746  /* Does station have a load-bay for this vehicle? */
1747  if (order->IsType(OT_GOTO_STATION)) {
1748  const Station *st = Station::Get(order->GetDestination());
1749 
1750  n_st++;
1751  if (!CanVehicleUseStation(v, st)) {
1752  message = STR_NEWS_VEHICLE_HAS_INVALID_ENTRY;
1753  } else if (v->type == VEH_AIRCRAFT &&
1754  (AircraftVehInfo(v->engine_type)->subtype & AIR_FAST) &&
1757  message == INVALID_STRING_ID) {
1758  message = STR_NEWS_PLANE_USES_TOO_SHORT_RUNWAY;
1759  }
1760  }
1761  }
1762 
1763  /* Check if the last and the first order are the same */
1764  if (v->GetNumOrders() > 1) {
1765  const Order *last = v->GetLastOrder();
1766 
1767  if (v->orders->GetFirstOrder()->Equals(*last)) {
1768  message = STR_NEWS_VEHICLE_HAS_DUPLICATE_ENTRY;
1769  }
1770  }
1771 
1772  /* Do we only have 1 station in our order list? */
1773  if (n_st < 2 && message == INVALID_STRING_ID) message = STR_NEWS_VEHICLE_HAS_TOO_FEW_ORDERS;
1774 
1775 #ifdef WITH_ASSERT
1776  if (v->orders != nullptr) v->orders->DebugCheckSanity();
1777 #endif
1778 
1779  /* We don't have a problem */
1780  if (message == INVALID_STRING_ID) return;
1781 
1782  SetDParam(0, v->index);
1783  AddVehicleAdviceNewsItem(message, v->index);
1784  }
1785 }
1786 
1795 void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar)
1796 {
1797  /* Aircraft have StationIDs for depot orders and never use DepotIDs
1798  * This fact is handled specially below
1799  */
1800 
1801  /* Go through all vehicles */
1802  for (Vehicle *v : Vehicle::Iterate()) {
1803  if ((v->type == VEH_AIRCRAFT && v->current_order.IsType(OT_GOTO_DEPOT) && !hangar ? OT_GOTO_STATION : v->current_order.GetType()) == type &&
1804  (!hangar || v->type == VEH_AIRCRAFT) && v->current_order.GetDestination() == destination) {
1805  v->current_order.MakeDummy();
1806  SetWindowDirty(WC_VEHICLE_VIEW, v->index);
1807  }
1808 
1809  /* Clear the order from the order-list */
1810  int id = -1;
1811  for (Order *order : v->Orders()) {
1812  id++;
1813 restart:
1814 
1815  OrderType ot = order->GetType();
1816  if (ot == OT_GOTO_DEPOT && (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0) continue;
1817  if (ot == OT_GOTO_DEPOT && hangar && v->type != VEH_AIRCRAFT) continue; // Not an aircraft? Can't have a hangar order.
1818  if (ot == OT_IMPLICIT || (v->type == VEH_AIRCRAFT && ot == OT_GOTO_DEPOT && !hangar)) ot = OT_GOTO_STATION;
1819  if (ot == type && order->GetDestination() == destination) {
1820  /* We want to clear implicit orders, but we don't want to make them
1821  * dummy orders. They should just vanish. Also check the actual order
1822  * type as ot is currently OT_GOTO_STATION. */
1823  if (order->IsType(OT_IMPLICIT)) {
1824  order = order->next; // DeleteOrder() invalidates current order
1825  DeleteOrder(v, id);
1826  if (order != nullptr) goto restart;
1827  break;
1828  }
1829 
1830  /* Clear wait time */
1831  v->orders->UpdateTotalDuration(-order->GetWaitTime());
1832  if (order->IsWaitTimetabled()) {
1833  v->orders->UpdateTimetableDuration(-order->GetTimetabledWait());
1834  order->SetWaitTimetabled(false);
1835  }
1836  order->SetWaitTime(0);
1837 
1838  /* Clear order, preserving travel time */
1839  bool travel_timetabled = order->IsTravelTimetabled();
1840  order->MakeDummy();
1841  order->SetTravelTimetabled(travel_timetabled);
1842 
1843  for (const Vehicle *w = v->FirstShared(); w != nullptr; w = w->NextShared()) {
1844  /* In GUI, simulate by removing the order and adding it back */
1847  }
1848  }
1849  }
1850  }
1851 
1852  OrderBackup::RemoveOrder(type, destination, hangar);
1853 }
1854 
1860 {
1861  for (const Order *order : this->Orders()) {
1862  if (order->IsType(OT_GOTO_DEPOT)) return true;
1863  }
1864 
1865  return false;
1866 }
1867 
1877 void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist, bool reset_order_indices)
1878 {
1880 
1881  if (v->IsOrderListShared()) {
1882  /* Remove ourself from the shared order list. */
1883  v->RemoveFromShared();
1884  v->orders = nullptr;
1885  } else if (v->orders != nullptr) {
1886  /* Remove the orders */
1887  v->orders->FreeChain(keep_orderlist);
1888  if (!keep_orderlist) v->orders = nullptr;
1889  }
1890 
1891  /* Unbunching data is no longer valid. */
1892  v->ResetDepotUnbunching();
1893 
1894  if (reset_order_indices) {
1896  if (v->current_order.IsType(OT_LOADING)) {
1898  }
1899  }
1900 }
1901 
1909 uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
1910 {
1911  /* Service intervals are in percents. */
1912  if (ispercent) return Clamp(interval, MIN_SERVINT_PERCENT, MAX_SERVINT_PERCENT);
1913 
1914  /* Service intervals are in minutes. */
1915  if (TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU)) return Clamp(interval, MIN_SERVINT_MINUTES, MAX_SERVINT_MINUTES);
1916 
1917  /* Service intervals are in days. */
1918  return Clamp(interval, MIN_SERVINT_DAYS, MAX_SERVINT_DAYS);
1919 }
1920 
1929 static bool CheckForValidOrders(const Vehicle *v)
1930 {
1931  for (const Order *order : v->Orders()) {
1932  switch (order->GetType()) {
1933  case OT_GOTO_STATION:
1934  case OT_GOTO_DEPOT:
1935  case OT_GOTO_WAYPOINT:
1936  return true;
1937 
1938  default:
1939  break;
1940  }
1941  }
1942 
1943  return false;
1944 }
1945 
1949 static bool OrderConditionCompare(OrderConditionComparator occ, int variable, int value)
1950 {
1951  switch (occ) {
1952  case OCC_EQUALS: return variable == value;
1953  case OCC_NOT_EQUALS: return variable != value;
1954  case OCC_LESS_THAN: return variable < value;
1955  case OCC_LESS_EQUALS: return variable <= value;
1956  case OCC_MORE_THAN: return variable > value;
1957  case OCC_MORE_EQUALS: return variable >= value;
1958  case OCC_IS_TRUE: return variable != 0;
1959  case OCC_IS_FALSE: return variable == 0;
1960  default: NOT_REACHED();
1961  }
1962 }
1963 
1964 template <typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value, int> = 0>
1965 static bool OrderConditionCompare(OrderConditionComparator occ, T variable, int value)
1966 {
1967  return OrderConditionCompare(occ, variable.base(), value);
1968 }
1969 
1977 {
1978  if (order->GetType() != OT_CONDITIONAL) return INVALID_VEH_ORDER_ID;
1979 
1980  bool skip_order = false;
1982  uint16_t value = order->GetConditionValue();
1983 
1984  switch (order->GetConditionVariable()) {
1985  case OCV_LOAD_PERCENTAGE: skip_order = OrderConditionCompare(occ, CalcPercentVehicleFilled(v, nullptr), value); break;
1986  case OCV_RELIABILITY: skip_order = OrderConditionCompare(occ, ToPercent16(v->reliability), value); break;
1987  case OCV_MAX_RELIABILITY: skip_order = OrderConditionCompare(occ, ToPercent16(v->GetEngine()->reliability), value); break;
1988  case OCV_MAX_SPEED: skip_order = OrderConditionCompare(occ, v->GetDisplayMaxSpeed() * 10 / 16, value); break;
1989  case OCV_AGE: skip_order = OrderConditionCompare(occ, TimerGameCalendar::DateToYear(v->age), value); break;
1990  case OCV_REQUIRES_SERVICE: skip_order = OrderConditionCompare(occ, v->NeedsServicing(), value); break;
1991  case OCV_UNCONDITIONALLY: skip_order = true; break;
1993  default: NOT_REACHED();
1994  }
1995 
1996  return skip_order ? order->GetConditionSkipToOrder() : (VehicleOrderID)INVALID_VEH_ORDER_ID;
1997 }
1998 
2006 bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth, bool pbs_look_ahead)
2007 {
2008  if (conditional_depth > v->GetNumOrders()) {
2009  v->current_order.Free();
2010  v->SetDestTile(0);
2011  return false;
2012  }
2013 
2014  switch (order->GetType()) {
2015  case OT_GOTO_STATION:
2016  v->SetDestTile(v->GetOrderStationLocation(order->GetDestination()));
2017  return true;
2018 
2019  case OT_GOTO_DEPOT:
2020  if ((order->GetDepotOrderType() & ODTFB_SERVICE) && !v->NeedsServicing()) {
2021  assert(!pbs_look_ahead);
2022  UpdateVehicleTimetable(v, true);
2024  break;
2025  }
2026 
2028  /* If the vehicle can't find its destination, delay its next search.
2029  * In case many vehicles are in this state, use the vehicle index to spread out pathfinder calls. */
2030  if (v->dest_tile == 0 && TimerGameEconomy::date_fract != (v->index % Ticks::DAY_TICKS)) break;
2031 
2032  /* We need to search for the nearest depot (hangar). */
2033  ClosestDepot closestDepot = v->FindClosestDepot();
2034 
2035  if (closestDepot.found) {
2036  /* PBS reservations cannot reverse */
2037  if (pbs_look_ahead && closestDepot.reverse) return false;
2038 
2039  v->SetDestTile(closestDepot.location);
2040  v->current_order.SetDestination(closestDepot.destination);
2041 
2042  /* If there is no depot in front, reverse automatically (trains only) */
2043  if (v->type == VEH_TRAIN && closestDepot.reverse) Command<CMD_REVERSE_TRAIN_DIRECTION>::Do(DC_EXEC, v->index, false);
2044 
2045  if (v->type == VEH_AIRCRAFT) {
2046  Aircraft *a = Aircraft::From(v);
2047  if (a->state == FLYING && a->targetairport != closestDepot.destination) {
2048  /* The aircraft is now heading for a different hangar than the next in the orders */
2050  }
2051  }
2052  return true;
2053  }
2054 
2055  /* If there is no depot, we cannot help PBS either. */
2056  if (pbs_look_ahead) return false;
2057 
2058  UpdateVehicleTimetable(v, true);
2060  } else {
2061  if (v->type != VEH_AIRCRAFT) {
2062  v->SetDestTile(Depot::Get(order->GetDestination())->xy);
2063  } else {
2064  Aircraft *a = Aircraft::From(v);
2065  DestinationID destination = a->current_order.GetDestination();
2066  if (a->targetairport != destination) {
2067  /* The aircraft is now heading for a different hangar than the next in the orders */
2068  a->SetDestTile(a->GetOrderStationLocation(destination));
2069  }
2070  }
2071  return true;
2072  }
2073  break;
2074 
2075  case OT_GOTO_WAYPOINT:
2076  v->SetDestTile(Waypoint::Get(order->GetDestination())->xy);
2077  return true;
2078 
2079  case OT_CONDITIONAL: {
2080  assert(!pbs_look_ahead);
2081  VehicleOrderID next_order = ProcessConditionalOrder(order, v);
2082  if (next_order != INVALID_VEH_ORDER_ID) {
2083  /* Jump to next_order. cur_implicit_order_index becomes exactly that order,
2084  * cur_real_order_index might come after next_order. */
2085  UpdateVehicleTimetable(v, false);
2086  v->cur_implicit_order_index = v->cur_real_order_index = next_order;
2087  v->UpdateRealOrderIndex();
2089 
2090  /* Disable creation of implicit orders.
2091  * When inserting them we do not know that we would have to make the conditional orders point to them. */
2092  if (v->IsGroundVehicle()) {
2093  uint16_t &gv_flags = v->GetGroundVehicleFlags();
2095  }
2096  } else {
2097  UpdateVehicleTimetable(v, true);
2099  }
2100  break;
2101  }
2102 
2103  default:
2104  v->SetDestTile(0);
2105  return false;
2106  }
2107 
2108  assert(v->cur_implicit_order_index < v->GetNumOrders());
2109  assert(v->cur_real_order_index < v->GetNumOrders());
2110 
2111  /* Get the current order */
2112  order = v->GetOrder(v->cur_real_order_index);
2113  if (order != nullptr && order->IsType(OT_IMPLICIT)) {
2114  assert(v->GetNumManualOrders() == 0);
2115  order = nullptr;
2116  }
2117 
2118  if (order == nullptr) {
2119  v->current_order.Free();
2120  v->SetDestTile(0);
2121  return false;
2122  }
2123 
2124  v->current_order = *order;
2125  return UpdateOrderDest(v, order, conditional_depth + 1, pbs_look_ahead);
2126 }
2127 
2136 {
2137  switch (v->current_order.GetType()) {
2138  case OT_GOTO_DEPOT:
2139  /* Let a depot order in the orderlist interrupt. */
2140  if (!(v->current_order.GetDepotOrderType() & ODTFB_PART_OF_ORDERS)) return false;
2141  break;
2142 
2143  case OT_LOADING:
2144  return false;
2145 
2146  case OT_LEAVESTATION:
2147  if (v->type != VEH_AIRCRAFT) return false;
2148  break;
2149 
2150  default: break;
2151  }
2152 
2160  bool may_reverse = v->current_order.IsType(OT_NOTHING);
2161 
2162  /* Check if we've reached a 'via' destination. */
2163  if (((v->current_order.IsType(OT_GOTO_STATION) && (v->current_order.GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) || v->current_order.IsType(OT_GOTO_WAYPOINT)) &&
2164  IsTileType(v->tile, MP_STATION) &&
2167  /* We set the last visited station here because we do not want
2168  * the train to stop at this 'via' station if the next order
2169  * is a no-non-stop order; in that case not setting the last
2170  * visited station will cause the vehicle to still stop. */
2172  UpdateVehicleTimetable(v, true);
2174  }
2175 
2176  /* Get the current order */
2177  assert(v->cur_implicit_order_index == 0 || v->cur_implicit_order_index < v->GetNumOrders());
2178  v->UpdateRealOrderIndex();
2179 
2180  const Order *order = v->GetOrder(v->cur_real_order_index);
2181  if (order != nullptr && order->IsType(OT_IMPLICIT)) {
2182  assert(v->GetNumManualOrders() == 0);
2183  order = nullptr;
2184  }
2185 
2186  /* If no order, do nothing. */
2187  if (order == nullptr || (v->type == VEH_AIRCRAFT && !CheckForValidOrders(v))) {
2188  if (v->type == VEH_AIRCRAFT) {
2189  /* Aircraft do something vastly different here, so handle separately */
2190  HandleMissingAircraftOrders(Aircraft::From(v));
2191  return false;
2192  }
2193 
2194  v->current_order.Free();
2195  v->SetDestTile(0);
2196  return false;
2197  }
2198 
2199  /* If it is unchanged, keep it. */
2200  if (order->Equals(v->current_order) && (v->type == VEH_AIRCRAFT || v->dest_tile != 0) &&
2201  (v->type != VEH_SHIP || !order->IsType(OT_GOTO_STATION) || Station::Get(order->GetDestination())->ship_station.tile != INVALID_TILE)) {
2202  return false;
2203  }
2204 
2205  /* Otherwise set it, and determine the destination tile. */
2206  v->current_order = *order;
2207 
2209  switch (v->type) {
2210  default:
2211  NOT_REACHED();
2212 
2213  case VEH_ROAD:
2214  case VEH_TRAIN:
2215  break;
2216 
2217  case VEH_AIRCRAFT:
2218  case VEH_SHIP:
2220  break;
2221  }
2222 
2223  return UpdateOrderDest(v, order) && may_reverse;
2224 }
2225 
2233 bool Order::ShouldStopAtStation(const Vehicle *v, StationID station) const
2234 {
2235  bool is_dest_station = this->IsType(OT_GOTO_STATION) && this->dest == station;
2236 
2237  return (!this->IsType(OT_GOTO_DEPOT) || (this->GetDepotOrderType() & ODTFB_PART_OF_ORDERS) != 0) &&
2238  v->last_station_visited != station && // Do stop only when we've not just been there
2239  /* Finally do stop when there is no non-stop flag set for this type of station. */
2241 }
2242 
2243 bool Order::CanLoadOrUnload() const
2244 {
2245  return (this->IsType(OT_GOTO_STATION) || this->IsType(OT_IMPLICIT)) &&
2247  ((this->GetLoadType() & OLFB_NO_LOAD) == 0 ||
2248  (this->GetUnloadType() & OUFB_NO_UNLOAD) == 0);
2249 }
2250 
2257 bool Order::CanLeaveWithCargo(bool has_cargo) const
2258 {
2259  return (this->GetLoadType() & OLFB_NO_LOAD) == 0 || (has_cargo &&
2260  (this->GetUnloadType() & (OUFB_UNLOAD | OUFB_TRANSFER)) == 0);
2261 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
OrderList::first_shared
Vehicle * first_shared
NOSAVE: pointer to the first vehicle in the shared order chain.
Definition: order_base.h:269
DA_STOP
@ DA_STOP
Go to the depot and stop there.
Definition: order_type.h:163
BaseStation::facilities
StationFacility facilities
The facilities that this station has.
Definition: base_station_base.h:75
Aircraft::targetairport
StationID targetairport
Airport to go to next.
Definition: aircraft.h:78
BaseConsist::cur_implicit_order_index
VehicleOrderID cur_implicit_order_index
The index to the current implicit order.
Definition: base_consist.h:32
VehicleOrderID
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
Order::IsRefit
bool IsRefit() const
Is this order a refit order.
Definition: order_base.h:118
Cheats::no_jetcrash
Cheat no_jetcrash
no jet will crash on small airports anymore
Definition: cheat_type.h:31
DeleteOrder
void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord)
Delete an order but skip the parameter validation.
Definition: order_cmd.cpp:1045
InvalidateWindowData
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:3204
Order::MakeDummy
void MakeDummy()
Makes this order a Dummy order.
Definition: order_cmd.cpp:133
SmallStack
Minimal stack that uses a pool to avoid pointers.
Definition: smallstack_type.hpp:135
UpdateVehicleTimetable
void UpdateVehicleTimetable(Vehicle *v, bool travelling)
Update the timetable for the vehicle.
Definition: timetable_cmd.cpp:469
SmallStack::Pop
Titem Pop()
Pop an item from the stack.
Definition: smallstack_type.hpp:212
AircraftNextAirportPos_and_Order
void AircraftNextAirportPos_and_Order(Aircraft *v)
set the right pos when heading to other airports after takeoff
Definition: aircraft_cmd.cpp:1446
OUFB_UNLOAD
@ OUFB_UNLOAD
Force unloading all cargo onto the platform, possibly not getting paid.
Definition: order_type.h:54
SetBit
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
Order::IsType
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:71
order_cmd.h
Pool::PoolItem<&_station_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:339
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3086
Vehicle::PreviousShared
Vehicle * PreviousShared() const
Get the previous vehicle of the shared vehicle chain.
Definition: vehicle_base.h:716
Order::SetLoadType
void SetLoadType(OrderLoadFlags load_type)
Set how the consist must be loaded.
Definition: order_base.h:158
CARGO_NO_REFIT
static const CargoID CARGO_NO_REFIT
Do not refit cargo of a vehicle (used in vehicle orders and auto-replace/auto-renew).
Definition: cargo_type.h:78
Vehicle::GetNumManualOrders
VehicleOrderID GetNumManualOrders() const
Get the number of manually added orders this vehicle has.
Definition: vehicle_base.h:740
CloneOptions
CloneOptions
Clone actions.
Definition: order_type.h:179
AircraftVehicleInfo::subtype
byte subtype
Type of aircraft.
Definition: engine_type.h:104
OCC_NOT_EQUALS
@ OCC_NOT_EQUALS
Skip if both values are not equal.
Definition: order_type.h:130
command_func.h
SmallStack::Push
void Push(const Titem &item)
Pushes a new item onto the stack if there is still space in the underlying pool.
Definition: smallstack_type.hpp:192
Pool::PoolItem<&_station_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:350
ODTFB_SERVICE
@ ODTFB_SERVICE
This depot order is because of the servicing limit.
Definition: order_type.h:95
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:28
MOF_COND_VARIABLE
@ MOF_COND_VARIABLE
A conditional variable changes.
Definition: order_type.h:150
CheckOrders
void CheckOrders(const Vehicle *v)
Check the orders of a vehicle, to see if there are invalid orders and stuff.
Definition: order_cmd.cpp:1719
GVF_SUPPRESS_IMPLICIT_ORDERS
@ GVF_SUPPRESS_IMPLICIT_ORDERS
Disable insertion and removal of automatic orders until the vehicle completes the real order.
Definition: ground_vehicle.hpp:54
OrderLoadFlags
OrderLoadFlags
Flags related to the loading order.
Definition: order_type.h:62
Order::MakeLoading
void MakeLoading(bool ordered)
Makes this order a Loading order.
Definition: order_cmd.cpp:115
Order::MakeLeaveStation
void MakeLeaveStation()
Makes this order a Leave Station order.
Definition: order_cmd.cpp:124
ModifyOrderFlags
ModifyOrderFlags
Enumeration for the data to set in CmdModifyOrder.
Definition: order_type.h:144
Vehicle::LeaveStation
void LeaveStation()
Perform all actions when leaving a station.
Definition: vehicle.cpp:2336
company_base.h
OUFB_TRANSFER
@ OUFB_TRANSFER
Transfer all cargo onto the platform.
Definition: order_type.h:55
Vehicle::GetDisplayMaxSpeed
virtual int GetDisplayMaxSpeed() const
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: vehicle_base.h:526
OLFB_FULL_LOAD
@ OLFB_FULL_LOAD
Full load all cargoes of the consist.
Definition: order_type.h:64
Station
Station data structure.
Definition: station_base.h:442
Order::GetDestination
DestinationID GetDestination() const
Gets the destination of this order.
Definition: order_base.h:104
ProcessConditionalOrder
VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v)
Process a conditional order and determine the next order.
Definition: order_cmd.cpp:1976
InsertOrder
void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord)
Insert a new order but skip the validation.
Definition: order_cmd.cpp:920
Order::GetConditionValue
uint16_t GetConditionValue() const
Get the value to base the skip on.
Definition: order_base.h:155
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
AircraftCache::cached_max_range
uint16_t cached_max_range
Cached maximum range.
Definition: aircraft.h:68
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:349
GB
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
OrderList::MoveOrder
void MoveOrder(int from, int to)
Move an order to another position within the order list.
Definition: order_cmd.cpp:536
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:238
AddVehicleAdviceNewsItem
void AddVehicleAdviceNewsItem(StringID string, VehicleID vehicle)
Adds a vehicle-advice news item.
Definition: news_func.h:40
AirportFTAClass::SHORT_STRIP
@ SHORT_STRIP
This airport has a short landing strip, dangerous for fast aircraft.
Definition: airport.h:150
OSL_PLATFORM_MIDDLE
@ OSL_PLATFORM_MIDDLE
Stop at the middle of the platform.
Definition: order_type.h:85
Order::Free
void Free()
'Free' the order
Definition: order_cmd.cpp:63
CmdMoveOrder
CommandCost CmdMoveOrder(DoCommandFlag flags, VehicleID veh, VehicleOrderID moving_order, VehicleOrderID target_order)
Move an order inside the orderlist.
Definition: order_cmd.cpp:1147
DeleteVehicleNews
void DeleteVehicleNews(VehicleID vid, StringID news)
Delete a news item type about a vehicle.
Definition: news_gui.cpp:919
MOF_STOP_LOCATION
@ MOF_STOP_LOCATION
Passes an OrderStopLocation.
Definition: order_type.h:146
INVALID_TILE
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:95
Order::GetUnloadType
OrderUnloadFlags GetUnloadType() const
How must the consist be unloaded?
Definition: order_base.h:139
Waypoint
Representation of a waypoint.
Definition: waypoint_base.h:16
aircraft.h
OrderDepotTypeFlags
OrderDepotTypeFlags
Reasons that could cause us to go to the depot.
Definition: order_type.h:93
OCC_MORE_THAN
@ OCC_MORE_THAN
Skip if the value is more than the limit.
Definition: order_type.h:133
TimerGameEconomy::date_fract
static DateFract date_fract
Fractional part of the day.
Definition: timer_game_economy.h:38
SpecializedStation< Station, false >::Get
static Station * Get(size_t index)
Gets station with given index.
Definition: base_station_base.h:259
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:54
Order::AssignOrder
void AssignOrder(const Order &other)
Assign data to an order (from another order) This function makes sure that the index is maintained co...
Definition: order_cmd.cpp:273
OrderList::IsCompleteTimetable
bool IsCompleteTimetable() const
Checks whether all orders of the list have a filled timetable.
Definition: order_cmd.cpp:578
BaseConsist::current_order_time
TimerGameTick::Ticks current_order_time
How many ticks have passed since this order started.
Definition: base_consist.h:21
WC_VEHICLE_TIMETABLE
@ WC_VEHICLE_TIMETABLE
Vehicle timetable; Window numbers:
Definition: window_type.h:224
TimerGameEconomy::UsingWallclockUnits
static bool UsingWallclockUnits(bool newgame=false)
Check if we are using wallclock units.
Definition: timer_game_economy.cpp:97
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
Vehicle::FindClosestDepot
virtual ClosestDepot FindClosestDepot()
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Definition: vehicle_base.h:796
Order::type
uint8_t type
The type of order + non-stop flags.
Definition: order_base.h:48
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:240
Vehicle::IsPrimaryVehicle
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: vehicle_base.h:473
OrderList::IsShared
bool IsShared() const
Is this a shared order list?
Definition: order_base.h:339
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:305
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:371
BaseStation::owner
Owner owner
The owner of this station.
Definition: base_station_base.h:74
MOF_NON_STOP
@ MOF_NON_STOP
Passes an OrderNonStopFlags.
Definition: order_type.h:145
DecloneOrder
static CommandCost DecloneOrder(Vehicle *dst, DoCommandFlag flags)
Declone an order-list.
Definition: order_cmd.cpp:990
Vehicle::IsGroundVehicle
debug_inline bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
Definition: vehicle_base.h:511
OrderList::RemoveVehicle
void RemoveVehicle(Vehicle *v)
Removes the vehicle from the shared order list.
Definition: order_cmd.cpp:568
DeleteVehicleOrders
void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist, bool reset_order_indices)
Delete all orders from a vehicle.
Definition: order_cmd.cpp:1877
OrderStopLocation
OrderStopLocation
Where to stop the trains.
Definition: order_type.h:83
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:369
ODATFB_UNBUNCH
@ ODATFB_UNBUNCH
Service the vehicle and then unbunch it.
Definition: order_type.h:106
CmdCloneOrder
CommandCost CmdCloneOrder(DoCommandFlag flags, CloneOptions action, VehicleID veh_dst, VehicleID veh_src)
Clone/share/copy an order-list of another vehicle.
Definition: order_cmd.cpp:1530
Vehicle::UpdateRealOrderIndex
void UpdateRealOrderIndex()
Skip implicit orders until cur_real_order_index is a non-implicit order.
Definition: vehicle_base.h:892
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
OrderList::GetNextDecisionNode
const Order * GetNextDecisionNode(const Order *next, uint hops) const
Get the next order which will make the given vehicle stop at a station or refit at a depot or evaluat...
Definition: order_cmd.cpp:380
train_cmd.h
Airport::GetFTA
const AirportFTAClass * GetFTA() const
Get the finite-state machine for this airport or the finite-state machine for the dummy airport in ca...
Definition: station_base.h:317
Order::GetType
OrderType GetType() const
Get the type of order of this order.
Definition: order_base.h:77
Aircraft
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition: aircraft.h:74
Order::GetStopLocation
OrderStopLocation GetStopLocation() const
Where must we stop at the platform?
Definition: order_base.h:143
GetOrderDistance
uint GetOrderDistance(const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth)
Get the distance between two orders of a vehicle.
Definition: order_cmd.cpp:685
Order::wait_time
uint16_t wait_time
How long in ticks to wait at the destination.
Definition: order_base.h:54
GetServiceIntervalClamped
uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
Clamp the service interval to the correct min/max.
Definition: order_cmd.cpp:1909
ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS
@ ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS
The vehicle will not stop at any stations it passes except the destination.
Definition: order_type.h:74
Order::GetNonStopType
OrderNonStopFlags GetNonStopType() const
At which stations must we stop?
Definition: order_base.h:141
Vehicle::Orders
IterateWrapper Orders() const
Returns an iterable ensemble of orders of a vehicle.
Definition: vehicle_base.h:1075
Airport::HasHangar
bool HasHangar() const
Check if this airport has at least one hangar.
Definition: station_base.h:323
UpdateOrderDest
bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth, bool pbs_look_ahead)
Update the vehicle's destination tile from an order.
Definition: order_cmd.cpp:2006
DistanceManhattan
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:159
depot_base.h
OrderConditionCompare
static bool OrderConditionCompare(OrderConditionComparator occ, int variable, int value)
Compare the variable and value based on the given comparator.
Definition: order_cmd.cpp:1949
CheckOwnership
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
Definition: company_cmd.cpp:361
OLF_FULL_LOAD_ANY
@ OLF_FULL_LOAD_ANY
Full load a single cargo of the consist.
Definition: order_type.h:65
Vehicle::dest_tile
TileIndex dest_tile
Heading for this tile.
Definition: vehicle_base.h:267
return_cmd_error
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:38
Order::GetRefitCargo
CargoID GetRefitCargo() const
Get the cargo to to refit to.
Definition: order_base.h:132
timetable.h
TimerGameConst< struct Calendar >::DAYS_IN_LEAP_YEAR
static constexpr int DAYS_IN_LEAP_YEAR
sometimes, you need one day more...
Definition: timer_game_common.h:150
CommandCost
Common return value for all commands.
Definition: command_type.h:23
ONSF_STOP_EVERYWHERE
@ ONSF_STOP_EVERYWHERE
The vehicle will stop at any station it passes and the destination.
Definition: order_type.h:73
WC_VEHICLE_VIEW
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
Definition: window_type.h:339
Vehicle::AddToShared
void AddToShared(Vehicle *shared_chain)
Adds this vehicle to a shared vehicle chain.
Definition: vehicle.cpp:2942
INVALID_VEH_ORDER_ID
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel)
Definition: order_type.h:21
Vehicle::RemoveFromShared
void RemoveFromShared()
Removes the vehicle from the shared order list.
Definition: vehicle.cpp:2965
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:260
Order::GetTravelTime
uint16_t GetTravelTime() const
Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not).
Definition: order_base.h:195
MOF_COND_COMPARATOR
@ MOF_COND_COMPARATOR
A comparator changes.
Definition: order_type.h:151
CancelLoadingDueToDeletedOrder
static void CancelLoadingDueToDeletedOrder(Vehicle *v)
Cancel the current loading order of the vehicle as the order was deleted.
Definition: order_cmd.cpp:1029
Order::MakeGoToWaypoint
void MakeGoToWaypoint(StationID destination)
Makes this order a Go To Waypoint order.
Definition: order_cmd.cpp:104
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:319
VS_CRASHED
@ VS_CRASHED
Vehicle is crashed.
Definition: vehicle_base.h:40
OUF_UNLOAD_IF_POSSIBLE
@ OUF_UNLOAD_IF_POSSIBLE
Unload all cargo that the station accepts.
Definition: order_type.h:53
_cheats
Cheats _cheats
All the cheats.
Definition: cheat.cpp:16
Vehicle::last_station_visited
StationID last_station_visited
The last station we stopped at.
Definition: vehicle_base.h:333
CheckForValidOrders
static bool CheckForValidOrders(const Vehicle *v)
Check if a vehicle has any valid orders.
Definition: order_cmd.cpp:1929
Order::SetDestination
void SetDestination(DestinationID destination)
Sets the destination of this order.
Definition: order_base.h:111
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:171
GUISettings::order_review_system
uint8_t order_review_system
perform order reviews on vehicles
Definition: settings_type.h:133
Vehicle::current_order
Order current_order
The current order (+ status, like: loading)
Definition: vehicle_base.h:350
IsShipDepotTile
bool IsShipDepotTile(Tile t)
Is it a ship depot tile?
Definition: water_map.h:235
Station::airport
Airport airport
Tile area the airport covers.
Definition: station_base.h:456
TimerGame< struct Calendar >::DateToYear
static constexpr Year DateToYear(Date date)
Calculate the year of a given date.
Definition: timer_game_common.h:77
DeleteOrderWarnings
static void DeleteOrderWarnings(const Vehicle *v)
Delete all news items regarding defective orders about a vehicle This could kill still valid warnings...
Definition: order_cmd.cpp:643
AirportFTAClass::flags
Flags flags
Flags for this airport type.
Definition: airport.h:180
Vehicle::GetLastOrder
Order * GetLastOrder() const
Returns the last order of a vehicle, or nullptr if it doesn't exists.
Definition: vehicle_base.h:922
ODATFB_NEAREST_DEPOT
@ ODATFB_NEAREST_DEPOT
Send the vehicle to the nearest depot.
Definition: order_type.h:105
OrderList::DeleteOrderAt
void DeleteOrderAt(int index)
Remove an order from the order list and delete it.
Definition: order_cmd.cpp:510
OCC_IS_TRUE
@ OCC_IS_TRUE
Skip if the variable is true.
Definition: order_type.h:135
VS_STOPPED
@ VS_STOPPED
Vehicle is stopped by the player.
Definition: vehicle_base.h:34
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:50
Vehicle::GetEngine
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition: vehicle.cpp:747
safeguards.h
OCC_LESS_EQUALS
@ OCC_LESS_EQUALS
Skip if the value is less or equal to the limit.
Definition: order_type.h:132
DA_ALWAYS_GO
@ DA_ALWAYS_GO
Always go to the depot.
Definition: order_type.h:161
WC_SHIPS_LIST
@ WC_SHIPS_LIST
Ships list; Window numbers:
Definition: window_type.h:320
OrderList::Initialize
void Initialize(Order *chain, Vehicle *v)
Recomputes everything.
Definition: order_cmd.cpp:291
GetVehicleCannotUseStationReason
StringID GetVehicleCannotUseStationReason(const Vehicle *v, const Station *st)
Get reason string why this station can't be used by the given vehicle.
Definition: vehicle.cpp:3080
OrderList::num_manual_orders
VehicleOrderID num_manual_orders
NOSAVE: How many manually added orders are there in the list.
Definition: order_base.h:267
ODTFB_PART_OF_ORDERS
@ ODTFB_PART_OF_ORDERS
This depot order is because of a regular order.
Definition: order_type.h:96
Order::GetConditionComparator
OrderConditionComparator GetConditionComparator() const
What is the comparator to use?
Definition: order_base.h:151
OrderList::FreeChain
void FreeChain(bool keep_orderlist=false)
Free a complete order chain.
Definition: order_cmd.cpp:334
GetTileOwner
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition: tile_map.h:178
VehicleID
uint32_t VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
OCC_MORE_EQUALS
@ OCC_MORE_EQUALS
Skip if the value is more or equal to the limit.
Definition: order_type.h:134
CmdDeleteOrder
CommandCost CmdDeleteOrder(DoCommandFlag flags, VehicleID veh_id, VehicleOrderID sel_ord)
Delete an order from the orderlist of a vehicle.
Definition: order_cmd.cpp:1007
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
MOF_COND_DESTINATION
@ MOF_COND_DESTINATION
Change the destination of a conditional order.
Definition: order_type.h:153
FACIL_DOCK
@ FACIL_DOCK
Station with a dock.
Definition: station_type.h:56
Vehicle::HasDepotOrder
bool HasDepotOrder() const
Checks if a vehicle has a depot in its order list.
Definition: order_cmd.cpp:1859
Order::MakeGoToStation
void MakeGoToStation(StationID destination)
Makes this order a Go To Station order.
Definition: order_cmd.cpp:75
OrderList::GetNextStoppingStation
StationIDStack GetNextStoppingStation(const Vehicle *v, const Order *first=nullptr, uint hops=0) const
Recursively determine the next deterministic station to stop at.
Definition: order_cmd.cpp:415
Order::GetConditionSkipToOrder
VehicleOrderID GetConditionSkipToOrder() const
Get the order to skip to.
Definition: order_base.h:153
stdafx.h
Vehicle::IsOrderListShared
bool IsOrderListShared() const
Check if we share our orders with another vehicle.
Definition: vehicle_base.h:728
Cheat::value
bool value
tells if the bool cheat is active or not
Definition: cheat_type.h:18
Engine::reliability
uint16_t reliability
Current reliability of the engine.
Definition: engine_base.h:41
OLF_LOAD_IF_POSSIBLE
@ OLF_LOAD_IF_POSSIBLE
Load as long as there is cargo that fits in the train.
Definition: order_type.h:63
Order::SetStopLocation
void SetStopLocation(OrderStopLocation stop_location)
Set where we must stop at the platform.
Definition: order_base.h:164
OSL_PLATFORM_NEAR_END
@ OSL_PLATFORM_NEAR_END
Stop at the near end of the platform.
Definition: order_type.h:84
OrderList::GetOrderAt
Order * GetOrderAt(int index) const
Get a certain order of the order chain.
Definition: order_cmd.cpp:357
BaseConsist::ResetDepotUnbunching
void ResetDepotUnbunching()
Resets all the data used for depot unbunching.
Definition: base_consist.cpp:49
Order::flags
uint8_t flags
Load/unload types, depot order/action types.
Definition: order_base.h:49
ODATFB_HALT
@ ODATFB_HALT
Service the vehicle and then halt it.
Definition: order_type.h:104
Vehicle::IncrementRealOrderIndex
void IncrementRealOrderIndex()
Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates t...
Definition: vehicle_base.h:877
DistanceSquare
uint DistanceSquare(TileIndex t0, TileIndex t1)
Gets the 'Square' distance between the two given tiles.
Definition: map.cpp:176
BaseConsist::cur_real_order_index
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
Definition: base_consist.h:31
ONSF_NO_STOP_AT_DESTINATION_STATION
@ ONSF_NO_STOP_AT_DESTINATION_STATION
The vehicle will stop at any station it passes except the destination.
Definition: order_type.h:75
CARGO_AUTO_REFIT
static const CargoID CARGO_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
Definition: cargo_type.h:77
ProcessOrders
bool ProcessOrders(Vehicle *v)
Handle the orders of a vehicle and determine the next place to go to if needed.
Definition: order_cmd.cpp:2135
Order::GetWaitTime
uint16_t GetWaitTime() const
Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).
Definition: order_base.h:193
Vehicle::FirstShared
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:722
ToPercent16
constexpr uint ToPercent16(uint i)
Converts a "fract" value 0..65535 to "percent" value 0..100.
Definition: math_func.hpp:306
DepotID
uint16_t DepotID
Type for the unique identifier of depots.
Definition: depot_type.h:13
Order::SetRefit
void SetRefit(CargoID cargo)
Make this depot/station order also a refit order.
Definition: order_cmd.cpp:165
TimerGameTick::Ticks
int32_t Ticks
The type to store ticks in.
Definition: timer_game_tick.h:24
OrderUnloadFlags
OrderUnloadFlags
Flags related to the unloading order.
Definition: order_type.h:52
OrderNonStopFlags
OrderNonStopFlags
Non-stop order flags.
Definition: order_type.h:72
vehicle_func.h
station_base.h
Pool::PoolItem<&_vehicle_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:388
strings_func.h
Pool
Base class for all pools.
Definition: pool_type.hpp:80
Order::SetConditionVariable
void SetConditionVariable(OrderConditionVariable condition_variable)
Set variable we have to compare.
Definition: order_base.h:170
OCC_EQUALS
@ OCC_EQUALS
Skip if both values are equal.
Definition: order_type.h:129
Vehicle::max_age
TimerGameCalendar::Date max_age
Maximum age.
Definition: vehicle_base.h:290
OCV_MAX_SPEED
@ OCV_MAX_SPEED
Skip based on the maximum speed.
Definition: order_type.h:116
OSL_PLATFORM_FAR_END
@ OSL_PLATFORM_FAR_END
Stop at the far end of the platform.
Definition: order_type.h:86
MOF_UNLOAD
@ MOF_UNLOAD
Passes an OrderUnloadType.
Definition: order_type.h:147
Order::refit_cargo
CargoID refit_cargo
Refit CargoID.
Definition: order_base.h:52
Vehicle::IncrementImplicitOrderIndex
void IncrementImplicitOrderIndex()
Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI.
Definition: vehicle_base.h:853
OCV_RELIABILITY
@ OCV_RELIABILITY
Skip based on the reliability.
Definition: order_type.h:115
IsRailDepotTile
static debug_inline bool IsRailDepotTile(Tile t)
Is this tile rail tile and a rail depot?
Definition: rail_map.h:105
FACIL_TRAIN
@ FACIL_TRAIN
Station with train station.
Definition: station_type.h:52
AircraftCache::cached_max_range_sqr
uint32_t cached_max_range_sqr
Cached squared maximum range.
Definition: aircraft.h:67
Vehicle::GetFirstOrder
Order * GetFirstOrder() const
Get the first order of the vehicles order list.
Definition: vehicle_base.h:701
SpecializedVehicle< RoadVehicle, Type >::From
static RoadVehicle * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1206
OrderList::timetable_duration
TimerGameTick::Ticks timetable_duration
NOSAVE: Total timetabled duration of the order list.
Definition: order_base.h:271
SetDParam
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
OrderList::RecalculateTimetableDuration
void RecalculateTimetableDuration()
Recomputes Timetable duration.
Definition: order_cmd.cpp:321
GetStationIndex
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition: station_map.h:28
OCV_REMAINING_LIFETIME
@ OCV_REMAINING_LIFETIME
Skip based on the remaining lifetime.
Definition: order_type.h:120
OUFB_NO_UNLOAD
@ OUFB_NO_UNLOAD
Totally no unloading will be done.
Definition: order_type.h:56
Vehicle::HasFullLoadOrder
bool HasFullLoadOrder() const
Check if the current vehicle has a full load order.
Definition: vehicle.cpp:2442
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
RemoveOrderFromAllVehicles
void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar)
Removes an order from all vehicles.
Definition: order_cmd.cpp:1795
Order::GetTimetabledTravel
uint16_t GetTimetabledTravel() const
Get the time in ticks a vehicle should take to reach the destination or 0 if it's not timetabled.
Definition: order_base.h:191
InvalidateWindowClassesData
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:3221
Order::GetTimetabledWait
uint16_t GetTimetabledWait() const
Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled.
Definition: order_base.h:189
OrderList
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
Definition: order_base.h:260
Order::MapOldOrder
uint16_t MapOldOrder() const
Pack this order into a 16 bits integer as close to the TTD representation as possible.
Definition: order_cmd.cpp:208
cheat_type.h
Order::SetConditionSkipToOrder
void SetConditionSkipToOrder(VehicleOrderID order_id)
Get the order to skip to.
Definition: order_base.h:174
Vehicle::reliability
uint16_t reliability
Reliability.
Definition: vehicle_base.h:293
Vehicle::NextShared
Vehicle * NextShared() const
Get the next vehicle of the shared vehicle chain.
Definition: vehicle_base.h:710
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
MOF_COND_VALUE
@ MOF_COND_VALUE
The value to set the condition to.
Definition: order_type.h:152
OrderList::GetLastOrder
Order * GetLastOrder() const
Get the last order of the order chain.
Definition: order_base.h:306
MP_STATION
@ MP_STATION
A tile of a station.
Definition: tile_type.h:53
Vehicle::age
TimerGameCalendar::Date age
Age in calendar days.
Definition: vehicle_base.h:288
waypoint_base.h
Pool::PoolItem<&_order_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:309
Order::max_speed
uint16_t max_speed
How fast the vehicle may go on the way to the destination.
Definition: order_base.h:56
Order::SetDepotOrderType
void SetDepotOrderType(OrderDepotTypeFlags depot_order_type)
Set the cause to go to the depot.
Definition: order_base.h:166
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition: base_station_base.h:65
ClosestDepot::destination
DestinationID destination
The DestinationID as used for orders.
Definition: vehicle_base.h:228
Order::Pack
uint32_t Pack() const
Pack this order into a 32 bits integer, or actually only the type, flags and destination.
Definition: order_cmd.cpp:198
OrderList::first
Order * first
First order of the order list.
Definition: order_base.h:265
OrderBackup::RemoveOrder
static void RemoveOrder(OrderType type, DestinationID destination, bool hangar)
Removes an order from all vehicles.
Definition: order_backup.cpp:253
BaseStation
Base class for all station-ish types.
Definition: base_station_base.h:64
MAX_VEH_ORDER_ID
static const VehicleOrderID MAX_VEH_ORDER_ID
Last valid VehicleOrderID.
Definition: order_type.h:23
Vehicle::HasUnbunchingOrder
bool HasUnbunchingOrder() const
Check if the current vehicle has an unbunching order.
Definition: vehicle.cpp:2466
Order::SetDepotActionType
void SetDepotActionType(OrderDepotActionFlags depot_service_type)
Set what we are going to do in the depot.
Definition: order_base.h:168
company_func.h
Order::GetMaxSpeed
uint16_t GetMaxSpeed() const
Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.
Definition: order_base.h:202
OCV_LOAD_PERCENTAGE
@ OCV_LOAD_PERCENTAGE
Skip based on the amount of load.
Definition: order_type.h:114
INSTANTIATE_POOL_METHODS
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Definition: pool_func.hpp:237
ClosestDepot
Structure to return information about the closest depot location, and whether it could be found.
Definition: vehicle_base.h:226
Order::MakeConditional
void MakeConditional(VehicleOrderID order)
Makes this order an conditional order.
Definition: order_cmd.cpp:143
Order::ShouldStopAtStation
bool ShouldStopAtStation(const Vehicle *v, StationID station) const
Check whether the given vehicle should stop at the given station based on this order and the non-stop...
Definition: order_cmd.cpp:2233
OrderType
OrderType
Order types.
Definition: order_type.h:35
Vehicle::NeedsServicing
bool NeedsServicing() const
Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for ser...
Definition: vehicle.cpp:190
Order::GetDepotOrderType
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
Definition: order_base.h:145
OrderList::GetNext
const Order * GetNext(const Order *curr) const
Get the order after the given one or the first one, if the given one is the last one.
Definition: order_base.h:314
OrderList::GetFirstOrder
Order * GetFirstOrder() const
Get the first order of the order chain.
Definition: order_base.h:298
CommandHelper
Definition: command_func.h:93
Vehicle::day_counter
byte day_counter
Increased by one for each day.
Definition: vehicle_base.h:345
Order::GetConditionVariable
OrderConditionVariable GetConditionVariable() const
What variable do we have to compare?
Definition: order_base.h:149
Depot
Definition: depot_base.h:20
OrderList::num_vehicles
uint num_vehicles
NOSAVE: Number of vehicles that share this order list.
Definition: order_base.h:268
random_func.hpp
Vehicle::HasConditionalOrder
bool HasConditionalOrder() const
Check if the current vehicle has a conditional order.
Definition: vehicle.cpp:2454
SmallStack::IsEmpty
bool IsEmpty() const
Check if the stack is empty.
Definition: smallstack_type.hpp:243
SpecializedStation< Station, false >::GetIfValid
static Station * GetIfValid(size_t index)
Returns station if the index is a valid index for this station type.
Definition: base_station_base.h:268
CmdOrderRefit
CommandCost CmdOrderRefit(DoCommandFlag flags, VehicleID veh, VehicleOrderID order_number, CargoID cargo)
Add/remove refit orders from an order.
Definition: order_cmd.cpp:1672
Order::SetConditionComparator
void SetConditionComparator(OrderConditionComparator condition_comparator)
Set the comparator to use.
Definition: order_base.h:172
OrderConditionVariable
OrderConditionVariable
Variables (of a vehicle) to 'cause' skipping on.
Definition: order_type.h:113
RoadVehicle::IsBus
bool IsBus() const
Check whether a roadvehicle is a bus.
Definition: roadveh_cmd.cpp:83
DA_UNBUNCH
@ DA_UNBUNCH
Go to the depot and unbunch.
Definition: order_type.h:164
Order::GetLocation
TileIndex GetLocation(const Vehicle *v, bool airport=false) const
Returns a tile somewhat representing the order destination (not suitable for pathfinding).
Definition: order_cmd.cpp:658
Aircraft::state
byte state
State of the airport.
Definition: aircraft.h:79
Vehicle::GetGroundVehicleFlags
uint16_t & GetGroundVehicleFlags()
Access the ground vehicle flags of the vehicle.
Definition: vehicle.cpp:3161
CalcPercentVehicleFilled
uint8_t CalcPercentVehicleFilled(const Vehicle *front, StringID *colour)
Calculates how full a vehicle is.
Definition: vehicle.cpp:1486
Order::SetUnloadType
void SetUnloadType(OrderUnloadFlags unload_type)
Set how the consist must be unloaded.
Definition: order_base.h:160
Order::SetConditionValue
void SetConditionValue(uint16_t value)
Set the value to base the skip on.
Definition: order_base.h:176
OCV_REQUIRES_SERVICE
@ OCV_REQUIRES_SERVICE
Skip when the vehicle requires service.
Definition: order_type.h:118
Ticks::DAY_TICKS
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
Definition: timer_game_tick.h:48
IsTileType
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
Vehicle::GetOrderStationLocation
virtual TileIndex GetOrderStationLocation([[maybe_unused]] StationID station)
Determine the location for the station where the vehicle goes to next.
Definition: vehicle_base.h:789
Vehicle::GetOrder
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
Definition: vehicle_base.h:913
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:51
Clamp
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:79
Order::travel_time
uint16_t travel_time
How long in ticks the journey to this destination should take.
Definition: order_base.h:55
CmdSkipToOrder
CommandCost CmdSkipToOrder(DoCommandFlag flags, VehicleID veh_id, VehicleOrderID sel_ord)
Goto order of order-list.
Definition: order_cmd.cpp:1109
NUM_CARGO
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition: cargo_type.h:74
VIWD_MODIFY_ORDERS
@ VIWD_MODIFY_ORDERS
Other order modifications.
Definition: vehicle_gui.h:36
CheckAircraftOrderDistance
static bool CheckAircraftOrderDistance(const Aircraft *v_new, const Vehicle *v_order, const Order *first)
Check if an aircraft has enough range for an order list.
Definition: order_cmd.cpp:1500
CmdModifyOrder
CommandCost CmdModifyOrder(DoCommandFlag flags, VehicleID veh, VehicleOrderID sel_ord, ModifyOrderFlags mof, uint16_t data)
Modify an order in the orderlist of a vehicle.
Definition: order_cmd.cpp:1245
CanVehicleUseStation
bool CanVehicleUseStation(EngineID engine_type, const Station *st)
Can this station be used by the given engine type?
Definition: vehicle.cpp:3034
pool_func.hpp
order_backup.h
OrderGoesToStation
static bool OrderGoesToStation(const Vehicle *v, const Order *o)
Checks whether the order goes to a station or not, i.e.
Definition: order_cmd.cpp:631
Order::CanLeaveWithCargo
bool CanLeaveWithCargo(bool has_cargo) const
A vehicle can leave the current station with cargo if:
Definition: order_cmd.cpp:2257
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
OCV_MAX_RELIABILITY
@ OCV_MAX_RELIABILITY
Skip based on the maximum reliability.
Definition: order_type.h:121
MOF_LOAD
@ MOF_LOAD
Passes an OrderLoadType.
Definition: order_type.h:148
OCC_IS_FALSE
@ OCC_IS_FALSE
Skip if the variable is false.
Definition: order_type.h:136
Vehicle::GetNumOrders
VehicleOrderID GetNumOrders() const
Get the number of orders this vehicle has.
Definition: vehicle_base.h:734
InvalidateVehicleOrder
void InvalidateVehicleOrder(const Vehicle *v, int data)
Updates the widgets of a vehicle which contains the order-data.
Definition: order_cmd.cpp:251
OrderDepotActionFlags
OrderDepotActionFlags
Actions that can be performed when the vehicle enters the depot.
Definition: order_type.h:102
VIWD_REMOVE_ALL_ORDERS
@ VIWD_REMOVE_ALL_ORDERS
Removed / replaced all orders (after deleting / sharing).
Definition: vehicle_gui.h:35
Vehicle::orders
OrderList * orders
Pointer to the order list for this vehicle.
Definition: vehicle_base.h:353
SetWindowClassesDirty
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3112
Order::GetDepotActionType
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Definition: order_base.h:147
WC_AIRCRAFT_LIST
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers:
Definition: window_type.h:326
Order::MakeGoToDepot
void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type=ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action=ODATF_SERVICE_ONLY, CargoID cargo=CARGO_NO_REFIT)
Makes this order a Go To Depot order.
Definition: order_cmd.cpp:90
Vehicle::DeleteUnreachedImplicitOrders
void DeleteUnreachedImplicitOrders()
Delete all implicit orders which were not reached.
Definition: vehicle.cpp:2150
WC_STATION_LIST
@ WC_STATION_LIST
Station list; Window numbers:
Definition: window_type.h:302
Order::next
Order * next
Pointer to next order. If nullptr, end of list.
Definition: order_base.h:59
OrderList::total_duration
TimerGameTick::Ticks total_duration
NOSAVE: Total (timetabled or not) duration of the order list.
Definition: order_base.h:272
MOF_DEPOT_ACTION
@ MOF_DEPOT_ACTION
Selects the OrderDepotAction.
Definition: order_type.h:149
Order
Definition: order_base.h:36
CmdInsertOrder
CommandCost CmdInsertOrder(DoCommandFlag flags, VehicleID veh, VehicleOrderID sel_ord, const Order &new_order)
Add an order to the orderlist of a vehicle.
Definition: order_cmd.cpp:713
DA_SERVICE
@ DA_SERVICE
Service only if needed.
Definition: order_type.h:162
OrderList::GetNumOrders
VehicleOrderID GetNumOrders() const
Get number of orders in the order list.
Definition: order_base.h:320
Station::ship_station
TileArea ship_station
Tile area the ship 'station' part covers.
Definition: station_base.h:457
Order::Equals
bool Equals(const Order &other) const
Does this order have the same type, flags and destination?
Definition: order_cmd.cpp:175
OCV_AGE
@ OCV_AGE
Skip based on the age.
Definition: order_type.h:117
OrderList::InsertOrderAt
void InsertOrderAt(Order *new_order, int index)
Insert a new order into the order chain.
Definition: order_cmd.cpp:472
Order::SetNonStopType
void SetNonStopType(OrderNonStopFlags non_stop_type)
Set whether we must stop at stations or not.
Definition: order_base.h:162
Order::dest
DestinationID dest
The destination of the order.
Definition: order_base.h:50
Order::MakeImplicit
void MakeImplicit(StationID destination)
Makes this order an implicit order.
Definition: order_cmd.cpp:154
FLYING
@ FLYING
Vehicle is flying in the air.
Definition: airport.h:75
OrderConditionComparator
OrderConditionComparator
Comparator for the skip reasoning.
Definition: order_type.h:128
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
WC_VEHICLE_ORDERS
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
Definition: window_type.h:212
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:635
OCC_LESS_THAN
@ OCC_LESS_THAN
Skip if the value is less than the limit.
Definition: order_type.h:131
debug.h
GetWindowClassForVehicleType
WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:97
OCV_UNCONDITIONALLY
@ OCV_UNCONDITIONALLY
Always skip.
Definition: order_type.h:119
OLFB_NO_LOAD
@ OLFB_NO_LOAD
Do not load anything.
Definition: order_type.h:66
OrderList::num_orders
VehicleOrderID num_orders
NOSAVE: How many orders there are in the list.
Definition: order_base.h:266
IsRoadDepotTile
static debug_inline bool IsRoadDepotTile(Tile t)
Return whether a tile is a road depot tile.
Definition: road_map.h:116
Order::GetLoadType
OrderLoadFlags GetLoadType() const
How must the consist be loaded?
Definition: order_base.h:137
news_func.h
roadveh.h