1

/* $Id$ */

     2

     3

/** @file timetable_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "variables.h"

     9

#include "table/strings.h"

    10

#include "command.h"

    11

#include "date.h"

    12

#include "player.h"

    13

#include "vehicle.h"

    14

    15

    16

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

    17

{

    18

	Order *order = GetVehicleOrder(v, order_number);

    19

    20

	if (is_journey) {

    21

		order->travel_time = time;

    22

	} else {

    23

		order->wait_time = time;

    24

	}

    25

    26

	if (v->cur_order_index == order_number && HasBit(v->current_order.flags, OFB_PART_OF_ORDERS)) {

    27

		if (is_journey) {

    28

			v->current_order.travel_time = time;

    29

		} else {

    30

			v->current_order.wait_time = time;

    31

		}

    32

	}

    33

    34

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

    35

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

    36

	}

    37

}

    38

    39

/**

    40

 * Add or remove waiting times from an order.

    41

 * @param tile Not used.

    42

 * @param flags Operation to perform.

    43

 * @param p1 Various bitstuffed elements

    44

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

    45

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

    46

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

    47

 *                      time.

    48

 * @param p2 The amount of time to wait.

    49

 */

    50

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

    51

{

    52

	if (!_patches.timetabling) return CMD_ERROR;

    53

    54

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

    55

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

    56

    57

	Vehicle *v = GetVehicle(veh);

    58

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

    59

    60

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

    61

	Order *order = GetVehicleOrder(v, order_number);

    62

	if (order == NULL) return CMD_ERROR;

    63

    64

	bool is_journey = HasBit(p1, 24);

    65

	if (!is_journey) {

    66

		if (order->type != OT_GOTO_STATION) return_cmd_error(STR_TIMETABLE_ONLY_WAIT_AT_STATIONS);

    67

		if (_patches.new_nonstop && (order->flags & OF_NON_STOP)) return_cmd_error(STR_TIMETABLE_NOT_STOPPING_HERE);

    68

	}

    69

    70

	if (flags & DC_EXEC) {

    71

		ChangeTimetable(v, order_number, p2, is_journey);

    72

	}

    73

    74

	return CommandCost();

    75

}

    76

    77

/**

    78

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

    79

 * @param tile Not used.

    80

 * @param flags Operation to perform.

    81

 * @param p1 Various bitstuffed elements

    82

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

    83

 */

    84

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

    85

{

    86

	if (!_patches.timetabling) return CMD_ERROR;

    87

    88

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

    89

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

    90

    91

	Vehicle *v = GetVehicle(veh);

    92

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

    93

    94

	if (flags & DC_EXEC) {

    95

		v->lateness_counter = 0;

    96

	}

    97

    98

	return CommandCost();

    99

}

   100

   101

/**

   102

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

   103

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

   104

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

   105

 * @param tile Not used.

   106

 * @param flags Operation to perform.

   107

 * @param p1 Vehicle index.

   108

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

   109

 */

   110

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

   111

{

   112

	if (!_patches.timetabling) return CMD_ERROR;

   113

   114

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

   115

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   116

   117

	Vehicle *v = GetVehicle(veh);

   118

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

   119

   120

	if (flags & DC_EXEC) {

   121

		if (p2 == 1) {

   122

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

   123

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

   125

			ClrBit(v->vehicle_flags, VF_TIMETABLE_STARTED);

   126

   127

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

   128

				order->wait_time = 0;

   129

				order->travel_time = 0;

   130

			}

   131

   132

			v->current_order.wait_time = 0;

   133

			v->current_order.travel_time = 0;

   134

		} else {

   135

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   136

		}

   137

	}

   138

   139

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

   140

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   141

	}

   142

   143

	return CommandCost();

   144

}

   145

   146

void UpdateVehicleTimetable(Vehicle *v, bool travelling)

   147

{

   148

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

   149

	uint time_taken = v->current_order_time;

   150

   151

	v->current_order_time = 0;

   152

   153

	if (!_patches.timetabling) return;

   154

   155

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

   156

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

   157

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

   159

 		return;

   160

 	}

   161

   162

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

   163

   164

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

   165

		if (timetabled == 0) {

   166

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

   167

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

   168

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

   169

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

   170

   171

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

   172

			return;

   173

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

   174

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

   175

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

   176

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   177

		}

   178

 	}

   179

   180

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

   181

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

   182

	 * when this happens. */

   183

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

   184

   185

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

   186

   187

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

   188

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   189

	}

   190

}