1

/* $Id$ */

     2

     3

/** @file timetable_cmd.cpp Commands related to time tabling. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "command_func.h"

     9

#include "functions.h"

    10

#include "window_func.h"

    11

#include "vehicle_func.h"

    12

#include "vehicle_base.h"

    13

#include "settings_type.h"

    14

    15

#include "table/strings.h"

    16

    17

static void ChangeTimetable(Vehicle *v, VehicleOrderID order_number, uint16 time, bool is_journey)

    18

{

    19

	Order *order = GetVehicleOrder(v, order_number);

    20

    21

	if (is_journey) {

    22

		order->travel_time = time;

    23

	} else {

    24

		order->wait_time = time;

    25

	}

    26

    27

	if (v->cur_order_index == order_number && v->current_order.GetDepotOrderType() & ODTFB_PART_OF_ORDERS) {

    28

		if (is_journey) {

    29

			v->current_order.travel_time = time;

    30

		} else {

    31

			v->current_order.wait_time = time;

    32

		}

    33

	}

    34

    35

	for (v = GetFirstVehicleFromSharedList(v); v != NULL; v = v->next_shared) {

    36

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

    37

	}

    38

}

    39

    40

/**

    41

 * Add or remove waiting times from an order.

    42

 * @param tile Not used.

    43

 * @param flags Operation to perform.

    44

 * @param p1 Various bitstuffed elements

    45

 * - p1 = (bit  0-15) - Vehicle with the orders to change.

    46

 * - p1 = (bit 16-23) - Order index to modify.

    47

 * - p1 = (bit    24) - Whether to change the waiting time or the travelling

    48

 *                      time.

    49

 * - p1 = (bit    25) - Whether p2 contains waiting and travelling time.

    50

 * @param p2 The amount of time to wait.

    51

 * - p2 = (bit  0-15) - Waiting or travelling time as specified by p1 bit 24 if p1 bit 25 is not set,

    52

 *                      Travelling time if p1 bit 25 is set.

    53

 * - p2 = (bit 16-31) - Waiting time if p1 bit 25 is set

    54

 */

    55

CommandCost CmdChangeTimetable(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

    56

{

    57

	if (!_settings_game.order.timetabling) return CMD_ERROR;

    58

    59

	VehicleID veh = GB(p1, 0, 16);

    60

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

    61

    62

	Vehicle *v = GetVehicle(veh);

    63

	if (!CheckOwnership(v->owner)) return CMD_ERROR;

    64

    65

	VehicleOrderID order_number = GB(p1, 16, 8);

    66

	Order *order = GetVehicleOrder(v, order_number);

    67

	if (order == NULL) return CMD_ERROR;

    68

    69

	bool packed_time = HasBit(p1, 25);

    70

	bool is_journey = HasBit(p1, 24) || packed_time;

    71

	if (!is_journey) {

    72

		if (!order->IsType(OT_GOTO_STATION)) return_cmd_error(STR_TIMETABLE_ONLY_WAIT_AT_STATIONS);

    73

		if (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) return_cmd_error(STR_TIMETABLE_NOT_STOPPING_HERE);

    74

	}

    75

    76

	if (flags & DC_EXEC) {

    77

		ChangeTimetable(v, order_number, GB(p2, 0, 16), is_journey);

    78

		if (packed_time) ChangeTimetable(v, order_number, GB(p2, 16, 16), false);

    79

	}

    80

    81

	return CommandCost();

    82

}

    83

    84

/**

    85

 * Clear the lateness counter to make the vehicle on time.

    86

 * @param tile Not used.

    87

 * @param flags Operation to perform.

    88

 * @param p1 Various bitstuffed elements

    89

 * - p1 = (bit  0-15) - Vehicle with the orders to change.

    90

 */

    91

CommandCost CmdSetVehicleOnTime(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

    92

{

    93

	if (!_settings_game.order.timetabling) return CMD_ERROR;

    94

    95

	VehicleID veh = GB(p1, 0, 16);

    96

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

    97

    98

	Vehicle *v = GetVehicle(veh);

    99

	if (!CheckOwnership(v->owner)) return CMD_ERROR;

   100

   101

	if (flags & DC_EXEC) {

   102

		v->lateness_counter = 0;

   103

	}

   104

   105

	return CommandCost();

   106

}

   107

   108

/**

   109

 * Start or stop filling the timetable automatically from the time the vehicle

   110

 * actually takes to complete it. When starting to autofill the current times

   111

 * are cleared and the timetable will start again from scratch.

   112

 * @param tile Not used.

   113

 * @param flags Operation to perform.

   114

 * @param p1 Vehicle index.

   115

 * @param p2 Set to 1 to enable, 0 to disable.

   116

 */

   117

CommandCost CmdAutofillTimetable(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   118

{

   119

	if (!_settings_game.order.timetabling) return CMD_ERROR;

   120

   121

	VehicleID veh = GB(p1, 0, 16);

   122

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   123

   124

	Vehicle *v = GetVehicle(veh);

   125

	if (!CheckOwnership(v->owner)) return CMD_ERROR;

   126

   127

	if (flags & DC_EXEC) {

   128

		if (p2 == 1) {

   129

			/* Start autofilling the timetable, which clears all the current

   130

			 * timings and clears the "timetable has started" bit. */

   131

			SetBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   132

			ClrBit(v->vehicle_flags, VF_TIMETABLE_STARTED);

   133

   134

			for (Order *order = GetVehicleOrder(v, 0); order != NULL; order = order->next) {

   135

				order->wait_time = 0;

   136

				order->travel_time = 0;

   137

			}

   138

   139

			v->current_order.wait_time = 0;

   140

			v->current_order.travel_time = 0;

   141

		} else {

   142

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   143

		}

   144

	}

   145

   146

	for (v = GetFirstVehicleFromSharedList(v); v != NULL; v = v->next_shared) {

   147

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   148

	}

   149

   150

	return CommandCost();

   151

}

   152

   153

void UpdateVehicleTimetable(Vehicle *v, bool travelling)

   154

{

   155

	uint timetabled = travelling ? v->current_order.travel_time : v->current_order.wait_time;

   156

	uint time_taken = v->current_order_time;

   157

   158

	v->current_order_time = 0;

   159

   160

	if (!_settings_game.order.timetabling) return;

   161

   162

	/* Make sure the timetable only starts when the vehicle reaches the first

   163

	 * order, not when travelling from the depot to the first station. */

   164

	if (v->cur_order_index == 0 && !HasBit(v->vehicle_flags, VF_TIMETABLE_STARTED)) {

   165

		SetBit(v->vehicle_flags, VF_TIMETABLE_STARTED);

   166

		return;

   167

	}

   168

   169

	if (!HasBit(v->vehicle_flags, VF_TIMETABLE_STARTED)) return;

   170

   171

	if (HasBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE)) {

   172

		if (timetabled == 0) {

   173

			/* Round the time taken up to the nearest day, as this will avoid

   174

			 * confusion for people who are timetabling in days, and can be

   175

			 * adjusted later by people who aren't. */

   176

			time_taken = (((time_taken - 1) / DAY_TICKS) + 1) * DAY_TICKS;

   177

   178

			ChangeTimetable(v, v->cur_order_index, time_taken, travelling);

   179

			return;

   180

		} else if (v->cur_order_index == 0) {

   181

			/* Otherwise if we're at the beginning and it already has a value,

   182

			 * assume that autofill is finished and turn it off again. */

   183

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   184

		}

   185

	}

   186

   187

	/* Vehicles will wait at stations if they arrive early even if they are not

   188

	 * timetabled to wait there, so make sure the lateness counter is updated

   189

	 * when this happens. */

   190

	if (timetabled == 0 && (travelling || v->lateness_counter >= 0)) return;

   191

   192

	v->lateness_counter -= (timetabled - time_taken);

   193

   194

	for (v = GetFirstVehicleFromSharedList(v); v != NULL; v = v->next_shared) {

   195

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   196

	}

   197

}