OpenTTD Source
20241108-master-g80f628063a
|
Commands related to time tabling. More...
#include "stdafx.h"
#include "command_func.h"
#include "company_func.h"
#include "timer/timer_game_tick.h"
#include "timer/timer_game_economy.h"
#include "window_func.h"
#include "vehicle_base.h"
#include "timetable_cmd.h"
#include "timetable.h"
#include "table/strings.h"
#include "safeguards.h"
Go to the source code of this file.
Functions | |
TimerGameTick::TickCounter | GetStartTickFromDate (TimerGameEconomy::Date start_date) |
Get the TimerGameTick::TickCounter tick of a given date. More... | |
TimerGameEconomy::Date | GetDateFromStartTick (TimerGameTick::TickCounter start_tick) |
Get a date from a given start tick of timetable. More... | |
static void | ChangeTimetable (Vehicle *v, VehicleOrderID order_number, uint16_t val, ModifyTimetableFlags mtf, bool timetabled) |
Change/update a particular timetable entry. More... | |
CommandCost | CmdChangeTimetable (DoCommandFlag flags, VehicleID veh, VehicleOrderID order_number, ModifyTimetableFlags mtf, uint16_t data) |
Change timetable data of an order. More... | |
CommandCost | CmdBulkChangeTimetable (DoCommandFlag flags, VehicleID veh, ModifyTimetableFlags mtf, uint16_t data) |
Change timetable data of all orders of a vehicle. More... | |
CommandCost | CmdSetVehicleOnTime (DoCommandFlag flags, VehicleID veh, bool apply_to_group) |
Clear the lateness counter to make the vehicle on time. More... | |
static bool | VehicleTimetableSorter (Vehicle *const &a, Vehicle *const &b) |
Order vehicles based on their timetable. More... | |
CommandCost | CmdSetTimetableStart (DoCommandFlag flags, VehicleID veh_id, bool timetable_all, TimerGameTick::TickCounter start_tick) |
Set the start date of the timetable. More... | |
CommandCost | CmdAutofillTimetable (DoCommandFlag flags, VehicleID veh, bool autofill, bool preserve_wait_time) |
Start or stop filling the timetable automatically from the time the vehicle actually takes to complete it. More... | |
void | UpdateVehicleTimetable (Vehicle *v, bool travelling) |
Update the timetable for the vehicle. More... | |
Commands related to time tabling.
Definition in file timetable_cmd.cpp.
|
static |
Change/update a particular timetable entry.
v | The vehicle to change the timetable of. |
order_number | The index of the timetable in the order list. |
val | The new data of the timetable entry. |
mtf | Which part of the timetable entry to change. |
timetabled | If the new value is explicitly timetabled. |
Definition at line 66 of file timetable_cmd.cpp.
CommandCost CmdAutofillTimetable | ( | DoCommandFlag | flags, |
VehicleID | veh, | ||
bool | autofill, | ||
bool | preserve_wait_time | ||
) |
Start or stop filling the timetable automatically from the time the vehicle actually takes to complete it.
When starting to autofill the current times are cleared and the timetable will start again from scratch.
flags | Operation to perform. |
veh | Vehicle index. |
autofill | Enable or disable autofill |
preserve_wait_time | Set to preserve waiting times in non-destructive mode |
Definition at line 425 of file timetable_cmd.cpp.
References CheckOwnership(), ClrBit(), CMD_ERROR, DC_EXEC, CommandCost::Failed(), Vehicle::FirstShared(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Vehicle::IsPrimaryVehicle(), BaseConsist::lateness_counter, Vehicle::NextShared(), Vehicle::orders, Vehicle::owner, SetBit(), SetWindowDirty(), BaseConsist::timetable_start, BaseConsist::vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME, VF_AUTOFILL_TIMETABLE, VF_TIMETABLE_STARTED, and WC_VEHICLE_TIMETABLE.
CommandCost CmdBulkChangeTimetable | ( | DoCommandFlag | flags, |
VehicleID | veh, | ||
ModifyTimetableFlags | mtf, | ||
uint16_t | data | ||
) |
Change timetable data of all orders of a vehicle.
flags | Operation to perform. |
veh | Vehicle with the orders to change. |
mtf | Timetable data to change ( |
data | The data to modify as specified by mtf . 0 to clear times, UINT16_MAX to clear speed limit. |
Definition at line 228 of file timetable_cmd.cpp.
CommandCost CmdChangeTimetable | ( | DoCommandFlag | flags, |
VehicleID | veh, | ||
VehicleOrderID | order_number, | ||
ModifyTimetableFlags | mtf, | ||
uint16_t | data | ||
) |
Change timetable data of an order.
flags | Operation to perform. |
veh | Vehicle with the orders to change. |
order_number | Order index to modify. |
mtf | Timetable data to change ( |
data | The data to modify as specified by mtf . 0 to clear times, UINT16_MAX to clear speed limit. |
Definition at line 133 of file timetable_cmd.cpp.
CommandCost CmdSetTimetableStart | ( | DoCommandFlag | flags, |
VehicleID | veh_id, | ||
bool | timetable_all, | ||
TimerGameTick::TickCounter | start_tick | ||
) |
Set the start date of the timetable.
flags | Operation to perform. |
veh_id | Vehicle ID. |
timetable_all | Set to set timetable start for all vehicles sharing this order |
start_tick | The TimerGameTick::counter tick when the timetable starts. |
Definition at line 351 of file timetable_cmd.cpp.
References CheckOwnership(), CMD_ERROR, TimerGameEconomy::date, TimerGame< struct Economy >::DateAtStartOfYear(), Ticks::DAY_TICKS, TimerGameConst< struct Economy >::DAYS_IN_LEAP_YEAR, DC_EXEC, CommandCost::Failed(), GetDateFromStartTick(), OrderList::GetFirstSharedVehicle(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), OrderList::GetTimetableTotalDuration(), OrderList::IsCompleteTimetable(), Vehicle::IsPrimaryVehicle(), TimerGameConst< struct Economy >::MAX_DATE, MAX_TIMETABLE_START_YEARS, Vehicle::NextShared(), Vehicle::orders, and Vehicle::owner.
CommandCost CmdSetVehicleOnTime | ( | DoCommandFlag | flags, |
VehicleID | veh, | ||
bool | apply_to_group | ||
) |
Clear the lateness counter to make the vehicle on time.
flags | Operation to perform. |
veh | Vehicle with the orders to change. |
apply_to_group | Set to reset the late counter for all vehicles sharing the orders. |
Definition at line 259 of file timetable_cmd.cpp.
References CheckOwnership(), CMD_ERROR, DC_EXEC, CommandCost::Failed(), Vehicle::FirstShared(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), HasBit(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Vehicle::IsPrimaryVehicle(), BaseConsist::lateness_counter, Vehicle::NextShared(), Vehicle::orders, Vehicle::owner, BaseConsist::ResetDepotUnbunching(), SetWindowDirty(), BaseConsist::vehicle_flags, VF_TIMETABLE_STARTED, and WC_VEHICLE_TIMETABLE.
TimerGameEconomy::Date GetDateFromStartTick | ( | TimerGameTick::TickCounter | start_tick | ) |
Get a date from a given start tick of timetable.
start_tick | The TimerGameTick::TickCounter when the timetable starts. |
Definition at line 46 of file timetable_cmd.cpp.
References TimerGameTick::counter, TimerGameEconomy::date, TimerGameEconomy::date_fract, and Ticks::DAY_TICKS.
Referenced by CmdSetTimetableStart().
TimerGameTick::TickCounter GetStartTickFromDate | ( | TimerGameEconomy::Date | start_date | ) |
Get the TimerGameTick::TickCounter tick of a given date.
start_date | The date when the timetable starts. |
Definition at line 29 of file timetable_cmd.cpp.
References TimerGameTick::counter, TimerGameEconomy::date, TimerGameEconomy::date_fract, and Ticks::DAY_TICKS.
Referenced by ChangeTimetableStartCallback().
void UpdateVehicleTimetable | ( | Vehicle * | v, |
bool | travelling | ||
) |
Update the timetable for the vehicle.
v | The vehicle to update the timetable for. |
travelling | Whether we just travelled or waited at a station. |
Definition at line 469 of file timetable_cmd.cpp.
References Vehicle::current_order, BaseConsist::current_order_time, and Order::IsType().
Order vehicles based on their timetable.
The vehicles will be sorted in order they would reach the first station.
Definition at line 313 of file timetable_cmd.cpp.
References BaseConsist::cur_real_order_index, Vehicle::current_order, and Order::IsType().