OpenTTD Source  20241108-master-g80f628063a
timetable_cmd.h File Reference

Command definitions related to timetables. More...

Go to the source code of this file.

Functions

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...
 
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...
 
CommandCost CmdSetTimetableStart (DoCommandFlag flags, VehicleID veh_id, bool timetable_all, TimerGameTick::TickCounter start_tick)
 Set the start date of the timetable. More...
 

Detailed Description

Command definitions related to timetables.

Definition in file timetable_cmd.h.

Function Documentation

◆ CmdAutofillTimetable()

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.

Parameters
flagsOperation to perform.
vehVehicle index.
autofillEnable or disable autofill
preserve_wait_timeSet to preserve waiting times in non-destructive mode
Returns
the cost of this operation or an error

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.

◆ CmdBulkChangeTimetable()

CommandCost CmdBulkChangeTimetable ( DoCommandFlag  flags,
VehicleID  veh,
ModifyTimetableFlags  mtf,
uint16_t  data 
)

Change timetable data of all orders of a vehicle.

Parameters
flagsOperation to perform.
vehVehicle with the orders to change.
mtfTimetable data to change (
See also
ModifyTimetableFlags)
Parameters
dataThe data to modify as specified by mtf. 0 to clear times, UINT16_MAX to clear speed limit.
Returns
the cost of this operation or an error

Definition at line 228 of file timetable_cmd.cpp.

◆ CmdChangeTimetable()

CommandCost CmdChangeTimetable ( DoCommandFlag  flags,
VehicleID  veh,
VehicleOrderID  order_number,
ModifyTimetableFlags  mtf,
uint16_t  data 
)

Change timetable data of an order.

Parameters
flagsOperation to perform.
vehVehicle with the orders to change.
order_numberOrder index to modify.
mtfTimetable data to change (
See also
ModifyTimetableFlags)
Parameters
dataThe data to modify as specified by mtf. 0 to clear times, UINT16_MAX to clear speed limit.
Returns
the cost of this operation or an error

Definition at line 133 of file timetable_cmd.cpp.

◆ CmdSetTimetableStart()

◆ CmdSetVehicleOnTime()

CommandCost CmdSetVehicleOnTime ( DoCommandFlag  flags,
VehicleID  veh,
bool  apply_to_group 
)