timetable_cmd.cpp File Reference

Commands related to time tabling. More...

#include "stdafx.h"
#include "command_func.h"
#include "functions.h"
#include "date_func.h"
#include "window_func.h"
#include "vehicle_base.h"
#include "table/strings.h"

Go to the source code of this file.

Functions

static void ChangeTimetable (Vehicle *v, VehicleOrderID order_number, uint16 time, bool is_journey)
CommandCost CmdChangeTimetable (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Add or remove waiting times from an order.
CommandCost CmdSetVehicleOnTime (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Clear the lateness counter to make the vehicle on time.
CommandCost CmdSetTimetableStart (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Set the start date of the timetable.
CommandCost CmdAutofillTimetable (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Start or stop filling the timetable automatically from the time the vehicle actually takes to complete it.
void UpdateVehicleTimetable (Vehicle *v, bool travelling)

Detailed Description

Commands related to time tabling.

Definition in file timetable_cmd.cpp.


Function Documentation

CommandCost CmdAutofillTimetable ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

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:
tile Not used.
flags Operation to perform.
p1 Vehicle index.
p2 Various bitstuffed elements

  • p2 = (bit 0) - Set to 1 to enable, 0 to disable autofill.
  • p2 = (bit 1) - Set to 1 to preserve waiting times in non-destructive mode
text unused
Returns:
the cost of this operation or an error

Definition at line 190 of file timetable_cmd.cpp.

References _settings_game, CheckOwnership(), ClrBit(), CMD_ERROR, DC_EXEC, CommandCost::Failed(), Vehicle::FirstShared(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), HasBit(), Vehicle::IsPrimaryVehicle(), Vehicle::lateness_counter, Vehicle::NextShared(), GameSettings::order, Vehicle::owner, SetBit(), SetWindowDirty(), Vehicle::timetable_start, OrderSettings::timetabling, Vehicle::vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME, VF_AUTOFILL_TIMETABLE, and VF_TIMETABLE_STARTED.

CommandCost CmdChangeTimetable ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Add or remove waiting times from an order.

Parameters:
tile Not used.
flags Operation to perform.
p1 Various bitstuffed elements

  • p1 = (bit 0-19) - Vehicle with the orders to change.
  • p1 = (bit 20-27) - Order index to modify.
  • p1 = (bit 28) - Whether to change the waiting time or the travelling time.
p2 The amount of time to wait.

  • p2 = (bit 0-15) - Waiting or travelling time as specified by p1 bit 28
text unused
Returns:
the cost of this operation or an error

Definition at line 61 of file timetable_cmd.cpp.

References _settings_game, CheckOwnership(), CMD_ERROR, DC_EXEC, CommandCost::Failed(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Order::GetNonStopType(), Vehicle::GetOrder(), Order::GetType(), HasBit(), Vehicle::IsPrimaryVehicle(), Order::IsType(), ONSF_NO_STOP_AT_DESTINATION_STATION, GameSettings::order, Vehicle::owner, return_cmd_error, OrderSettings::timetabling, Order::travel_time, and Order::wait_time.

CommandCost CmdSetTimetableStart ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)
CommandCost CmdSetVehicleOnTime ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Clear the lateness counter to make the vehicle on time.

Parameters:
tile Not used.
flags Operation to perform.
p1 Various bitstuffed elements

  • p1 = (bit 0-19) - Vehicle with the orders to change.
p2 unused
text unused
Returns:
the cost of this operation or an error

Definition at line 120 of file timetable_cmd.cpp.

References _settings_game, CheckOwnership(), CMD_ERROR, DC_EXEC, CommandCost::Failed(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem< Tpool >::index, Vehicle::IsPrimaryVehicle(), Vehicle::lateness_counter, GameSettings::order, Vehicle::owner, SetWindowDirty(), and OrderSettings::timetabling.


Generated on Sun Jan 23 01:49:34 2011 for OpenTTD by  doxygen 1.6.1