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 "depot.h"

    10

#include "waypoint.h"

    12

#include "station.h"

    14

#include "news.h"

    15

#include "saveload.h"

    16

#include "vehicle_gui.h"

    17

#include "cargotype.h"

    18

#include "aircraft.h"

    30

    31

DEFINE_OLD_POOL_GENERIC(Order, Order)

    32

    33

/**

    34

 *

    35

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

    36

 *

    37

 */

    38

Order UnpackOldOrder(uint16 packed)

    39

{

    40

	Order order;

    41

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

    42

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

    43

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

    44

	order.next    = NULL;

    45

    46

	order.refit_cargo   = CT_NO_REFIT;

    47

	order.refit_subtype = 0;

    48

	order.wait_time     = 0;

    49

	order.travel_time   = 0;

    50

	order.index = 0; // avoid compiler warning

    51

    52

	// Sanity check

    53

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

    54

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

    55

		order.type = OT_DUMMY;

    56

		order.flags = 0;

    57

	}

    58

    59

	return order;

    60

}

    61

    62

/**

    63

 *

    64

 * Unpacks a order from savegames with version 4 and lower

    65

 *

    66

 */

    67

static Order UnpackVersion4Order(uint16 packed)

    68

{

    69

	Order order;

    70

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

    71

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

    72

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

    73

	order.next  = NULL;

    74

	order.index = 0; // avoid compiler warning

    75

	order.refit_cargo   = CT_NO_REFIT;

    76

	order.refit_subtype = 0;

    77

	order.wait_time     = 0;

    78

	order.travel_time   = 0;

    79

	return order;

    80

}

    81

    82

/**

    83

 *

    84

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

    85

 *

    86

 */

    87

void InvalidateVehicleOrder(const Vehicle *v)

    88

{

    89

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

    90

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

    91

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

    92

}

    93

    94

/**

    95

 *

    96

 * Swap two orders

    97

 *

    98

 */

    99

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

   100

{

   101

	Order temp_order;

   102

   103

	temp_order = *order1;

   104

	AssignOrder(order1, *order2);

   105

	order1->next = order2->next;

   106

	AssignOrder(order2, temp_order);

   107

	order2->next = temp_order.next;

   108

}

   109

   110

/**

   111

 *

   112

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

   113

 *   This function makes sure that the index is maintained correctly

   114

 *

   115

 */

   116

void AssignOrder(Order *order, Order data)

   117

{

   118

	order->type  = data.type;

   119

	order->flags = data.flags;

   120

	order->dest  = data.dest;

   121

   122

	order->refit_cargo   = data.refit_cargo;

   123

	order->refit_subtype = data.refit_subtype;

   124

   125

	order->wait_time   = data.wait_time;

   126

	order->travel_time = data.travel_time;

   127

}

   128

   129

   130

/**

   131

 * Delete all news items regarding defective orders about a vehicle

   132

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

   133

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

   134

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

   135

 */

   136

static void DeleteOrderWarnings(const Vehicle* v)

   137

{

   138

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

   139

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

   140

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

   141

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

   142

}

   143

   144

   145

static TileIndex GetOrderLocation(const Order& o)

   146

{

   147

	switch (o.type) {

   148

		default: NOT_REACHED();

   149

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

   150

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

   151

	}

   152

}

   153

   154

   155

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

   156

 * @param tile unused

   157

 * @param flags operation to perform

   158

 * @param p1 various bitstuffed elements

   159

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

   160

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

   161

 *                        the order will be inserted before that one

   162

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

   163

 * @param p2 packed order to insert

   164

 */

   165

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

   166

{

   167

	Vehicle *v;

   168

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

   169

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

   170

	Order new_order = UnpackOrder(p2);

   171

   172

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   173

   174

	v = GetVehicle(veh);

   175

   176

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

   177

   178

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

   179

	 * and has the correct flags if any */

   180

	switch (new_order.type) {

   181

		case OT_GOTO_STATION: {

   182

			const Station *st;

   183

   184

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

   185

			st = GetStation(new_order.dest);

   186

   187

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

   188

				return CMD_ERROR;

   189

			}

   190

   191

			switch (v->type) {

   192

				case VEH_TRAIN:

   193

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

   194

					break;

   195

   196

				case VEH_ROAD:

   197

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

   198

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

   199

					} else {

   200

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

   201

					}

   202

					break;

   203

   204

				case VEH_SHIP:

   205

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

   206

					break;

   207

   208

				case VEH_AIRCRAFT:

   209

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

   210

						return CMD_ERROR;

   211

					}

   212

					break;

   213

   214

				default: return CMD_ERROR;

   215

			}

   216

   217

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

   218

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

   219

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

   220

			switch (new_order.flags) {

   221

				case 0:

   227

					break;

   228

   235

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

   236

					break;

   237

   238

				default: return CMD_ERROR;

   239

			}

   240

			break;

   241

		}

   242

   243

		case OT_GOTO_DEPOT: {

   244

			if (v->type == VEH_AIRCRAFT) {

   245

				const Station* st;

   246

   247

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

   248

				st = GetStation(new_order.dest);

   249

   250

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

   251

						!(st->facilities & FACIL_AIRPORT) ||

   252

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

   253

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

   254

					return CMD_ERROR;

   255

				}

   256

			} else {

   257

				const Depot* dp;

   258

   259

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

   260

				dp = GetDepot(new_order.dest);

   261

   262

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

   263

   264

				switch (v->type) {

   265

					case VEH_TRAIN:

   266

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

   267

						break;

   268

   269

					case VEH_ROAD:

   270

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

   271

						break;

   272

   273

					case VEH_SHIP:

   274

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

   275

						break;

   276

   277

					default: return CMD_ERROR;

   278

				}

   279

			}

   280

   281

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

   282

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

   283

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

   284

			switch (new_order.flags) {

   287

					break;

   288

   291

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

   292

					break;

   293

   294

				default: return CMD_ERROR;

   295

			}

   296

			break;

   297

		}

   298

   299

		case OT_GOTO_WAYPOINT: {

   300

			const Waypoint* wp;

   301

   302

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

   303

   304

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

   305

			wp = GetWaypoint(new_order.dest);

   306

   307

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

   308

   309

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

   310

			 * [non-stop]

   311

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

   312

			switch (new_order.flags) {

   313

				case 0: break;

   314

   316

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

   317

					break;

   318

   319

				default: return CMD_ERROR;

   320

			}

   321

			break;

   322

		}

   323

   324

		default: return CMD_ERROR;

   325

	}

   326

   327

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

   328

   329

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

   330

   331

	if (v->type == VEH_SHIP &&

   332

			IsHumanPlayer(v->owner) &&

   333

			!_patches.new_pathfinding_all) {

   334

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

   335

		const Order *prev = NULL;

   336

		uint n = 0;

   337

   338

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

   339

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

   340

		 * finds the last order in the list. */

   341

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

   342

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

   343

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

   344

		}

   345

		if (prev != NULL) {

   346

			uint dist = DistanceManhattan(

   347

				GetOrderLocation(*prev),

   348

				GetOrderLocation(new_order)

   349

			);

   350

			if (dist >= 130) {

   351

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   352

			}

   353

		}

   354

	}

   355

   356

	if (flags & DC_EXEC) {

   357

		Vehicle *u;

   358

		Order *new_o = new Order();

   359

		AssignOrder(new_o, new_order);

   360

   361

		/* Create new order and link in list */

   362

		if (v->orders == NULL) {

   363

			v->orders = new_o;

   364

		} else {

   365

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

   366

			    selected) */

   367

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

   368

   369

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

   370

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

   371

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

   372

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

   373

				    all vehicles */

   374

				SwapOrders(v->orders, new_o);

   375

				/* Now update the next pointers */

   376

				v->orders->next = new_o;

   377

			} else if (order == NULL) {

   378

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

   379

				order = GetLastVehicleOrder(v);

   380

				order->next = new_o;

   381

			} else {

   382

				/* Put the new order in between */

   383

				new_o->next = order->next;

   384

				order->next = new_o;

   385

			}

   386

		}

   387

   388

		u = GetFirstVehicleFromSharedList(v);

   389

		DeleteOrderWarnings(u);

   390

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

   391

			/* Increase amount of orders */

   392

			u->num_orders++;

   393

   394

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

   395

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

   396

   397

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

   398

   399

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

   400

			to update the selected order */

   401

			if (sel_ord <= u->cur_order_index) {

   402

				uint cur = u->cur_order_index + 1;

   403

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

   404

				if (cur < u->num_orders)

   405

					u->cur_order_index = cur;

   406

			}

   407

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

   408

			InvalidateVehicleOrder(u);

   409

		}

   410

   411

		/* Make sure to rebuild the whole list */

   412

		RebuildVehicleLists();

   413

	}

   414

   415

	return CommandCost();

   416

}

   417

   418

/** Declone an order-list

   419

 * @param *dst delete the orders of this vehicle

   420

 * @param flags execution flags

   421

 */

   422

static CommandCost DecloneOrder(Vehicle *dst, uint32 flags)

   423

{

   424

	if (flags & DC_EXEC) {

   425

		DeleteVehicleOrders(dst);

   426

		InvalidateVehicleOrder(dst);

   427

		RebuildVehicleLists();

   428

	}

   429

	return CommandCost();

   430

}

   431

   432

/**

   433

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

   434

 *  orders.

   435

 */

   436

static void RemoveSharedOrderVehicleList(Vehicle *v)

   437

{

   438

	assert(v->orders != NULL);

   439

	WindowClass window_class = WC_NONE;

   440

   441

	switch (v->type) {

   442

		default: NOT_REACHED();

   443

		case VEH_TRAIN:    window_class = WC_TRAINS_LIST;   break;

   444

		case VEH_ROAD:     window_class = WC_ROADVEH_LIST;  break;

   445

		case VEH_SHIP:     window_class = WC_SHIPS_LIST;    break;

   446

		case VEH_AIRCRAFT: window_class = WC_AIRCRAFT_LIST; break;

   447

	}

   448

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

   449

}

   450

   451

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

   452

 * @param tile unused

   453

 * @param flags operation to perform

   454

 * @param p1 the ID of the vehicle

   455

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

   456

 */

   457

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

   458

{

   459

	Vehicle *v, *u;

   460

	VehicleID veh_id = p1;

   461

	VehicleOrderID sel_ord = p2;

   462

	Order *order;

   463

   464

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   465

   466

	v = GetVehicle(veh_id);

   467

   468

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

   469

   470

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

   471

	if (sel_ord >= v->num_orders)

   472

		return DecloneOrder(v, flags);

   473

   474

	order = GetVehicleOrder(v, sel_ord);

   475

	if (order == NULL) return CMD_ERROR;

   476

   477

	if (flags & DC_EXEC) {

   478

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

   479

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

   480

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

   481

				    Because we can have shared order, we copy the data

   482

				    from the next item over the deleted */

   483

				order = GetVehicleOrder(v, sel_ord + 1);

   484

				SwapOrders(v->orders, order);