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) && !order->IsType(OT_CONDITIONAL)) 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

	} else {

    75

		if (order->IsType(OT_CONDITIONAL)) return CMD_ERROR;

    76

	}

    77

    78

	if (flags & DC_EXEC) {

    79

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

    80

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

    81

	}

    82

    83

	return CommandCost();

    84

}

    85

    86

/**

    87

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

    88

 * @param tile Not used.

    89

 * @param flags Operation to perform.

    90

 * @param p1 Various bitstuffed elements

    91

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

    92

 */

    93

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

    94

{

    95

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

    96

    97

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

    98

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

    99

   100

	Vehicle *v = GetVehicle(veh);

   101

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

   102

   103

	if (flags & DC_EXEC) {

   104

		v->lateness_counter = 0;

   105

	}

   106

   107

	return CommandCost();

   108

}

   109

   110

/**

   111

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

   112

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

   113

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

   114

 * @param tile Not used.

   115

 * @param flags Operation to perform.

   116

 * @param p1 Vehicle index.

   117

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

   118

 */

   119

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

   120

{

   121

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

   122

   123

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

   124

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   125

   126

	Vehicle *v = GetVehicle(veh);

   127

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

   128

   129

	if (flags & DC_EXEC) {

   130

		if (p2 == 1) {

   131

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

   132

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

   133

			SetBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   134

			ClrBit(v->vehicle_flags, VF_TIMETABLE_STARTED);

   135

   136

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

   137

				order->wait_time = 0;

   138

				order->travel_time = 0;

   139

			}

   140

   141

			v->current_order.wait_time = 0;

   142

			v->current_order.travel_time = 0;

   143

		} else {

   144

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   145

		}

   146

	}

   147

   148

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

   149

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   150

	}

   151

   152

	return CommandCost();

   153

}

   154

   155

void UpdateVehicleTimetable(Vehicle *v, bool travelling)

   156

{

   157

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

   158

	uint time_taken = v->current_order_time;

   159

   160

	v->current_order_time = 0;

   161

   162

	if (!_settings_game.order.timetabling) return;

   163

   164

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

   165

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

   166

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

   167

		SetBit(v->vehicle_flags, VF_TIMETABLE_STARTED);

   168

		return;

   169

	}

   170

   171

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

   172

   173

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

   174

		if (timetabled == 0) {

   175

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

   176

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

   177

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

   178

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

   179

   180

			if (!v->current_order.IsType(OT_CONDITIONAL)) {

   181

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

   182

			}

   183

			return;

   184

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

   185

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

   186

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

   187

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   188

		}

   189

	}

   190

   191

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

   192

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

   193

	 * when this happens. */

   194

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

   195

   196

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

   197

   198

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

   199

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   200

	}

   201

}