1

/* $Id$ */

     2

     3

/** @file order_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "order_base.h"

     8

#include "order_func.h"

     9

#include "airport.h"

    10

#include "depot.h"

    11

#include "waypoint.h"

    12

#include "command_func.h"

    13

#include "player_func.h"

    14

#include "news_func.h"

    15

#include "saveload.h"

    16

#include "vehicle_gui.h"

    17

#include "cargotype.h"

    18

#include "aircraft.h"

    19

#include "strings_func.h"

    20

#include "core/alloc_func.hpp"

    21

#include "functions.h"

    22

#include "window_func.h"

    23

#include "settings_type.h"

    24

#include "string_func.h"

    25

#include "newgrf_cargo.h"

    26

    27

#include "table/strings.h"

    28

    29

/* DestinationID must be at least as large as every these below, because it can

    30

 * be any of them

    31

 */

    32

assert_compile(sizeof(DestinationID) >= sizeof(DepotID));

    33

assert_compile(sizeof(DestinationID) >= sizeof(WaypointID));

    34

assert_compile(sizeof(DestinationID) >= sizeof(StationID));

    35

    36

TileIndex _backup_orders_tile;

    37

BackuppedOrders _backup_orders_data;

    38

    39

DEFINE_OLD_POOL_GENERIC(Order, Order)

    40

    41

/**

    42

 *

    43

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

    44

 *

    45

 */

    46

Order UnpackOldOrder(uint16 packed)

    47

{

    48

	Order order;

    49

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

    50

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

    51

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

    52

	order.next    = NULL;

    53

    54

	order.refit_cargo   = CT_NO_REFIT;

    55

	order.refit_subtype = 0;

    56

	order.wait_time     = 0;

    57

	order.travel_time   = 0;

    58

	order.index = 0; // avoid compiler warning

    59

    60

	// Sanity check

    61

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

    62

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

    63

		order.type = OT_DUMMY;

    64

		order.flags = 0;

    65

	}

    66

    67

	return order;

    68

}

    69

    70

/**

    71

 *

    72

 * Unpacks a order from savegames with version 4 and lower

    73

 *

    74

 */

    75

static Order UnpackVersion4Order(uint16 packed)

    76

{

    77

	Order order;

    78

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

    79

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

    80

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

    81

	order.next  = NULL;

    82

	order.index = 0; // avoid compiler warning

    83

	order.refit_cargo   = CT_NO_REFIT;

    84

	order.refit_subtype = 0;

    85

	order.wait_time     = 0;

    86

	order.travel_time   = 0;

    87

	return order;

    88

}

    89

    90

/**

    91

 *

    92

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

    93

 *

    94

 */

    95

void InvalidateVehicleOrder(const Vehicle *v)

    96

{

    97

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

    98

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

    99

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   100

}

   101

   102

/**

   103

 *

   104

 * Swap two orders

   105

 *

   106

 */

   107

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

   108

{

   109

	Order temp_order;

   110

   111

	temp_order = *order1;

   112

	AssignOrder(order1, *order2);

   113

	order1->next = order2->next;

   114

	AssignOrder(order2, temp_order);

   115

	order2->next = temp_order.next;

   116

}

   117

   118

/**

   119

 *

   120

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

   121

 *   This function makes sure that the index is maintained correctly

   122

 *

   123

 */

   124

void AssignOrder(Order *order, Order data)

   125

{

   126

	order->type  = data.type;

   127

	order->flags = data.flags;

   128

	order->dest  = data.dest;

   129

   130

	order->refit_cargo   = data.refit_cargo;

   131

	order->refit_subtype = data.refit_subtype;

   132

   133

	order->wait_time   = data.wait_time;

   134

	order->travel_time = data.travel_time;

   135

}

   136

   137

   138

/**

   139

 * Delete all news items regarding defective orders about a vehicle

   140

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

   141

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

   142

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

   143

 */

   144

static void DeleteOrderWarnings(const Vehicle* v)

   145

{

   146

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

   147

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

   148

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

   149

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

   150

}

   151

   152

   153

static TileIndex GetOrderLocation(const Order& o)

   154

{

   155

	switch (o.type) {

   156

		default: NOT_REACHED();

   157

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

   158

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

   159

	}

   160

}

   161

   162

   163

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

   164

 * @param tile unused

   165

 * @param flags operation to perform

   166

 * @param p1 various bitstuffed elements

   167

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

   168

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

   169

 *                        the order will be inserted before that one

   170

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

   171

 * @param p2 packed order to insert

   172

 */

   173

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

   174

{

   175

	Vehicle *v;

   176

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

   177

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

   178

	Order new_order = UnpackOrder(p2);

   179

   180

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   181

   182

	v = GetVehicle(veh);

   183

   184

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

   185

   186

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

   187

	 * and has the correct flags if any */

   188

	switch (new_order.type) {

   189

		case OT_GOTO_STATION: {

   190

			const Station *st;

   191

   192

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

   193

			st = GetStation(new_order.dest);

   194

   195

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

   196

				return CMD_ERROR;

   197

			}

   198

   199

			switch (v->type) {

   200

				case VEH_TRAIN:

   201

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

   202

					break;

   203

   204

				case VEH_ROAD:

   205

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

   206

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

   207

					} else {

   208

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

   209

					}

   210

					break;

   211

   212

				case VEH_SHIP:

   213

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

   214

					break;

   215

   216

				case VEH_AIRCRAFT:

   217

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

   218

						return CMD_ERROR;

   219

					}

   220

					break;

   221

   222

				default: return CMD_ERROR;

   223

			}

   224

   225

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

   226

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

   227

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

   228

			switch (new_order.flags) {

   229

				case 0:

   230

				case OFB_FULL_LOAD:

   231

				case OFB_FULL_LOAD | OFB_TRANSFER:

   232

				case OFB_UNLOAD:

   233

				case OFB_UNLOAD | OFB_TRANSFER:

   234

				case OFB_TRANSFER:

   235

					break;

   236

   237

				case OFB_NON_STOP:

   238

				case OFB_NON_STOP | OFB_FULL_LOAD:

   239

				case OFB_NON_STOP | OFB_FULL_LOAD | OFB_TRANSFER:

   240

				case OFB_NON_STOP | OFB_UNLOAD:

   241

				case OFB_NON_STOP | OFB_UNLOAD | OFB_TRANSFER:

   242

				case OFB_NON_STOP | OFB_TRANSFER:

   243

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

   244

					break;

   245

   246

				default: return CMD_ERROR;

   247

			}

   248

			break;

   249

		}

   250

   251

		case OT_GOTO_DEPOT: {

   252

			if (v->type == VEH_AIRCRAFT) {

   253

				const Station* st;

   254

   255

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

   256

				st = GetStation(new_order.dest);

   257

   258

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

   259

						!(st->facilities & FACIL_AIRPORT) ||

   260

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

   261

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

   262

					return CMD_ERROR;

   263

				}

   264

			} else {

   265

				const Depot* dp;

   266

   267

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

   268

				dp = GetDepot(new_order.dest);

   269

   270

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

   271

   272

				switch (v->type) {

   273

					case VEH_TRAIN:

   274

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

   275

						break;

   276

   277

					case VEH_ROAD:

   278

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

   279

						break;

   280

   281

					case VEH_SHIP:

   282

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

   283

						break;

   284

   285

					default: return CMD_ERROR;

   286

				}

   287

			}

   288

   289

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

   290

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

   291

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

   292

			switch (new_order.flags) {

   293

				case OFB_PART_OF_ORDERS:

   294

				case OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   295

					break;

   296

   297

				case OFB_NON_STOP | OFB_PART_OF_ORDERS:

   298

				case OFB_NON_STOP | OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   299

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

   300

					break;

   301

   302

				default: return CMD_ERROR;

   303

			}

   304

			break;

   305

		}

   306

   307

		case OT_GOTO_WAYPOINT: {

   308

			const Waypoint* wp;

   309

   310

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

   311

   312

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

   313

			wp = GetWaypoint(new_order.dest);

   314

   315

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

   316

   317

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

   318

			 * [non-stop]

   319

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

   320

			switch (new_order.flags) {

   321

				case 0: break;

   322

   323

				case OFB_NON_STOP:

   324

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

   325

					break;

   326

   327

				default: return CMD_ERROR;

   328

			}

   329

			break;

   330

		}

   331

   332

		default: return CMD_ERROR;

   333

	}

   334

   335

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

   336

   337

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

   338

   339

	if (v->type == VEH_SHIP && IsHumanPlayer(v->owner) && _patches.pathfinder_for_ships != VPF_NPF) {

   340

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

   341

		const Order *prev = NULL;

   342

		uint n = 0;

   343

   344

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

   345

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

   346

		 * finds the last order in the list. */

   347

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

   348

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

   349

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

   350

		}

   351

		if (prev != NULL) {

   352

			uint dist = DistanceManhattan(

   353

				GetOrderLocation(*prev),

   354

				GetOrderLocation(new_order)

   355

			);

   356

			if (dist >= 130) {

   357

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   358

			}

   359

		}

   360

	}

   361

   362

	if (flags & DC_EXEC) {

   363

		Vehicle *u;

   364

		Order *new_o = new Order();

   365

		AssignOrder(new_o, new_order);

   366

   367

		/* Create new order and link in list */

   368

		if (v->orders == NULL) {

   369

			v->orders = new_o;

   370

		} else {

   371

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

   372

			    selected) */

   373

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

   374

   375

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

   376

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

   377

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

   378

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

   379

				    all vehicles */

   380

				SwapOrders(v->orders, new_o);

   381

				/* Now update the next pointers */

   382

				v->orders->next = new_o;

   383

			} else if (order == NULL) {

   384

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

   385

				order = GetLastVehicleOrder(v);

   386

				order->next = new_o;

   387

			} else {

   388

				/* Put the new order in between */

   389

				new_o->next = order->next;

   390

				order->next = new_o;

   391

			}

   392

		}

   393

   394

		u = GetFirstVehicleFromSharedList(v);

   395

		DeleteOrderWarnings(u);

   396

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

   397

			/* Increase amount of orders */

   398

			u->num_orders++;

   399

   400

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

   401

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

   402

   403

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

   404

   405

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

   406

			to update the selected order */

   407

			if (sel_ord <= u->cur_order_index) {

   408

				uint cur = u->cur_order_index + 1;

   409

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

   410

				if (cur < u->num_orders)

   411

					u->cur_order_index = cur;

   412

			}

   413

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

   414

			InvalidateVehicleOrder(u);

   415

		}

   416

   417

		/* Make sure to rebuild the whole list */

   418

		RebuildVehicleLists();

   419

	}

   420

   421

	return CommandCost();

   422

}

   423

   424

/** Declone an order-list

   425

 * @param *dst delete the orders of this vehicle

   426

 * @param flags execution flags

   427

 */

   428

static CommandCost DecloneOrder(Vehicle *dst, uint32 flags)

   429

{

   430

	if (flags & DC_EXEC) {

   431

		DeleteVehicleOrders(dst);

   432

		InvalidateVehicleOrder(dst);

   433

		RebuildVehicleLists();

   434

	}

   435

	return CommandCost();

   436

}

   437

   438

/**

   439

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

   440

 *  orders.

   441

 */

   442

static void RemoveSharedOrderVehicleList(Vehicle *v)

   443

{

   444

	assert(v->orders != NULL);

   445

	WindowClass window_class = WC_NONE;

   446

   447

	switch (v->type) {

   448

		default: NOT_REACHED();

   449

		case VEH_TRAIN:    window_class = WC_TRAINS_LIST;   break;

   450

		case VEH_ROAD:     window_class = WC_ROADVEH_LIST;  break;

   451

		case VEH_SHIP:     window_class = WC_SHIPS_LIST;    break;

   452

		case VEH_AIRCRAFT: window_class = WC_AIRCRAFT_LIST; break;

   453

	}

   454

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

   455

}

   456

   457

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

   458

 * @param tile unused

   459

 * @param flags operation to perform

   460

 * @param p1 the ID of the vehicle

   461

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

   462

 */

   463

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

   464

{

   465

	Vehicle *v, *u;

   466

	VehicleID veh_id = p1;

   467

	VehicleOrderID sel_ord = p2;

   468

	Order *order;

   469

   470

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   471

   472

	v = GetVehicle(veh_id);

   473

   474

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

   475

   476

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

   477

	if (sel_ord >= v->num_orders)

   478

		return DecloneOrder(v, flags);

   479

   480

	order = GetVehicleOrder(v, sel_ord);

   481

	if (order == NULL) return CMD_ERROR;

   482

   483

	if (flags & DC_EXEC) {

   484

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