OpenTTD Source  12.0-beta2
timetable_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 "command_func.h"
12 #include "company_func.h"
13 #include "date_func.h"
14 #include "window_func.h"
15 #include "vehicle_base.h"
16 #include "cmd_helper.h"
17 
18 #include "table/strings.h"
19 
20 #include "safeguards.h"
21 
30 static void ChangeTimetable(Vehicle *v, VehicleOrderID order_number, uint16 val, ModifyTimetableFlags mtf, bool timetabled)
31 {
32  Order *order = v->GetOrder(order_number);
33  int total_delta = 0;
34  int timetable_delta = 0;
35 
36  switch (mtf) {
37  case MTF_WAIT_TIME:
38  total_delta = val - order->GetWaitTime();
39  timetable_delta = (timetabled ? val : 0) - order->GetTimetabledWait();
40  order->SetWaitTime(val);
41  order->SetWaitTimetabled(timetabled);
42  break;
43 
44  case MTF_TRAVEL_TIME:
45  total_delta = val - order->GetTravelTime();
46  timetable_delta = (timetabled ? val : 0) - order->GetTimetabledTravel();
47  order->SetTravelTime(val);
48  order->SetTravelTimetabled(timetabled);
49  break;
50 
51  case MTF_TRAVEL_SPEED:
52  order->SetMaxSpeed(val);
53  break;
54 
55  default:
56  NOT_REACHED();
57  }
58  v->orders.list->UpdateTotalDuration(total_delta);
59  v->orders.list->UpdateTimetableDuration(timetable_delta);
60 
61  for (v = v->FirstShared(); v != nullptr; v = v->NextShared()) {
62  if (v->cur_real_order_index == order_number && v->current_order.Equals(*order)) {
63  switch (mtf) {
64  case MTF_WAIT_TIME:
65  v->current_order.SetWaitTime(val);
66  v->current_order.SetWaitTimetabled(timetabled);
67  break;
68 
69  case MTF_TRAVEL_TIME:
71  v->current_order.SetTravelTimetabled(timetabled);
72  break;
73 
74  case MTF_TRAVEL_SPEED:
75  v->current_order.SetMaxSpeed(val);
76  break;
77 
78  default:
79  NOT_REACHED();
80  }
81  }
83  }
84 }
85 
100 CommandCost CmdChangeTimetable(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
101 {
102  VehicleID veh = GB(p1, 0, 20);
103 
104  Vehicle *v = Vehicle::GetIfValid(veh);
105  if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
106 
107  CommandCost ret = CheckOwnership(v->owner);
108  if (ret.Failed()) return ret;
109 
110  VehicleOrderID order_number = GB(p1, 20, 8);
111  Order *order = v->GetOrder(order_number);
112  if (order == nullptr || order->IsType(OT_IMPLICIT)) return CMD_ERROR;
113 
114  ModifyTimetableFlags mtf = Extract<ModifyTimetableFlags, 28, 2>(p1);
115  if (mtf >= MTF_END) return CMD_ERROR;
116 
117  int wait_time = order->GetWaitTime();
118  int travel_time = order->GetTravelTime();
119  int max_speed = order->GetMaxSpeed();
120  switch (mtf) {
121  case MTF_WAIT_TIME:
122  wait_time = GB(p2, 0, 16);
123  break;
124 
125  case MTF_TRAVEL_TIME:
126  travel_time = GB(p2, 0, 16);
127  break;
128 
129  case MTF_TRAVEL_SPEED:
130  max_speed = GB(p2, 0, 16);
131  if (max_speed == 0) max_speed = UINT16_MAX; // Disable speed limit.
132  break;
133 
134  default:
135  NOT_REACHED();
136  }
137 
138  if (wait_time != order->GetWaitTime()) {
139  switch (order->GetType()) {
140  case OT_GOTO_STATION:
141  if (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) return_cmd_error(STR_ERROR_TIMETABLE_NOT_STOPPING_HERE);
142  break;
143 
144  case OT_CONDITIONAL:
145  break;
146 
147  default: return_cmd_error(STR_ERROR_TIMETABLE_ONLY_WAIT_AT_STATIONS);
148  }
149  }
150 
151  if (travel_time != order->GetTravelTime() && order->IsType(OT_CONDITIONAL)) return CMD_ERROR;
152  if (max_speed != order->GetMaxSpeed() && (order->IsType(OT_CONDITIONAL) || v->type == VEH_AIRCRAFT)) return CMD_ERROR;
153 
154  if (flags & DC_EXEC) {
155  switch (mtf) {
156  case MTF_WAIT_TIME:
157  /* Set time if changing the value or confirming an estimated time as timetabled. */
158  if (wait_time != order->GetWaitTime() || (wait_time > 0 && !order->IsWaitTimetabled())) {
159  ChangeTimetable(v, order_number, wait_time, MTF_WAIT_TIME, wait_time > 0);
160  }
161  break;
162 
163  case MTF_TRAVEL_TIME:
164  /* Set time if changing the value or confirming an estimated time as timetabled. */
165  if (travel_time != order->GetTravelTime() || (travel_time > 0 && !order->IsTravelTimetabled())) {
166  ChangeTimetable(v, order_number, travel_time, MTF_TRAVEL_TIME, travel_time > 0);
167  }
168  break;
169 
170  case MTF_TRAVEL_SPEED:
171  if (max_speed != order->GetMaxSpeed()) {
172  ChangeTimetable(v, order_number, max_speed, MTF_TRAVEL_SPEED, max_speed != UINT16_MAX);
173  }
174  break;
175 
176  default:
177  break;
178  }
179  }
180 
181  return CommandCost();
182 }
183 
194 CommandCost CmdSetVehicleOnTime(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
195 {
196  VehicleID veh = GB(p1, 0, 20);
197 
198  Vehicle *v = Vehicle::GetIfValid(veh);
199  if (v == nullptr || !v->IsPrimaryVehicle() || v->orders.list == nullptr) return CMD_ERROR;
200 
201  CommandCost ret = CheckOwnership(v->owner);
202  if (ret.Failed()) return ret;
203 
204  if (flags & DC_EXEC) {
205  v->lateness_counter = 0;
207  }
208 
209  return CommandCost();
210 }
211 
220 static bool VehicleTimetableSorter(Vehicle * const &a, Vehicle * const &b)
221 {
224  int j = (int)b_order - (int)a_order;
225 
226  /* Are we currently at an ordered station (un)loading? */
227  bool a_load = a->current_order.IsType(OT_LOADING) && a->current_order.GetNonStopType() != ONSF_STOP_EVERYWHERE;
228  bool b_load = b->current_order.IsType(OT_LOADING) && b->current_order.GetNonStopType() != ONSF_STOP_EVERYWHERE;
229 
230  /* If the current order is not loading at the ordered station, decrease the order index by one since we have
231  * not yet arrived at the station (and thus the timetable entry; still in the travelling of the previous one).
232  * Since the ?_order variables are unsigned the -1 will flow under and place the vehicles going to order #0 at
233  * the begin of the list with vehicles arriving at #0. */
234  if (!a_load) a_order--;
235  if (!b_load) b_order--;
236 
237  /* First check the order index that accounted for loading, then just the raw one. */
238  int i = (int)b_order - (int)a_order;
239  if (i != 0) return i < 0;
240  if (j != 0) return j < 0;
241 
242  /* Look at the time we spent in this order; the higher, the closer to its destination. */
244  if (i != 0) return i < 0;
245 
246  /* If all else is equal, use some unique index to sort it the same way. */
247  return b->unitnumber < a->unitnumber;
248 }
249 
261 CommandCost CmdSetTimetableStart(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
262 {
263  bool timetable_all = HasBit(p1, 20);
264  Vehicle *v = Vehicle::GetIfValid(GB(p1, 0, 20));
265  if (v == nullptr || !v->IsPrimaryVehicle() || v->orders.list == nullptr) return CMD_ERROR;
266 
267  CommandCost ret = CheckOwnership(v->owner);
268  if (ret.Failed()) return ret;
269 
270  /* Don't let a timetable start more than 15 years into the future or 1 year in the past. */
271  Date start_date = (Date)p2;
272  if (start_date < 0 || start_date > MAX_DAY) return CMD_ERROR;
273  if (start_date - _date > 15 * DAYS_IN_LEAP_YEAR) return CMD_ERROR;
274  if (_date - start_date > DAYS_IN_LEAP_YEAR) return CMD_ERROR;
275  if (timetable_all && !v->orders.list->IsCompleteTimetable()) return CMD_ERROR;
276 
277  if (flags & DC_EXEC) {
278  std::vector<Vehicle *> vehs;
279 
280  if (timetable_all) {
281  for (Vehicle *w = v->orders.list->GetFirstSharedVehicle(); w != nullptr; w = w->NextShared()) {
282  vehs.push_back(w);
283  }
284  } else {
285  vehs.push_back(v);
286  }
287 
288  int total_duration = v->orders.list->GetTimetableTotalDuration();
289  int num_vehs = (uint)vehs.size();
290 
291  if (num_vehs >= 2) {
292  std::sort(vehs.begin(), vehs.end(), &VehicleTimetableSorter);
293  }
294 
295  int idx = vehs.begin() - std::find(vehs.begin(), vehs.end(), v);
296 
297  for (Vehicle *w : vehs) {
298 
299  w->lateness_counter = 0;
300  ClrBit(w->vehicle_flags, VF_TIMETABLE_STARTED);
301  /* Do multiplication, then division to reduce rounding errors. */
302  w->timetable_start = start_date + idx * total_duration / num_vehs / DAY_TICKS;
304  ++idx;
305  }
306 
307  }
308 
309  return CommandCost();
310 }
311 
312 
326 CommandCost CmdAutofillTimetable(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
327 {
328  VehicleID veh = GB(p1, 0, 20);
329 
330  Vehicle *v = Vehicle::GetIfValid(veh);
331  if (v == nullptr || !v->IsPrimaryVehicle() || v->orders.list == nullptr) return CMD_ERROR;
332 
333  CommandCost ret = CheckOwnership(v->owner);
334  if (ret.Failed()) return ret;
335 
336  if (flags & DC_EXEC) {
337  if (HasBit(p2, 0)) {
338  /* Start autofilling the timetable, which clears the
339  * "timetable has started" bit. Times are not cleared anymore, but are
340  * overwritten when the order is reached now. */
343 
344  /* Overwrite waiting times only if they got longer */
346 
347  v->timetable_start = 0;
348  v->lateness_counter = 0;
349  } else {
352  }
353 
354  for (Vehicle *v2 = v->FirstShared(); v2 != nullptr; v2 = v2->NextShared()) {
355  if (v2 != v) {
356  /* Stop autofilling; only one vehicle at a time can perform autofill */
357  ClrBit(v2->vehicle_flags, VF_AUTOFILL_TIMETABLE);
358  ClrBit(v2->vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME);
359  }
361  }
362  }
363 
364  return CommandCost();
365 }
366 
372 void UpdateVehicleTimetable(Vehicle *v, bool travelling)
373 {
374  uint time_taken = v->current_order_time;
375 
376  v->current_order_time = 0;
377 
378  if (v->current_order.IsType(OT_IMPLICIT)) return; // no timetabling of auto orders
379 
380  if (v->cur_real_order_index >= v->GetNumOrders()) return;
381  Order *real_current_order = v->GetOrder(v->cur_real_order_index);
382 
383  VehicleOrderID first_manual_order = 0;
384  for (Order *o = v->GetFirstOrder(); o != nullptr && o->IsType(OT_IMPLICIT); o = o->next) {
385  ++first_manual_order;
386  }
387 
388  bool just_started = false;
389 
390  /* This vehicle is arriving at the first destination in the timetable. */
391  if (v->cur_real_order_index == first_manual_order && travelling) {
392  /* If the start date hasn't been set, or it was set automatically when
393  * the vehicle last arrived at the first destination, update it to the
394  * current time. Otherwise set the late counter appropriately to when
395  * the vehicle should have arrived. */
396  just_started = !HasBit(v->vehicle_flags, VF_TIMETABLE_STARTED);
397 
398  if (v->timetable_start != 0) {
400  v->timetable_start = 0;
401  }
402 
405  }
406 
407  if (!HasBit(v->vehicle_flags, VF_TIMETABLE_STARTED)) return;
408 
409  bool autofilling = HasBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);
410  bool remeasure_wait_time = !real_current_order->IsWaitTimetabled() ||
411  (autofilling && !HasBit(v->vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME));
412 
413  if (travelling && remeasure_wait_time) {
414  /* We just finished travelling and want to remeasure the loading time,
415  * so do not apply any restrictions for the loading to finish. */
417  }
418 
419  if (just_started) return;
420 
421  /* Before modifying waiting times, check whether we want to preserve bigger ones. */
422  if (!real_current_order->IsType(OT_CONDITIONAL) &&
423  (travelling || time_taken > real_current_order->GetWaitTime() || remeasure_wait_time)) {
424  /* Round the time taken up to the nearest day, as this will avoid
425  * confusion for people who are timetabling in days, and can be
426  * adjusted later by people who aren't.
427  * For trains/aircraft multiple movement cycles are done in one
428  * tick. This makes it possible to leave the station and process
429  * e.g. a depot order in the same tick, causing it to not fill
430  * the timetable entry like is done for road vehicles/ships.
431  * Thus always make sure at least one tick is used between the
432  * processing of different orders when filling the timetable. */
433  uint time_to_set = CeilDiv(std::max(time_taken, 1U), DAY_TICKS) * DAY_TICKS;
434 
435  if (travelling && (autofilling || !real_current_order->IsTravelTimetabled())) {
436  ChangeTimetable(v, v->cur_real_order_index, time_to_set, MTF_TRAVEL_TIME, autofilling);
437  } else if (!travelling && (autofilling || !real_current_order->IsWaitTimetabled())) {
438  ChangeTimetable(v, v->cur_real_order_index, time_to_set, MTF_WAIT_TIME, autofilling);
439  }
440  }
441 
442  if (v->cur_real_order_index == first_manual_order && travelling) {
443  /* If we just started we would have returned earlier and have not reached
444  * this code. So obviously, we have completed our round: So turn autofill
445  * off again. */
448  }
449 
450  if (autofilling) return;
451 
452  uint timetabled = travelling ? real_current_order->GetTimetabledTravel() :
453  real_current_order->GetTimetabledWait();
454 
455  /* Vehicles will wait at stations if they arrive early even if they are not
456  * timetabled to wait there, so make sure the lateness counter is updated
457  * when this happens. */
458  if (timetabled == 0 && (travelling || v->lateness_counter >= 0)) return;
459 
460  v->lateness_counter -= (timetabled - time_taken);
461 
462  /* When we are more late than this timetabled bit takes we (somewhat expensively)
463  * check how many ticks the (fully filled) timetable has. If a timetable cycle is
464  * shorter than the amount of ticks we are late we reduce the lateness by the
465  * length of a full cycle till lateness is less than the length of a timetable
466  * cycle. When the timetable isn't fully filled the cycle will be INVALID_TICKS. */
467  if (v->lateness_counter > (int)timetabled) {
469  if (cycle != INVALID_TICKS && v->lateness_counter > cycle) {
470  v->lateness_counter %= cycle;
471  }
472  }
473 
474  for (v = v->FirstShared(); v != nullptr; v = v->NextShared()) {
476  }
477 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
VehicleOrderID
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
MTF_TRAVEL_SPEED
@ MTF_TRAVEL_SPEED
Set max travel speed.
Definition: order_type.h:173
Order::GetWaitTime
uint16 GetWaitTime() const
Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).
Definition: order_base.h:186
CmdSetTimetableStart
CommandCost CmdSetTimetableStart(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Set the start date of the timetable.
Definition: timetable_cmd.cpp:261
Order::IsType
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:64
Order::GetTimetabledWait
uint16 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:182
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3120
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
command_func.h
Pool::PoolItem<&_vehicle_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:348
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:23
ModifyTimetableFlags
ModifyTimetableFlags
Enumeration for the data to set in CmdChangeTimetable.
Definition: order_type.h:170
MTF_WAIT_TIME
@ MTF_WAIT_TIME
Set wait time.
Definition: order_type.h:171
OrderList::UpdateTimetableDuration
void UpdateTimetableDuration(Ticks delta)
Must be called if an order's timetable is changed to update internal book keeping.
Definition: order_base.h:385
_date_fract
DateFract _date_fract
Fractional part of the day.
Definition: date.cpp:29
Order::GetTimetabledTravel
uint16 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:184
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
Order::SetTravelTimetabled
void SetTravelTimetabled(bool timetabled)
Set if the travel time is explicitly timetabled (unless the order is conditional).
Definition: order_base.h:200
ClrBit
static T ClrBit(T &x, const uint8 y)
Clears a bit in a variable.
Definition: bitmath_func.hpp:151
vehicle_base.h
OrderList::IsCompleteTimetable
bool IsCompleteTimetable() const
Checks whether all orders of the list have a filled timetable.
Definition: order_cmd.cpp:602
WC_VEHICLE_TIMETABLE
@ WC_VEHICLE_TIMETABLE
Vehicle timetable; Window numbers:
Definition: window_type.h:216
Vehicle::orders
union Vehicle::@49 orders
The orders currently assigned to the vehicle.
MAX_DAY
#define MAX_DAY
The number of days till the last day.
Definition: date_type.h:98
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:221
Vehicle::IsPrimaryVehicle
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: vehicle_base.h:446
OrderList::GetTimetableTotalDuration
Ticks GetTimetableTotalDuration() const
Gets the total duration of the vehicles timetable or INVALID_TICKS is the timetable is not complete.
Definition: order_base.h:367
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:285
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:348
MTF_TRAVEL_TIME
@ MTF_TRAVEL_TIME
Set travel time.
Definition: order_type.h:172
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
Order::GetType
OrderType GetType() const
Get the type of order of this order.
Definition: order_base.h:70
Order::GetMaxSpeed
uint16 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:195
VehicleTimetableSorter
static bool VehicleTimetableSorter(Vehicle *const &a, Vehicle *const &b)
Order vehicles based on their timetable.
Definition: timetable_cmd.cpp:220
VF_AUTOFILL_TIMETABLE
@ VF_AUTOFILL_TIMETABLE
Whether the vehicle should fill in the timetable automatically.
Definition: vehicle_base.h:47
Order::GetNonStopType
OrderNonStopFlags GetNonStopType() const
At which stations must we stop?
Definition: order_base.h:134
ChangeTimetable
static void ChangeTimetable(Vehicle *v, VehicleOrderID order_number, uint16 val, ModifyTimetableFlags mtf, bool timetabled)
Change/update a particular timetable entry.
Definition: timetable_cmd.cpp:30
CheckOwnership
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
Definition: company_cmd.cpp:311
return_cmd_error
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:33
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
cmd_helper.h
_date
Date _date
Current date in days (day counter)
Definition: date.cpp:28
OrderList::GetFirstSharedVehicle
Vehicle * GetFirstSharedVehicle() const
Get the first vehicle of this vehicle chain.
Definition: order_base.h:340
Order::GetTravelTime
uint16 GetTravelTime() const
Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not).
Definition: order_base.h:188
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:159
Vehicle::current_order
Order current_order
The current order (+ status, like: loading)
Definition: vehicle_base.h:329
Date
int32 Date
The type to store our dates in.
Definition: date_type.h:14
safeguards.h
Order::SetTravelTime
void SetTravelTime(uint16 time)
Set the time in ticks to take for travelling to the destination.
Definition: order_base.h:212
Ticks
int32 Ticks
The type to store ticks in.
Definition: date_type.h:16
UpdateVehicleTimetable
void UpdateVehicleTimetable(Vehicle *v, bool travelling)
Update the timetable for the vehicle.
Definition: timetable_cmd.cpp:372
CmdChangeTimetable
CommandCost CmdChangeTimetable(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Change timetable data of an order.
Definition: timetable_cmd.cpp:100
DAYS_IN_LEAP_YEAR
static const int DAYS_IN_LEAP_YEAR
sometimes, you need one day more...
Definition: date_type.h:30
date_func.h
stdafx.h
BaseConsist::vehicle_flags
uint16 vehicle_flags
Used for gradual loading and other miscellaneous things (.
Definition: base_consist.h:31
INVALID_TICKS
static const Ticks INVALID_TICKS
Representation of an invalid number of ticks.
Definition: date_type.h:112
CmdAutofillTimetable
CommandCost CmdAutofillTimetable(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Start or stop filling the timetable automatically from the time the vehicle actually takes to complet...
Definition: timetable_cmd.cpp:326
CmdSetVehicleOnTime
CommandCost CmdSetVehicleOnTime(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Clear the lateness counter to make the vehicle on time.
Definition: timetable_cmd.cpp:194
Order::IsTravelTimetabled
bool IsTravelTimetabled() const
Does this order have an explicit travel time set?
Definition: order_base.h:179
Vehicle::list
OrderList * list
Pointer to the order list for this vehicle.
Definition: vehicle_base.h:332
BaseConsist::cur_real_order_index
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
Definition: base_consist.h:28
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
OrderList::UpdateTotalDuration
void UpdateTotalDuration(Ticks delta)
Must be called if an order's timetable is changed to update internal book keeping.
Definition: order_base.h:391
Vehicle::FirstShared
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:688
BaseConsist::lateness_counter
int32 lateness_counter
How many ticks late (or early if negative) this vehicle is.
Definition: base_consist.h:23
Vehicle::GetFirstOrder
Order * GetFirstOrder() const
Get the first order of the vehicles order list.
Definition: vehicle_base.h:667
BaseConsist::current_order_time
uint32 current_order_time
How many ticks have passed since this order started.
Definition: base_consist.h:22
Vehicle::NextShared
Vehicle * NextShared() const
Get the next vehicle of the shared vehicle chain.
Definition: vehicle_base.h:676
BaseConsist::timetable_start
Date timetable_start
When the vehicle is supposed to start the timetable.
Definition: base_consist.h:24
Order::SetWaitTime
void SetWaitTime(uint16 time)
Set the time in ticks to wait at the destination.
Definition: order_base.h:206
Vehicle::unitnumber
UnitID unitnumber
unit number, for display purposes only
Definition: vehicle_base.h:302
company_func.h
VF_AUTOFILL_PRES_WAIT_TIME
@ VF_AUTOFILL_PRES_WAIT_TIME
Whether non-destructive auto-fill should preserve waiting times.
Definition: vehicle_base.h:48
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
VF_TIMETABLE_STARTED
@ VF_TIMETABLE_STARTED
Whether the vehicle has started running on the timetable yet.
Definition: vehicle_base.h:46
window_func.h
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
CeilDiv
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:254
Order::SetMaxSpeed
void SetMaxSpeed(uint16 speed)
Set the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.
Definition: order_base.h:219
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:52
Vehicle::GetOrder
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
Definition: vehicle_base.h:874
Vehicle::GetNumOrders
VehicleOrderID GetNumOrders() const
Get the number of orders this vehicle has.
Definition: vehicle_base.h:700
Order
Definition: order_base.h:33
DAY_TICKS
static const int DAY_TICKS
1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885.
Definition: date_type.h:28
Order::Equals
bool Equals(const Order &other) const
Does this order have the same type, flags and destination?
Definition: order_cmd.cpp:174
Order::IsWaitTimetabled
bool IsWaitTimetabled() const
Does this order have an explicit wait time set?
Definition: order_base.h:177
Order::SetWaitTimetabled
void SetWaitTimetabled(bool timetabled)
Set if the wait time is explicitly timetabled (unless the order is conditional).
Definition: order_base.h:198