OpenTTD Source  20241121-master-g67a0fccfad
timetable_cmd.h
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 #ifndef TIMETABLE_CMD_H
11 #define TIMETABLE_CMD_H
12 
13 #include "command_type.h"
14 #include "timer/timer_game_tick.h"
15 
16 CommandCost CmdChangeTimetable(DoCommandFlag flags, VehicleID veh, VehicleOrderID order_number, ModifyTimetableFlags mtf, uint16_t data);
18 CommandCost CmdSetVehicleOnTime(DoCommandFlag flags, VehicleID veh, bool apply_to_group);
19 CommandCost CmdAutofillTimetable(DoCommandFlag flags, VehicleID veh, bool autofill, bool preserve_wait_time);
20 CommandCost CmdSetTimetableStart(DoCommandFlag flags, VehicleID veh_id, bool timetable_all, TimerGameTick::TickCounter start_tick);
21 
27 
28 #endif /* TIMETABLE_CMD_H */
Common return value for all commands.
Definition: command_type.h:23
uint64_t TickCounter
The type that the tick counter is stored in.
Types related to commands.
@ CMDT_ROUTE_MANAGEMENT
Modifications to route management (orders, groups, etc).
Definition: command_type.h:418
DoCommandFlag
List of flags for a command.
Definition: command_type.h:374
@ CMD_SET_TIMETABLE_START
set the date that a timetable should start
Definition: command_type.h:356
@ CMD_SET_VEHICLE_ON_TIME
set the vehicle on time feature (timetable)
Definition: command_type.h:354
@ CMD_CHANGE_TIMETABLE
change the timetable for a vehicle
Definition: command_type.h:352
@ CMD_AUTOFILL_TIMETABLE
autofill the timetable
Definition: command_type.h:355
@ CMD_BULK_CHANGE_TIMETABLE
change the timetable for all orders of a vehicle
Definition: command_type.h:353
uint8_t VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
ModifyTimetableFlags
Enumeration for the data to set in CmdChangeTimetable.
Definition: order_type.h:171
Definition of the tick-based game-timer.
CommandCost CmdSetVehicleOnTime(DoCommandFlag flags, VehicleID veh, bool apply_to_group)
Clear the lateness counter to make the vehicle on time.
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 complet...
CommandCost CmdSetTimetableStart(DoCommandFlag flags, VehicleID veh_id, bool timetable_all, TimerGameTick::TickCounter start_tick)
Set the start date of the timetable.
CommandCost CmdChangeTimetable(DoCommandFlag flags, VehicleID veh, VehicleOrderID order_number, ModifyTimetableFlags mtf, uint16_t data)
Change timetable data of an order.
CommandCost CmdBulkChangeTimetable(DoCommandFlag flags, VehicleID veh, ModifyTimetableFlags mtf, uint16_t data)
Change timetable data of all orders of a vehicle.
uint32_t VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16