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

	for (v = v->FirstShared(); v != NULL; v = v->NextShared()) {

    28

		if (v->cur_order_index == order_number && v->current_order.Equals(*order)) {

    29

			if (is_journey) {

    30

				v->current_order.travel_time = time;

    31

			} else {

    32

				v->current_order.wait_time = time;

    33

			}

    34

		}

    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

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

    49

 * @param p2 The amount of time to wait.

    50

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

    51

 *                      Travelling time if p1 bit 25 is set.

    52

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

    53

 */

    54

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

    55

{

    56

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

    57

    58

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

    59

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

    60

    61

	Vehicle *v = GetVehicle(veh);

    62

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

    63

    64

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

    65

	Order *order = GetVehicleOrder(v, order_number);

    66

	if (order == NULL) return CMD_ERROR;

    67

    68

	bool packed_time = HasBit(p1, 25);

    69

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

    70

    71

	int wait_time   = order->wait_time;

    72

	int travel_time = order->travel_time;

    73

	if (packed_time) {

    74

		travel_time = GB(p2, 0, 16);

    75

		wait_time   = GB(p2, 16, 16);;

    76

	} else if (is_journey) {

    77

		travel_time = GB(p2, 0, 16);

    78

	} else {

    79

		wait_time   = GB(p2, 0, 16);

    80

	}

    81

    82

	if (wait_time != order->wait_time) {

    83

		switch (order->GetType()) {

    84

			case OT_GOTO_STATION:

    85

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

    86

				break;

    87

    88

			case OT_CONDITIONAL:

    89

				break;

    90

    91

			default: return_cmd_error(STR_TIMETABLE_ONLY_WAIT_AT_STATIONS);

    92

		}

    93

	}

    94

    95

	if (travel_time != order->travel_time && order->IsType(OT_CONDITIONAL)) return CMD_ERROR;

    96

    97

	if (flags & DC_EXEC) {

    98

		if (wait_time   != order->wait_time)   ChangeTimetable(v, order_number, wait_time,   false);

    99

		if (travel_time != order->travel_time) ChangeTimetable(v, order_number, travel_time, true);

   100

	}

   101

   102

	return CommandCost();

   103

}

   104

   105

/**

   106

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

   107

 * @param tile Not used.

   108

 * @param flags Operation to perform.

   109

 * @param p1 Various bitstuffed elements

   110

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

   111

 */

   112

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

   113

{

   114

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

   115

   116

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

   117

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   118

   119

	Vehicle *v = GetVehicle(veh);

   120

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

   121

   122

	if (flags & DC_EXEC) {

   123

		v->lateness_counter = 0;

   124

	}

   125

   126

	return CommandCost();

   127

}

   128

   129

/**

   130

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

   131

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

   132

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

   133

 * @param tile Not used.

   134

 * @param flags Operation to perform.

   135

 * @param p1 Vehicle index.

   136

 * @param p2 Various bitstuffed elements

   137

 * - p2 = (bit 0) - Set to 1 to enable, 0 to disable autofill.

   138

 * - p2 = (bit 1) - Set to 1 to preserve waiting times in non-destructive mode

   139

 */

   140

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

   141

{

   142

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

   143

   144

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

   145

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   146

   147

	Vehicle *v = GetVehicle(veh);

   148

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

   149

   150

	if (flags & DC_EXEC) {

   151

		if (HasBit(p2, 0)) {

   152

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

   153

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

   154

			SetBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   155

			ClrBit(v->vehicle_flags, VF_TIMETABLE_STARTED);

   156

   157

			if (HasBit(p2, 1)) SetBit(v->vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME);

   158

   159

			v->lateness_counter = 0;

   160

		} else {

   161

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   162

			ClrBit(v->vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME);

   163

		}

   164

	}

   165

   166

	for (v = v->FirstShared(); v != NULL; v = v->NextShared()) {

   167

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   168

	}

   169

   170

	return CommandCost();

   171

}

   172

   173

void UpdateVehicleTimetable(Vehicle *v, bool travelling)

   174

{

   175

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

   176

	uint time_taken = v->current_order_time;

   177

   178

	v->current_order_time = 0;

   179

   180

	if (!_settings_game.order.timetabling) return;

   181

   182

	bool just_started = false;

   183

   184

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

   185

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

   186

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

   187

		SetBit(v->vehicle_flags, VF_TIMETABLE_STARTED);

   188

		just_started = true;

   189

	}

   190

   191

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

   192

   193

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

   194

		if (travelling && !HasBit(v->vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME)) {

   195

			/* Need to clear that now as otherwise we are not able to reduce the wait time */

   196

			v->current_order.wait_time = 0;

   197

		}

   198

   199

		if (just_started) return;

   200

   201

		/* Modify station waiting time only if our new value is larger (this is

   202

		 * always the case when we cleared the timetable). */

   203

		if (!v->current_order.IsType(OT_CONDITIONAL) && (travelling || time_taken > v->current_order.wait_time)) {

   204

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

   205

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

   206

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

   207

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

   208

   209

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

   210

		}

   211

   212

		if (v->cur_order_index == 0 && travelling) {

   213

			/* If we just started we would have returned earlier and have not reached

   214

			 * this code. So obviously, we have completed our round: So turn autofill

   215

			 * off again. */

   216

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   217

			ClrBit(v->vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME);

   218

		}

   219

		return;

   220

	}

   221

   222

	if (just_started) return;

   223

   224

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

   225

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

   226

	 * when this happens. */

   227

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

   228

   229

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

   230

   231

	for (v = v->FirstShared(); v != NULL; v = v->NextShared()) {

   232

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   233

	}

   234

}