1

/* $Id$ */

     2

     3

/** @file order_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "order.h"

     8

#include "airport.h"

     9

#include "vehicle.h"

    10

#include "depot.h"

    11

#include "functions.h"

    12

#include "table/strings.h"

    13

#include "waypoint.h"

    14

#include "command.h"

    15

#include "station.h"

    16

#include "player.h"

    17

#include "news.h"

    18

#include "saveload.h"

    19

#include "vehicle_gui.h"

    20

#include "cargotype.h"

    21

#include "strings.h"

    22

#include "aircraft.h"

    23

    24

DEFINE_OLD_POOL_GENERIC(Order, Order)

    25

    26

/**

    27

 *

    28

 * Unpacks a order from savegames made with TTD(Patch)

    29

 *

    30

 */

    31

Order UnpackOldOrder(uint16 packed)

    32

{

    33

	Order order;

    34

	order.type    = (OrderType)GB(packed, 0, 4);

    35

	order.flags   = GB(packed, 4, 4);

    36

	order.dest    = GB(packed, 8, 8);

    37

	order.next    = NULL;

    38

    39

	order.refit_cargo   = CT_NO_REFIT;

    40

	order.refit_subtype = 0;

    41

	order.wait_time     = 0;

    42

	order.travel_time   = 0;

    43

	order.index = 0; // avoid compiler warning

    44

    45

	// Sanity check

    46

	// TTD stores invalid orders as OT_NOTHING with non-zero flags/station

    47

	if (!order.IsValid() && (order.flags != 0 || order.dest != 0)) {

    48

		order.type = OT_DUMMY;

    49

		order.flags = 0;

    50

	}

    51

    52

	return order;

    53

}

    54

    55

/**

    56

 *

    57

 * Unpacks a order from savegames with version 4 and lower

    58

 *

    59

 */

    60

static Order UnpackVersion4Order(uint16 packed)

    61

{

    62

	Order order;

    63

	order.type  = (OrderType)GB(packed, 0, 4);

    64

	order.flags = GB(packed, 4, 4);

    65

	order.dest  = GB(packed, 8, 8);

    66

	order.next  = NULL;

    67

	order.index = 0; // avoid compiler warning

    68

	order.refit_cargo   = CT_NO_REFIT;

    69

	order.refit_subtype = 0;

    70

	order.wait_time     = 0;

    71

	order.travel_time   = 0;

    72

	return order;

    73

}

    74

    75

/**

    76

 *

    77

 * Updates the widgets of a vehicle which contains the order-data

    78

 *

    79

 */

    80

void InvalidateVehicleOrder(const Vehicle *v)

    81

{

    82

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

    83

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

    84

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

    85

}

    86

    87

/**

    88

 *

    89

 * Swap two orders

    90

 *

    91

 */

    92

static void SwapOrders(Order *order1, Order *order2)

    93

{

    94

	Order temp_order;

    95

    96

	temp_order = *order1;

    97

	AssignOrder(order1, *order2);

    98

	order1->next = order2->next;

    99

	AssignOrder(order2, temp_order);

   100

	order2->next = temp_order.next;

   101

}

   102

   103

/**

   104

 *

   105

 * Assign data to an order (from an other order)

   106

 *   This function makes sure that the index is maintained correctly

   107

 *

   108

 */

   109

void AssignOrder(Order *order, Order data)

   110

{

   111

	order->type  = data.type;

   112

	order->flags = data.flags;

   113

	order->dest  = data.dest;

   114

   115

	order->refit_cargo   = data.refit_cargo;

   116

	order->refit_subtype = data.refit_subtype;

   117

   118

	order->wait_time   = data.wait_time;

   119

	order->travel_time = data.travel_time;

   120

}

   121

   122

   123

/**

   124

 * Delete all news items regarding defective orders about a vehicle

   125

 * This could kill still valid warnings (for example about void order when just

   126

 * another order gets added), but assume the player will notice the problems,

   127

 * when (s)he's changing the orders.

   128

 */

   129

static void DeleteOrderWarnings(const Vehicle* v)

   130

{

   131

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_TOO_FEW_ORDERS  + v->type * 4);

   132

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_VOID_ORDER      + v->type * 4);

   133

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_DUPLICATE_ENTRY + v->type * 4);

   134

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_INVALID_ENTRY   + v->type * 4);

   135

}

   136

   137

   138

static TileIndex GetOrderLocation(const Order& o)

   139

{

   140

	switch (o.type) {

   141

		default: NOT_REACHED();

   142

		case OT_GOTO_STATION: return GetStation(o.dest)->xy;

   143

		case OT_GOTO_DEPOT:   return GetDepot(o.dest)->xy;

   144

	}

   145

}

   146

   147

   148

/** Add an order to the orderlist of a vehicle.

   149

 * @param tile unused

   150

 * @param flags operation to perform

   151

 * @param p1 various bitstuffed elements

   152

 * - p1 = (bit  0 - 15) - ID of the vehicle

   153

 * - p1 = (bit 16 - 31) - the selected order (if any). If the last order is given,

   154

 *                        the order will be inserted before that one

   155

 *                        only the first 8 bits used currently (bit 16 - 23) (max 255)

   156

 * @param p2 packed order to insert

   157

 */

   158

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

   159

{

   160

	Vehicle *v;

   161

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

   162

	VehicleOrderID sel_ord = GB(p1, 16, 16);

   163

	Order new_order = UnpackOrder(p2);

   164

   165

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   166

   167

	v = GetVehicle(veh);

   168

   169

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

   170

   171

	/* Check if the inserted order is to the correct destination (owner, type),

   172

	 * and has the correct flags if any */

   173

	switch (new_order.type) {

   174

		case OT_GOTO_STATION: {

   175

			const Station *st;

   176

   177

			if (!IsValidStationID(new_order.dest)) return CMD_ERROR;

   178

			st = GetStation(new_order.dest);

   179

   180

			if (st->owner != OWNER_NONE && !CheckOwnership(st->owner)) {

   181

				return CMD_ERROR;

   182

			}

   183

   184

			switch (v->type) {

   185

				case VEH_TRAIN:

   186

					if (!(st->facilities & FACIL_TRAIN)) return CMD_ERROR;

   187

					break;

   188

   189

				case VEH_ROAD:

   190

					if (IsCargoInClass(v->cargo_type, CC_PASSENGERS)) {

   191

						if (!(st->facilities & FACIL_BUS_STOP)) return CMD_ERROR;

   192

					} else {

   193

						if (!(st->facilities & FACIL_TRUCK_STOP)) return CMD_ERROR;

   194

					}

   195

					break;

   196

   197

				case VEH_SHIP:

   198

					if (!(st->facilities & FACIL_DOCK)) return CMD_ERROR;

   199

					break;

   200

   201

				case VEH_AIRCRAFT:

   202

					if (!(st->facilities & FACIL_AIRPORT) || !CanAircraftUseStation(v->engine_type, st)) {

   203

						return CMD_ERROR;

   204

					}

   205

					break;

   206

   207

				default: return CMD_ERROR;

   208

			}

   209

   210

			/* Order flags can be any of the following for stations:

   211

			 * [full-load | unload] [+ transfer] [+ non-stop]

   212

			 * non-stop orders (if any) are only valid for trains */

   213

			switch (new_order.flags) {

   214

				case 0:

   215

				case OF_FULL_LOAD:

   216

				case OF_FULL_LOAD | OF_TRANSFER:

   217

				case OF_UNLOAD:

   218

				case OF_UNLOAD | OF_TRANSFER:

   219

				case OF_TRANSFER:

   220

					break;

   221

   222

				case OF_NON_STOP:

   223

				case OF_NON_STOP | OF_FULL_LOAD:

   224

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   225

				case OF_NON_STOP | OF_UNLOAD:

   226

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   227

				case OF_NON_STOP | OF_TRANSFER:

   228

					if (v->type != VEH_TRAIN) return CMD_ERROR;

   229

					break;

   230

   231

				default: return CMD_ERROR;

   232

			}

   233

			break;

   234

		}

   235

   236

		case OT_GOTO_DEPOT: {

   237

			if (v->type == VEH_AIRCRAFT) {

   238

				const Station* st;

   239

   240

				if (!IsValidStationID(new_order.dest)) return CMD_ERROR;

   241

				st = GetStation(new_order.dest);

   242

   243

				if (!CheckOwnership(st->owner) ||

   244

						!(st->facilities & FACIL_AIRPORT) ||

   245

						st->Airport()->nof_depots == 0 ||

   246

						!CanAircraftUseStation(v->engine_type, st)) {

   247

					return CMD_ERROR;

   248

				}

   249

			} else {

   250

				const Depot* dp;

   251

   252

				if (!IsValidDepotID(new_order.dest)) return CMD_ERROR;

   253

				dp = GetDepot(new_order.dest);

   254

   255

				if (!CheckOwnership(GetTileOwner(dp->xy))) return CMD_ERROR;

   256

   257

				switch (v->type) {

   258

					case VEH_TRAIN:

   259

						if (!IsTileDepotType(dp->xy, TRANSPORT_RAIL)) return CMD_ERROR;

   260

						break;

   261

   262

					case VEH_ROAD:

   263

						if (!IsTileDepotType(dp->xy, TRANSPORT_ROAD)) return CMD_ERROR;

   264

						break;

   265

   266

					case VEH_SHIP:

   267

						if (!IsTileDepotType(dp->xy, TRANSPORT_WATER)) return CMD_ERROR;

   268

						break;

   269

   270

					default: return CMD_ERROR;

   271

				}

   272

			}

   273

   274

			/* Order flags can be any of the following for depots:

   275

			 * order [+ halt] [+ non-stop]

   276

			 * non-stop orders (if any) are only valid for trains */

   277

			switch (new_order.flags) {

   278

				case OF_PART_OF_ORDERS:

   279

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   280

					break;

   281

   282

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   283

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   284

					if (v->type != VEH_TRAIN) return CMD_ERROR;

   285

					break;

   286

   287

				default: return CMD_ERROR;

   288

			}

   289

			break;

   290

		}

   291

   292

		case OT_GOTO_WAYPOINT: {

   293

			const Waypoint* wp;

   294

   295

			if (v->type != VEH_TRAIN) return CMD_ERROR;

   296

   297

			if (!IsValidWaypointID(new_order.dest)) return CMD_ERROR;

   298

			wp = GetWaypoint(new_order.dest);

   299

   300

			if (!CheckOwnership(GetTileOwner(wp->xy))) return CMD_ERROR;

   301

   302

			/* Order flags can be any of the following for waypoints:

   303

			 * [non-stop]

   304

			 * non-stop orders (if any) are only valid for trains */

   305

			switch (new_order.flags) {

   306

				case 0: break;

   307

   308

				case OF_NON_STOP:

   309

					if (v->type != VEH_TRAIN) return CMD_ERROR;

   310

					break;

   311

   312

				default: return CMD_ERROR;

   313

			}

   314

			break;

   315

		}

   316

   317

		default: return CMD_ERROR;

   318

	}

   319

   320

	if (sel_ord > v->num_orders) return CMD_ERROR;

   321

   322

	if (!HasOrderPoolFree(1)) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   323

   324

	if (v->type == VEH_SHIP &&

   325

			IsHumanPlayer(v->owner) &&

   326

			!_patches.new_pathfinding_all) {

   327

		// Make sure the new destination is not too far away from the previous

   328

		const Order *prev = NULL;

   329

		uint n = 0;

   330

   331

		/* Find the last goto station or depot order before the insert location.

   332

		 * If the order is to be inserted at the beginning of the order list this

   333

		 * finds the last order in the list. */

   334

		for (const Order *o = v->orders; o != NULL; o = o->next) {

   335

			if (o->type == OT_GOTO_STATION || o->type == OT_GOTO_DEPOT) prev = o;

   336

			if (++n == sel_ord && prev != NULL) break;

   337

		}

   338

		if (prev != NULL) {

   339

			uint dist = DistanceManhattan(

   340

				GetOrderLocation(*prev),

   341

				GetOrderLocation(new_order)

   342

			);

   343

			if (dist >= 130) {

   344

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   345

			}

   346

		}

   347

	}

   348

   349

	if (flags & DC_EXEC) {

   350

		Vehicle *u;

   351

		Order *new_o = new Order();

   352

		AssignOrder(new_o, new_order);

   353

   354

		/* Create new order and link in list */

   355

		if (v->orders == NULL) {

   356

			v->orders = new_o;

   357

		} else {

   358

			/* Try to get the previous item (we are inserting above the

   359

			    selected) */

   360

			Order *order = GetVehicleOrder(v, sel_ord - 1);

   361

   362

			if (order == NULL && GetVehicleOrder(v, sel_ord) != NULL) {

   363

				/* There is no previous item, so we are altering v->orders itself

   364

				    But because the orders can be shared, we copy the info over

   365

				    the v->orders, so we don't have to change the pointers of

   366

				    all vehicles */

   367

				SwapOrders(v->orders, new_o);

   368

				/* Now update the next pointers */

   369

				v->orders->next = new_o;

   370

			} else if (order == NULL) {

   371

				/* 'sel' is a non-existing order, add him to the end */

   372

				order = GetLastVehicleOrder(v);

   373

				order->next = new_o;

   374

			} else {

   375

				/* Put the new order in between */

   376

				new_o->next = order->next;

   377

				order->next = new_o;

   378

			}

   379

		}

   380

   381

		u = GetFirstVehicleFromSharedList(v);

   382

		DeleteOrderWarnings(u);

   383

		for (; u != NULL; u = u->next_shared) {

   384

			/* Increase amount of orders */

   385

			u->num_orders++;

   386

   387

			/* If the orderlist was empty, assign it */

   388

			if (u->orders == NULL) u->orders = v->orders;

   389

   390

			assert(v->orders == u->orders);

   391

   392

			/* If there is added an order before the current one, we need

   393

			to update the selected order */

   394

			if (sel_ord <= u->cur_order_index) {

   395

				uint cur = u->cur_order_index + 1;

   396

				/* Check if we don't go out of bound */

   397

				if (cur < u->num_orders)

   398

					u->cur_order_index = cur;

   399

			}

   400

			/* Update any possible open window of the vehicle */

   401

			InvalidateVehicleOrder(u);

   402

		}

   403

   404

		/* Make sure to rebuild the whole list */

   405

		RebuildVehicleLists();

   406

	}

   407

   408

	return CommandCost();

   409

}

   410

   411

/** Declone an order-list

   412

 * @param *dst delete the orders of this vehicle

   413

 * @param flags execution flags

   414

 */

   415

static CommandCost DecloneOrder(Vehicle *dst, uint32 flags)

   416

{

   417

	if (flags & DC_EXEC) {

   418

		DeleteVehicleOrders(dst);

   419

		InvalidateVehicleOrder(dst);

   420

		RebuildVehicleLists();

   421

	}

   422

	return CommandCost();

   423

}

   424

   425

/**

   426

 * Remove the VehicleList that shows all the vehicles with the same shared

   427

 *  orders.

   428

 */

   429

static void RemoveSharedOrderVehicleList(Vehicle *v)

   430

{

   431

	assert(v->orders != NULL);

   432

	WindowClass window_class = WC_NONE;

   433

   434

	switch (v->type) {

   435

		default: NOT_REACHED();

   436

		case VEH_TRAIN:    window_class = WC_TRAINS_LIST;   break;

   437

		case VEH_ROAD:     window_class = WC_ROADVEH_LIST;  break;

   438

		case VEH_SHIP:     window_class = WC_SHIPS_LIST;    break;

   439

		case VEH_AIRCRAFT: window_class = WC_AIRCRAFT_LIST; break;

   440

	}

   441

	DeleteWindowById(window_class, (v->orders->index << 16) | (v->type << 11) | VLW_SHARED_ORDERS | v->owner);

   442

}

   443

   444

/** Delete an order from the orderlist of a vehicle.

   445

 * @param tile unused

   446

 * @param flags operation to perform

   447

 * @param p1 the ID of the vehicle

   448

 * @param p2 the order to delete (max 255)

   449

 */

   450

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

   451

{

   452

	Vehicle *v, *u;

   453

	VehicleID veh_id = p1;

   454

	VehicleOrderID sel_ord = p2;

   455

	Order *order;

   456

   457

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   458

   459

	v = GetVehicle(veh_id);

   460

   461

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

   462

   463

	/* If we did not select an order, we maybe want to de-clone the orders */

   464

	if (sel_ord >= v->num_orders)

   465

		return DecloneOrder(v, flags);

   466

   467

	order = GetVehicleOrder(v, sel_ord);

   468

	if (order == NULL) return CMD_ERROR;

   469

   470

	if (flags & DC_EXEC) {

   471

		if (GetVehicleOrder(v, sel_ord - 1) == NULL) {

   472

			if (GetVehicleOrder(v, sel_ord + 1) != NULL) {

   473

				/* First item, but not the last, so we need to alter v->orders

   474

				    Because we can have shared order, we copy the data

   475

				    from the next item over the deleted */

   476

				order = GetVehicleOrder(v, sel_ord + 1);

   477

				SwapOrders(v->orders, order);

   478

			} else {

   479

				/* XXX -- The system currently can't handle a shared-order vehicle list

   480

				 *  open when there aren't any orders in the list, so close the window

   481

				 *  in this case. Of course it needs a better fix later */

   482

				RemoveSharedOrderVehicleList(v);

   483

				/* Last item, so clean the list */

   484