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

    72

	int wait_time   = -1;

    73

	int travel_time = -1;

    74

	if (packed_time) {

    75

		travel_time = GB(p2, 0, 16);

    76

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

    77

	} else if (is_journey) {

    78

		travel_time = GB(p2, 0, 16);

    79

	} else {

    80

		wait_time   = GB(p2, 0, 16);

    81

	}

    82

    83

	if (wait_time != -1) {

    84

		switch (order->GetType()) {

    85

			case OT_GOTO_STATION:

    86

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

    87

				break;

    88

    89

			case OT_CONDITIONAL:

    90

				break;

    91

    92

			default: return_cmd_error(STR_TIMETABLE_ONLY_WAIT_AT_STATIONS);

    93

		}

    94

	}

    95

    96

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

    97

    98

	if (flags & DC_EXEC) {

    99

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

   100

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

   101

	}

   102

   103

	return CommandCost();

   104

}

   105

   106

/**

   107

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

   108

 * @param tile Not used.

   109

 * @param flags Operation to perform.

   110

 * @param p1 Various bitstuffed elements

   111

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

   112

 */

   113

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

   114

{

   115

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

   116

   117

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

   118

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   119

   120

	Vehicle *v = GetVehicle(veh);

   121

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

   122

   123

	if (flags & DC_EXEC) {

   124

		v->lateness_counter = 0;

   125

	}

   126

   127

	return CommandCost();

   128

}

   129

   130

/**

   131

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

   132

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

   133

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

   134

 * @param tile Not used.

   135

 * @param flags Operation to perform.

   136

 * @param p1 Vehicle index.

   137

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

   138

 */

   139

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

   140

{

   141

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

   142

   143

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

   144

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   145

   146

	Vehicle *v = GetVehicle(veh);

   147

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

   148

   149

	if (flags & DC_EXEC) {

   150

		if (p2 == 1) {

   151

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

   152

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

   153

			SetBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   154

			ClrBit(v->vehicle_flags, VF_TIMETABLE_STARTED);

   155

   156

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

   157

				order->wait_time = 0;

   158

				order->travel_time = 0;

   159

			}

   160

   161

			v->current_order.wait_time = 0;

   162

			v->current_order.travel_time = 0;

   163

		} else {

   164

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   165

		}

   166

	}

   167

   168

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

   169

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   170

	}

   171

   172

	return CommandCost();

   173

}

   174

   175

void UpdateVehicleTimetable(Vehicle *v, bool travelling)

   176

{

   177

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

   178

	uint time_taken = v->current_order_time;

   179

   180

	v->current_order_time = 0;

   181

   182

	if (!_settings_game.order.timetabling) return;

   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

		return;

   189

	}

   190

   191

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

   192

   193

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

   194

		if (timetabled == 0) {

   195

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

   196

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

   197

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

   198

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

   199

   200

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

   201

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

   202

			}

   203

			return;

   204

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

   205

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

   206

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

   207

			ClrBit(v->vehicle_flags, VF_AUTOFILL_TIMETABLE);

   208

		}

   209

	}

   210

   211

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

   212

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

   213

	 * when this happens. */

   214

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

   215

   216

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

   217

   218

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

   219

		InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   220

	}

   221

}