OpenTTD Source
20240917-master-g9ab0a47812
|
Go to the documentation of this file.
31 #include "table/strings.h"
38 static_assert(
sizeof(DestinationID) >=
sizeof(
DepotID));
39 static_assert(
sizeof(DestinationID) >=
sizeof(StationID));
49 if (CleaningPool())
return;
53 if (this->IsType(OT_GOTO_STATION) || this->IsType(OT_GOTO_WAYPOINT)) {
65 this->
type = OT_NOTHING;
77 this->
type = OT_GOTO_STATION;
79 this->
dest = destination;
92 this->
type = OT_GOTO_DEPOT;
96 this->
dest = destination;
106 this->
type = OT_GOTO_WAYPOINT;
108 this->
dest = destination;
117 this->
type = OT_LOADING;
118 if (!ordered) this->
flags = 0;
126 this->
type = OT_LEAVESTATION;
135 this->
type = OT_DUMMY;
145 this->
type = OT_CONDITIONAL;
156 this->
type = OT_IMPLICIT;
157 this->
dest = destination;
210 uint16_t order = this->
GetType();
211 switch (this->
type) {
212 case OT_GOTO_STATION:
321 for (
Order *o = this->
first; o !=
nullptr; o = next) {
326 if (keep_orderlist) {
327 this->
first =
nullptr;
343 if (
index < 0)
return nullptr;
347 while (order !=
nullptr &&
index-- > 0) {
366 if (hops > this->
GetNumOrders() || next ==
nullptr)
return nullptr;
368 if (next->
IsType(OT_CONDITIONAL)) {
378 if (next->
IsType(OT_GOTO_DEPOT)) {
380 if (next->
IsRefit())
return next;
383 if (!next->CanLoadOrUnload()) {
403 if (
first ==
nullptr) {
405 if (next ==
nullptr) {
407 if (next ==
nullptr)
return INVALID_STATION;
413 assert(next !=
nullptr);
421 while (next !=
nullptr && next->
IsType(OT_CONDITIONAL)) {
427 if (advance ==
nullptr || advance ==
first || skip_to == advance) {
428 next = (skip_to ==
first) ?
nullptr : skip_to;
429 }
else if (skip_to ==
nullptr || skip_to ==
first) {
430 next = (advance ==
first) ?
nullptr : advance;
441 if (next ==
nullptr || ((next->
IsType(OT_GOTO_STATION) || next->
IsType(OT_IMPLICIT)) &&
444 return INVALID_STATION;
458 if (this->
first ==
nullptr) {
459 this->
first = new_order;
464 this->
first = new_order;
472 order->
next = new_order;
482 if (new_order->
IsType(OT_GOTO_STATION) || new_order->
IsType(OT_GOTO_WAYPOINT)) {
501 to_remove = this->
first;
505 to_remove = prev->
next;
528 moving_one = this->
first;
532 moving_one = one_before->
next;
533 one_before->
next = moving_one->
next;
539 this->
first = moving_one;
542 moving_one->
next = one_before->
next;
543 one_before->
next = moving_one;
566 if (o->IsType(OT_IMPLICIT))
continue;
567 if (!o->IsCompletelyTimetabled())
return false;
576 void OrderList::DebugCheckSanity()
const
580 uint check_num_vehicles = 0;
584 Debug(misc, 6,
"Checking OrderList {} for sanity...", this->
index);
588 if (!o->IsType(OT_IMPLICIT)) ++check_num_manual_orders;
589 check_timetable_duration += o->GetTimetabledWait() + o->GetTimetabledTravel();
590 check_total_duration += o->GetWaitTime() + o->GetTravelTime();
598 ++check_num_vehicles;
599 assert(v->orders ==
this);
602 Debug(misc, 6,
"... detected {} orders ({} manual), {} vehicles, {} timetabled, {} total",
617 return o->
IsType(OT_GOTO_STATION) ||
645 case OT_GOTO_WAYPOINT:
646 case OT_GOTO_STATION:
671 if (cur->
IsType(OT_CONDITIONAL)) {
678 return std::max(dist1, dist2);
703 if (ret.
Failed())
return ret;
711 case OT_GOTO_STATION: {
717 if (ret.
Failed())
return ret;
764 case OT_GOTO_DEPOT: {
772 if (ret.
Failed())
return ret;
783 if (ret.
Failed())
return ret;
819 case OT_GOTO_WAYPOINT: {
830 if (ret.
Failed())
return ret;
838 if (ret.
Failed())
return ret;
846 if (ret.
Failed())
return ret;
858 case OT_CONDITIONAL: {
915 if (v->
orders ==
nullptr) {
930 if (sel_ord <= u->cur_real_order_index) {
933 if (cur < u->GetNumOrders()) {
944 if (sel_ord <= u->cur_implicit_order_index) {
947 if (cur < u->GetNumOrders()) {
961 if (order->IsType(OT_CONDITIONAL)) {
963 if (order_id >= sel_ord) {
964 order->SetConditionSkipToOrder(order_id + 1);
966 if (order_id == cur_order_id) {
967 order->SetConditionSkipToOrder((order_id + 1) % v->
GetNumOrders());
1006 if (ret.
Failed())
return ret;
1050 if (sel_ord < u->cur_real_order_index) {
1056 if (sel_ord < u->cur_implicit_order_index) {
1078 if (order->IsType(OT_CONDITIONAL)) {
1080 if (order_id >= sel_ord) {
1081 order_id = std::max(order_id - 1, 0);
1083 if (order_id == cur_order_id) {
1086 order->SetConditionSkipToOrder(order_id);
1108 if (ret.
Failed())
return ret;
1145 if (ret.
Failed())
return ret;
1153 if (moving_one ==
nullptr)
return CMD_ERROR;
1206 if (order->IsType(OT_CONDITIONAL)) {
1208 if (order_id == moving_order) {
1209 order_id = target_order;
1210 }
else if (order_id > moving_order && order_id <= target_order) {
1212 }
else if (order_id < moving_order && order_id >= target_order) {
1215 order->SetConditionSkipToOrder(order_id);
1245 if (ret.
Failed())
return ret;
1251 assert(order !=
nullptr);
1253 case OT_GOTO_STATION:
1261 case OT_GOTO_WAYPOINT:
1265 case OT_CONDITIONAL:
1274 default: NOT_REACHED();
1453 default: NOT_REACHED();
1498 for (
const Order *o = first; o !=
nullptr; o = o->
next) {
1499 switch (o->GetType()) {
1500 case OT_GOTO_STATION:
1502 case OT_GOTO_WAYPOINT:
1528 if (ret.
Failed())
return ret;
1538 if (ret.
Failed())
return ret;
1595 if (ret.
Failed())
return ret;
1618 Order *first =
nullptr;
1628 *order_dst =
new Order();
1629 (*order_dst)->AssignOrder(*order);
1630 order_dst = &(*order_dst)->
next;
1632 if (dst->
orders ==
nullptr) {
1672 if (ret.
Failed())
return ret;
1696 if (u->cur_real_order_index == order_number && (u->current_order.GetDepotOrderType() &
ODTFB_PART_OF_ORDERS)) {
1697 u->current_order.SetRefit(cargo);
1734 if (order->IsType(OT_DUMMY)) {
1735 message = STR_NEWS_VEHICLE_HAS_VOID_ORDER;
1739 if (order->IsType(OT_GOTO_STATION)) {
1744 message = STR_NEWS_VEHICLE_HAS_INVALID_ENTRY;
1750 message = STR_NEWS_PLANE_USES_TOO_SHORT_RUNWAY;
1760 message = STR_NEWS_VEHICLE_HAS_DUPLICATE_ENTRY;
1765 if (n_st < 2 && message ==
INVALID_STRING_ID) message = STR_NEWS_VEHICLE_HAS_TOO_FEW_ORDERS;
1768 if (v->
orders !=
nullptr) v->
orders->DebugCheckSanity();
1795 if ((v->type ==
VEH_AIRCRAFT && v->current_order.IsType(OT_GOTO_DEPOT) && !hangar ? OT_GOTO_STATION : v->current_order.GetType()) == type &&
1796 (!hangar || v->type ==
VEH_AIRCRAFT) && v->current_order.GetDestination() == destination) {
1797 v->current_order.MakeDummy();
1803 for (
Order *order : v->Orders()) {
1808 if (ot == OT_GOTO_DEPOT && (order->GetDepotActionType() &
ODATFB_NEAREST_DEPOT) != 0)
continue;
1809 if (ot == OT_GOTO_DEPOT && hangar && v->type !=
VEH_AIRCRAFT)
continue;
1810 if (ot == OT_IMPLICIT || (v->type ==
VEH_AIRCRAFT && ot == OT_GOTO_DEPOT && !hangar)) ot = OT_GOTO_STATION;
1811 if (ot == type && order->GetDestination() == destination) {
1815 if (order->IsType(OT_IMPLICIT)) {
1816 order = order->next;
1818 if (order !=
nullptr)
goto restart;
1823 v->orders->UpdateTotalDuration(-order->GetWaitTime());
1824 if (order->IsWaitTimetabled()) {
1825 v->orders->UpdateTimetableDuration(-order->GetTimetabledWait());
1826 order->SetWaitTimetabled(
false);
1828 order->SetWaitTime(0);
1831 bool travel_timetabled = order->IsTravelTimetabled();
1833 order->SetTravelTimetabled(travel_timetabled);
1854 if (order->IsType(OT_GOTO_DEPOT))
return true;
1877 }
else if (v->
orders !=
nullptr) {
1880 if (!keep_orderlist) v->
orders =
nullptr;
1886 if (reset_order_indices) {
1904 if (ispercent)
return Clamp(interval, MIN_SERVINT_PERCENT, MAX_SERVINT_PERCENT);
1910 return Clamp(interval, MIN_SERVINT_DAYS, MAX_SERVINT_DAYS);
1924 switch (order->GetType()) {
1925 case OT_GOTO_STATION:
1927 case OT_GOTO_WAYPOINT:
1952 default: NOT_REACHED();
1956 template <typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value,
int> = 0>
1972 bool skip_order =
false;
1985 default: NOT_REACHED();
2007 case OT_GOTO_STATION:
2013 assert(!pbs_look_ahead);
2027 if (closestDepot.found) {
2029 if (pbs_look_ahead && closestDepot.reverse)
return false;
2031 v->SetDestTile(closestDepot.location);
2048 if (pbs_look_ahead)
return false;
2060 a->SetDestTile(a->GetOrderStationLocation(destination));
2067 case OT_GOTO_WAYPOINT:
2071 case OT_CONDITIONAL: {
2072 assert(!pbs_look_ahead);
2105 if (order !=
nullptr && order->
IsType(OT_IMPLICIT)) {
2110 if (order ==
nullptr) {
2117 return UpdateOrderDest(v, order, conditional_depth + 1, pbs_look_ahead);
2138 case OT_LEAVESTATION:
2173 if (order !=
nullptr && order->
IsType(OT_IMPLICIT)) {
2227 bool is_dest_station = this->
IsType(OT_GOTO_STATION) && this->
dest == station;
2235 bool Order::CanLoadOrUnload()
const
2237 return (this->
IsType(OT_GOTO_STATION) || this->
IsType(OT_IMPLICIT)) &&
Vehicle * first_shared
NOSAVE: pointer to the first vehicle in the shared order chain.
@ DA_STOP
Go to the depot and stop there.
StationFacility facilities
The facilities that this station has.
StationID targetairport
Airport to go to next.
VehicleOrderID cur_implicit_order_index
The index to the current implicit order.
bool IsRefit() const
Is this order a refit order.
Cheat no_jetcrash
no jet will crash on small airports anymore
void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord)
Delete an order but skip the parameter validation.
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-...
void MakeDummy()
Makes this order a Dummy order.
Minimal stack that uses a pool to avoid pointers.
Titem Pop()
Pop an item from the stack.
void AircraftNextAirportPos_and_Order(Aircraft *v)
set the right pos when heading to other airports after takeoff
@ OUFB_UNLOAD
Force unloading all cargo onto the platform, possibly not getting paid.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
bool IsType(OrderType type) const
Check whether this order is of the given type.
static Titem * Get(size_t index)
Returns Titem with given index.
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Vehicle * PreviousShared() const
Get the previous vehicle of the shared vehicle chain.
@ FACIL_TRAIN
Station with train station.
void SetLoadType(OrderLoadFlags load_type)
Set how the consist must be loaded.
@ MOF_COND_COMPARATOR
A comparator changes.
uint8_t VehicleOrderID
The index of an order within its current vehicle (not pool related)
static const CargoID CARGO_NO_REFIT
Do not refit cargo of a vehicle (used in vehicle orders and auto-replace/auto-renew).
VehicleOrderID GetNumManualOrders() const
Get the number of manually added orders this vehicle has.
@ OCC_NOT_EQUALS
Skip if both values are not equal.
void Push(const Titem &item)
Pushes a new item onto the stack if there is still space in the underlying pool.
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
@ ODTFB_SERVICE
This depot order is because of the servicing limit.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
void CheckOrders(const Vehicle *v)
Check the orders of a vehicle, to see if there are invalid orders and stuff.
@ GVF_SUPPRESS_IMPLICIT_ORDERS
Disable insertion and removal of automatic orders until the vehicle completes the real order.
OrderLoadFlags
Flags related to the loading order.
void MakeLoading(bool ordered)
Makes this order a Loading order.
void MakeLeaveStation()
Makes this order a Leave Station order.
@ FACIL_DOCK
Station with a dock.
void LeaveStation()
Perform all actions when leaving a station.
@ OUFB_TRANSFER
Transfer all cargo onto the platform.
virtual int GetDisplayMaxSpeed() const
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
CloneOptions
Clone actions.
@ OLFB_FULL_LOAD
Full load all cargoes of the consist.
DestinationID GetDestination() const
Gets the destination of this order.
VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v)
Process a conditional order and determine the next order.
void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord)
Insert a new order but skip the validation.
uint16_t GetConditionValue() const
Get the value to base the skip on.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
uint16_t cached_max_range
Cached maximum range.
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.
void MoveOrder(int from, int to)
Move an order to another position within the order list.
Tindex index
Index of this pool item.
void AddVehicleAdviceNewsItem(StringID string, VehicleID vehicle)
Adds a vehicle-advice news item.
@ SHORT_STRIP
This airport has a short landing strip, dangerous for fast aircraft.
@ VEH_TRAIN
Train vehicle type.
@ MOF_UNLOAD
Passes an OrderUnloadType.
@ OSL_PLATFORM_MIDDLE
Stop at the middle of the platform.
@ MOF_COND_DESTINATION
Change the destination of a conditional order.
void Free()
'Free' the order
CommandCost CmdMoveOrder(DoCommandFlag flags, VehicleID veh, VehicleOrderID moving_order, VehicleOrderID target_order)
Move an order inside the orderlist.
void DeleteVehicleNews(VehicleID vid, StringID news)
Delete a news item type about a vehicle.
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
OrderUnloadFlags GetUnloadType() const
How must the consist be unloaded?
Representation of a waypoint.
@ VEH_ROAD
Road vehicle type.
OrderDepotTypeFlags
Reasons that could cause us to go to the depot.
@ OCC_MORE_THAN
Skip if the value is more than the limit.
static DateFract date_fract
Fractional part of the day.
static Station * Get(size_t index)
Gets station with given index.
ClientSettings _settings_client
The current settings for this game.
void AssignOrder(const Order &other)
Assign data to an order (from another order) This function makes sure that the index is maintained co...
bool IsCompleteTimetable() const
Checks whether all orders of the list have a filled timetable.
TimerGameTick::Ticks current_order_time
How many ticks have passed since this order started.
@ WC_VEHICLE_TIMETABLE
Vehicle timetable; Window numbers:
static bool UsingWallclockUnits(bool newgame=false)
Check if we are using wallclock units.
virtual ClosestDepot FindClosestDepot()
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
uint8_t type
The type of order + non-stop flags.
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
bool IsShared() const
Is this a shared order list?
Owner owner
Which company owns the vehicle?
@ DC_EXEC
execute the given command
Owner owner
The owner of this station.
static CommandCost DecloneOrder(Vehicle *dst, DoCommandFlag flags)
Declone an order-list.
debug_inline bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
void RemoveVehicle(Vehicle *v)
Removes the vehicle from the shared order list.
void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist, bool reset_order_indices)
Delete all orders from a vehicle.
OrderStopLocation
Where to stop the trains.
DoCommandFlag
List of flags for a command.
@ ODATFB_UNBUNCH
Service the vehicle and then unbunch it.
CommandCost CmdCloneOrder(DoCommandFlag flags, CloneOptions action, VehicleID veh_dst, VehicleID veh_src)
Clone/share/copy an order-list of another vehicle.
void UpdateRealOrderIndex()
Skip implicit orders until cur_real_order_index is a non-implicit order.
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
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...
@ MOF_STOP_LOCATION
Passes an OrderStopLocation.
const AirportFTAClass * GetFTA() const
Get the finite-state machine for this airport or the finite-state machine for the dummy airport in ca...
OrderType GetType() const
Get the type of order of this order.
Aircraft, helicopters, rotors and their shadows belong to this class.
OrderStopLocation GetStopLocation() const
Where must we stop at the platform?
uint GetOrderDistance(const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth)
Get the distance between two orders of a vehicle.
uint16_t wait_time
How long in ticks to wait at the destination.
uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
Clamp the service interval to the correct min/max.
@ ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS
The vehicle will not stop at any stations it passes except the destination.
OrderNonStopFlags GetNonStopType() const
At which stations must we stop?
IterateWrapper Orders() const
Returns an iterable ensemble of orders of a vehicle.
bool HasHangar() const
Check if this airport has at least one hangar.
bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth, bool pbs_look_ahead)
Update the vehicle's destination tile from an order.
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
static bool OrderConditionCompare(OrderConditionComparator occ, int variable, int value)
Compare the variable and value based on the given comparator.
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
@ OLF_FULL_LOAD_ANY
Full load a single cargo of the consist.
TileIndex dest_tile
Heading for this tile.
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
uint8_t subtype
Type of aircraft.
CargoID GetRefitCargo() const
Get the cargo to to refit to.
static constexpr int DAYS_IN_LEAP_YEAR
sometimes, you need one day more...
Common return value for all commands.
@ ONSF_STOP_EVERYWHERE
The vehicle will stop at any station it passes and the destination.
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
ModifyOrderFlags
Enumeration for the data to set in CmdModifyOrder.
void AddToShared(Vehicle *shared_chain)
Adds this vehicle to a shared vehicle chain.
@ OWNER_NONE
The tile has no ownership.
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel)
void RemoveFromShared()
Removes the vehicle from the shared order list.
TileIndex tile
Current tile index.
uint16_t GetTravelTime() const
Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not).
static void CancelLoadingDueToDeletedOrder(Vehicle *v)
Cancel the current loading order of the vehicle as the order was deleted.
void MakeGoToWaypoint(StationID destination)
Makes this order a Go To Waypoint order.
EngineID engine_type
The type of engine used for this vehicle.
@ VS_CRASHED
Vehicle is crashed.
@ OUF_UNLOAD_IF_POSSIBLE
Unload all cargo that the station accepts.
Cheats _cheats
All the cheats.
StationID last_station_visited
The last station we stopped at.
static bool CheckForValidOrders(const Vehicle *v)
Check if a vehicle has any valid orders.
void SetDestination(DestinationID destination)
Sets the destination of this order.
bool Failed() const
Did this command fail?
uint8_t order_review_system
perform order reviews on vehicles
Order current_order
The current order (+ status, like: loading)
@ MOF_COND_VALUE
The value to set the condition to.
@ VEH_SHIP
Ship vehicle type.
bool IsShipDepotTile(Tile t)
Is it a ship depot tile?
Airport airport
Tile area the airport covers.
static constexpr Year DateToYear(Date date)
Calculate the year of a given date.
static void DeleteOrderWarnings(const Vehicle *v)
Delete all news items regarding defective orders about a vehicle This could kill still valid warnings...
Flags flags
Flags for this airport type.
Order * GetLastOrder() const
Returns the last order of a vehicle, or nullptr if it doesn't exists.
@ ODATFB_NEAREST_DEPOT
Send the vehicle to the nearest depot.
void DeleteOrderAt(int index)
Remove an order from the order list and delete it.
@ OCC_IS_TRUE
Skip if the variable is true.
@ VS_STOPPED
Vehicle is stopped by the player.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
@ OCC_LESS_EQUALS
Skip if the value is less or equal to the limit.
@ DA_ALWAYS_GO
Always go to the depot.
@ WC_SHIPS_LIST
Ships list; Window numbers:
void Initialize(Order *chain, Vehicle *v)
Recomputes everything.
StringID GetVehicleCannotUseStationReason(const Vehicle *v, const Station *st)
Get reason string why this station can't be used by the given vehicle.
VehicleOrderID num_manual_orders
NOSAVE: How many manually added orders are there in the list.
@ ODTFB_PART_OF_ORDERS
This depot order is because of a regular order.
OrderConditionComparator GetConditionComparator() const
What is the comparator to use?
void FreeChain(bool keep_orderlist=false)
Free a complete order chain.
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
uint32_t VehicleID
The type all our vehicle IDs have.
@ MOF_LOAD
Passes an OrderLoadType.
@ OCC_MORE_EQUALS
Skip if the value is more or equal to the limit.
@ FACIL_TRUCK_STOP
Station with truck stops.
CommandCost CmdDeleteOrder(DoCommandFlag flags, VehicleID veh_id, VehicleOrderID sel_ord)
Delete an order from the orderlist of a vehicle.
bool HasDepotOrder() const
Checks if a vehicle has a depot in its order list.
void MakeGoToStation(StationID destination)
Makes this order a Go To Station order.
StationIDStack GetNextStoppingStation(const Vehicle *v, const Order *first=nullptr, uint hops=0) const
Recursively determine the next deterministic station to stop at.
VehicleOrderID GetConditionSkipToOrder() const
Get the order to skip to.
bool IsOrderListShared() const
Check if we share our orders with another vehicle.
bool value
tells if the bool cheat is active or not
uint16_t reliability
Current reliability of the engine.
@ OLF_LOAD_IF_POSSIBLE
Load as long as there is cargo that fits in the train.
void SetStopLocation(OrderStopLocation stop_location)
Set where we must stop at the platform.
@ OSL_PLATFORM_NEAR_END
Stop at the near end of the platform.
Order * GetOrderAt(int index) const
Get a certain order of the order chain.
void ResetDepotUnbunching()
Resets all the data used for depot unbunching.
uint8_t flags
Load/unload types, depot order/action types.
@ ODATFB_HALT
Service the vehicle and then halt it.
void IncrementRealOrderIndex()
Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates t...
uint DistanceSquare(TileIndex t0, TileIndex t1)
Gets the 'Square' distance between the two given tiles.
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
@ ONSF_NO_STOP_AT_DESTINATION_STATION
The vehicle will stop at any station it passes except the destination.
static const CargoID CARGO_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
@ MOF_NON_STOP
Passes an OrderNonStopFlags.
bool ProcessOrders(Vehicle *v)
Handle the orders of a vehicle and determine the next place to go to if needed.
uint16_t GetWaitTime() const
Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
constexpr uint ToPercent16(uint i)
Converts a "fract" value 0..65535 to "percent" value 0..100.
uint16_t DepotID
Type for the unique identifier of depots.
void SetRefit(CargoID cargo)
Make this depot/station order also a refit order.
int32_t Ticks
The type to store ticks in.
OrderUnloadFlags
Flags related to the unloading order.
OrderNonStopFlags
Non-stop order flags.
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Base class for all pools.
void SetConditionVariable(OrderConditionVariable condition_variable)
Set variable we have to compare.
@ OCC_EQUALS
Skip if both values are equal.
uint8_t day_counter
Increased by one for each day.
TimerGameCalendar::Date max_age
Maximum age.
@ OCV_MAX_SPEED
Skip based on the maximum speed.
@ OSL_PLATFORM_FAR_END
Stop at the far end of the platform.
CargoID refit_cargo
Refit CargoID.
void IncrementImplicitOrderIndex()
Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI.
@ OCV_RELIABILITY
Skip based on the reliability.
static debug_inline bool IsRailDepotTile(Tile t)
Is this tile rail tile and a rail depot?
uint32_t cached_max_range_sqr
Cached squared maximum range.
Order * GetFirstOrder() const
Get the first order of the vehicles order list.
uint8_t state
State of the airport.
static RoadVehicle * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
TimerGameTick::Ticks timetable_duration
NOSAVE: Total timetabled duration of the order list.
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
void RecalculateTimetableDuration()
Recomputes Timetable duration.
StationID GetStationIndex(Tile t)
Get StationID from a tile.
@ OCV_REMAINING_LIFETIME
Skip based on the remaining lifetime.
@ OUFB_NO_UNLOAD
Totally no unloading will be done.
bool HasFullLoadOrder() const
Check if the current vehicle has a full load order.
TileIndex tile
The base tile of the area.
void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar)
Removes an order from all vehicles.
uint16_t GetTimetabledTravel() const
Get the time in ticks a vehicle should take to reach the destination or 0 if it's not timetabled.
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...
uint16_t GetTimetabledWait() const
Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled.
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
uint16_t MapOldOrder() const
Pack this order into a 16 bits integer as close to the TTD representation as possible.
void SetConditionSkipToOrder(VehicleOrderID order_id)
Get the order to skip to.
uint16_t reliability
Reliability.
Vehicle * NextShared() const
Get the next vehicle of the shared vehicle chain.
Order * GetLastOrder() const
Get the last order of the order chain.
@ MP_STATION
A tile of a station.
TimerGameCalendar::Date age
Age in calendar days.
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
uint16_t max_speed
How fast the vehicle may go on the way to the destination.
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
void SetDepotOrderType(OrderDepotTypeFlags depot_order_type)
Set the cause to go to the depot.
TileIndex xy
Base tile of the station.
DestinationID destination
The DestinationID as used for orders.
uint32_t Pack() const
Pack this order into a 32 bits integer, or actually only the type, flags and destination.
Order * first
First order of the order list.
static void RemoveOrder(OrderType type, DestinationID destination, bool hangar)
Removes an order from all vehicles.
Base class for all station-ish types.
static const VehicleOrderID MAX_VEH_ORDER_ID
Last valid VehicleOrderID.
bool HasUnbunchingOrder() const
Check if the current vehicle has an unbunching order.
void SetDepotActionType(OrderDepotActionFlags depot_service_type)
Set what we are going to do in the depot.
uint16_t GetMaxSpeed() const
Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.
@ OCV_LOAD_PERCENTAGE
Skip based on the amount of load.
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Structure to return information about the closest depot location, and whether it could be found.
void MakeConditional(VehicleOrderID order)
Makes this order an conditional order.
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...
bool NeedsServicing() const
Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for ser...
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
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.
Order * GetFirstOrder() const
Get the first order of the order chain.
OrderConditionVariable GetConditionVariable() const
What variable do we have to compare?
@ FACIL_BUS_STOP
Station with bus stops.
uint num_vehicles
NOSAVE: Number of vehicles that share this order list.
bool HasConditionalOrder() const
Check if the current vehicle has a conditional order.
bool IsEmpty() const
Check if the stack is empty.
static Station * GetIfValid(size_t index)
Returns station if the index is a valid index for this station type.
CommandCost CmdOrderRefit(DoCommandFlag flags, VehicleID veh, VehicleOrderID order_number, CargoID cargo)
Add/remove refit orders from an order.
void SetConditionComparator(OrderConditionComparator condition_comparator)
Set the comparator to use.
OrderConditionVariable
Variables (of a vehicle) to 'cause' skipping on.
bool IsBus() const
Check whether a roadvehicle is a bus.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ DA_UNBUNCH
Go to the depot and unbunch.
TileIndex GetLocation(const Vehicle *v, bool airport=false) const
Returns a tile somewhat representing the order destination (not suitable for pathfinding).
uint16_t & GetGroundVehicleFlags()
Access the ground vehicle flags of the vehicle.
uint8_t CalcPercentVehicleFilled(const Vehicle *front, StringID *colour)
Calculates how full a vehicle is.
void SetUnloadType(OrderUnloadFlags unload_type)
Set how the consist must be unloaded.
void SetConditionValue(uint16_t value)
Set the value to base the skip on.
@ OCV_REQUIRES_SERVICE
Skip when the vehicle requires service.
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
virtual TileIndex GetOrderStationLocation([[maybe_unused]] StationID station)
Determine the location for the station where the vehicle goes to next.
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
VehicleType type
Type of vehicle.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
@ MOF_COND_VARIABLE
A conditional variable changes.
uint16_t travel_time
How long in ticks the journey to this destination should take.
CommandCost CmdSkipToOrder(DoCommandFlag flags, VehicleID veh_id, VehicleOrderID sel_ord)
Goto order of order-list.
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
@ VIWD_MODIFY_ORDERS
Other order modifications.
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.
CommandCost CmdModifyOrder(DoCommandFlag flags, VehicleID veh, VehicleOrderID sel_ord, ModifyOrderFlags mof, uint16_t data)
Modify an order in the orderlist of a vehicle.
bool CanVehicleUseStation(EngineID engine_type, const Station *st)
Can this station be used by the given engine type?
static bool OrderGoesToStation(const Vehicle *v, const Order *o)
Checks whether the order goes to a station or not, i.e.
bool CanLeaveWithCargo(bool has_cargo) const
A vehicle can leave the current station with cargo if:
@ OCV_MAX_RELIABILITY
Skip based on the maximum reliability.
@ OCC_IS_FALSE
Skip if the variable is false.
VehicleOrderID GetNumOrders() const
Get the number of orders this vehicle has.
void InvalidateVehicleOrder(const Vehicle *v, int data)
Updates the widgets of a vehicle which contains the order-data.
OrderDepotActionFlags
Actions that can be performed when the vehicle enters the depot.
@ VIWD_REMOVE_ALL_ORDERS
Removed / replaced all orders (after deleting / sharing).
OrderList * orders
Pointer to the order list for this vehicle.
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers:
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.
void DeleteUnreachedImplicitOrders()
Delete all implicit orders which were not reached.
@ WC_STATION_LIST
Station list; Window numbers:
Order * next
Pointer to next order. If nullptr, end of list.
TimerGameTick::Ticks total_duration
NOSAVE: Total (timetabled or not) duration of the order list.
CommandCost CmdInsertOrder(DoCommandFlag flags, VehicleID veh, VehicleOrderID sel_ord, const Order &new_order)
Add an order to the orderlist of a vehicle.
@ DA_SERVICE
Service only if needed.
VehicleOrderID GetNumOrders() const
Get number of orders in the order list.
TileArea ship_station
Tile area the ship 'station' part covers.
bool Equals(const Order &other) const
Does this order have the same type, flags and destination?
@ OCV_AGE
Skip based on the age.
void InsertOrderAt(Order *new_order, int index)
Insert a new order into the order chain.
@ MOF_DEPOT_ACTION
Selects the OrderDepotAction.
void SetNonStopType(OrderNonStopFlags non_stop_type)
Set whether we must stop at stations or not.
DestinationID dest
The destination of the order.
void MakeImplicit(StationID destination)
Makes this order an implicit order.
@ FLYING
Vehicle is flying in the air.
OrderConditionComparator
Comparator for the skip reasoning.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
GUISettings gui
settings related to the GUI
@ OCC_LESS_THAN
Skip if the value is less than the limit.
WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
@ OCV_UNCONDITIONALLY
Always skip.
@ OLFB_NO_LOAD
Do not load anything.
VehicleOrderID num_orders
NOSAVE: How many orders there are in the list.
static debug_inline bool IsRoadDepotTile(Tile t)
Return whether a tile is a road depot tile.
OrderLoadFlags GetLoadType() const
How must the consist be loaded?