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

#include "timetable.h"

    27

#include "vehicle_func.h"

    28

    29

#include "table/strings.h"

    30

    31

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

    32

 * be any of them

    33

 */

    34

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

    35

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

    36

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

    37

    38

TileIndex _backup_orders_tile;

    39

BackuppedOrders _backup_orders_data;

    40

    41

DEFINE_OLD_POOL_GENERIC(Order, Order)

    42

    43

void Order::Free()

    44

{

    45

	this->type  = OT_NOTHING;

    46

	this->flags = 0;

    47

	this->dest  = 0;

    48

	this->next  = NULL;

    49

}

    50

    51

void Order::MakeGoToStation(StationID destination)

    52

{

    53

	this->type = OT_GOTO_STATION;

    54

	this->flags = 0;

    55

	this->dest = destination;

    56

}

    57

    58

void Order::MakeGoToDepot(DepotID destination, bool order, CargoID cargo, byte subtype)

    59

{

    60

	this->type = OT_GOTO_DEPOT;

    61

	this->flags = order ? OFB_PART_OF_ORDERS : OFB_NON_STOP;

    62

	this->dest = destination;

    63

	this->SetRefit(cargo, subtype);

    64

}

    65

    66

void Order::MakeGoToWaypoint(WaypointID destination)

    67

{

    68

	this->type = OT_GOTO_WAYPOINT;

    69

	this->flags = 0;

    70

	this->dest = destination;

    71

}

    72

    73

void Order::MakeLoading()

    74

{

    75

	this->type = OT_LOADING;

    76

}

    77

    78

void Order::MakeLeaveStation()

    79

{

    80

	this->type = OT_LEAVESTATION;

    81

	this->flags = 0;

    82

}

    83

    84

void Order::MakeDummy()

    85

{

    86

	this->type = OT_DUMMY;

    87

	this->flags = 0;

    88

}

    89

    90

void Order::SetRefit(CargoID cargo, byte subtype)

    91

{

    92

	this->refit_cargo = cargo;

    93

	this->refit_subtype = subtype;

    94

}

    95

    96

void Order::FreeChain()

    97

{

    98

	if (next != NULL) next->FreeChain();

    99

	delete this;

   100

}

   101

   102

bool Order::Equals(const Order &other) const

   103

{

   104

	return

   105

			this->type  == other.type &&

   106

			this->flags == other.flags &&

   107

			this->dest  == other.dest;

   108

}

   109

   110

static bool HasOrderPoolFree(uint amount)

   111

{

   112

	const Order *order;

   113

   114

	/* There is always room if not all blocks in the pool are reserved */

   115

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   116

   117

	FOR_ALL_ORDERS(order) if (!order->IsValid() && --amount == 0) return true;

   118

   119

	return false;

   120

}

   121

   123

{

   125

}

   126

   128

{

   148

}

   149

   150

/**

   151

 *

   152

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

   153

 *

   154

 */

   155

Order UnpackOldOrder(uint16 packed)

   156

{

   158

   163

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

   165

	}

   166

   167

	return order;

   168

}

   169

   170

/**

   171

 *

   172

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

   173

 *

   174

 */

   175

void InvalidateVehicleOrder(const Vehicle *v)

   176

{

   177

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   178

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   179

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   180

}

   181

   182

/**

   183

 *

   184

 * Swap two orders

   185

 *

   186

 */

   187

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

   188

{

   189

	Order temp_order;

   190

   191

	temp_order = *order1;

   192

	order1->AssignOrder(*order2);

   193

	order1->next = order2->next;

   194

	order2->AssignOrder(temp_order);

   195

	order2->next = temp_order.next;

   196

}

   197

   198

/**

   199

 *

   200

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

   201

 *   This function makes sure that the index is maintained correctly

   202

 *

   203

 */

   204

void Order::AssignOrder(const Order &other)

   205

{

   206

	this->type  = other.type;

   207

	this->flags = other.flags;

   208

	this->dest  = other.dest;

   209

   210

	this->refit_cargo   = other.refit_cargo;

   211

	this->refit_subtype = other.refit_subtype;

   212

   213

	this->wait_time   = other.wait_time;

   214

	this->travel_time = other.travel_time;

   215

}

   216

   217

   218

/**

   219

 * Delete all news items regarding defective orders about a vehicle

   220

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

   221

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

   222

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

   223

 */

   224

static void DeleteOrderWarnings(const Vehicle* v)

   225

{

   226

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

   227

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

   228

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

   229

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

   230

}

   231

   232

   233

static TileIndex GetOrderLocation(const Order& o)

   234

{

   235

	switch (o.GetType()) {

   236

		default: NOT_REACHED();

   237

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

   238

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

   239

	}

   240

}

   241

   242

   243

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

   244

 * @param tile unused

   245

 * @param flags operation to perform

   246

 * @param p1 various bitstuffed elements

   247

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

   248

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

   249

 *                        the order will be inserted before that one

   250

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

   251

 * @param p2 packed order to insert

   252

 */

   253

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

   254

{

   255

	Vehicle *v;

   256

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

   257

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

   259

   260

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   261

   262

	v = GetVehicle(veh);

   263

   264

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

   265

   266

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

   267

	 * and has the correct flags if any */

   268

	switch (new_order.GetType()) {

   269

		case OT_GOTO_STATION: {

   270

			const Station *st;

   271

   272

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

   273

			st = GetStation(new_order.dest);

   274

   275

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

   276

				return CMD_ERROR;

   277

			}

   278

   279

			switch (v->type) {

   280

				case VEH_TRAIN:

   281

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

   282

					break;

   283

   284

				case VEH_ROAD:

   285

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

   286

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

   287

					} else {

   288

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

   289

					}

   290

					break;

   291

   292

				case VEH_SHIP:

   293

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

   294

					break;

   295

   296

				case VEH_AIRCRAFT:

   297

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

   298

						return CMD_ERROR;

   299

					}

   300

					break;

   301

   302

				default: return CMD_ERROR;

   303

			}

   304

   305

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

   306

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

   307

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

   308

			switch (new_order.flags) {

   309

				case 0:

   310

				case OFB_FULL_LOAD:

   311

				case OFB_FULL_LOAD | OFB_TRANSFER:

   312

				case OFB_UNLOAD:

   313

				case OFB_UNLOAD | OFB_TRANSFER:

   314

				case OFB_TRANSFER:

   315

					break;

   316

   317

				case OFB_NON_STOP:

   318

				case OFB_NON_STOP | OFB_FULL_LOAD:

   319

				case OFB_NON_STOP | OFB_FULL_LOAD | OFB_TRANSFER:

   320

				case OFB_NON_STOP | OFB_UNLOAD:

   321

				case OFB_NON_STOP | OFB_UNLOAD | OFB_TRANSFER:

   322

				case OFB_NON_STOP | OFB_TRANSFER:

   323

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

   324

					break;

   325

   326

				default: return CMD_ERROR;

   327

			}

   328

			break;

   329

		}

   330

   331

		case OT_GOTO_DEPOT: {

   332

			if (v->type == VEH_AIRCRAFT) {

   333

				const Station* st;

   334

   335

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

   336

				st = GetStation(new_order.dest);

   337

   338

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

   339

						!(st->facilities & FACIL_AIRPORT) ||

   340

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

   341

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

   342

					return CMD_ERROR;

   343

				}

   344

			} else {

   345

				const Depot* dp;

   346

   347

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

   348

				dp = GetDepot(new_order.dest);

   349

   350

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

   351

   352

				switch (v->type) {

   353

					case VEH_TRAIN:

   354

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

   355

						break;

   356

   357

					case VEH_ROAD:

   358

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

   359

						break;

   360

   361

					case VEH_SHIP:

   362

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

   363

						break;

   364

   365

					default: return CMD_ERROR;

   366

				}

   367

			}

   368

   369

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

   370

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

   371

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

   372

			switch (new_order.flags) {

   373

				case OFB_PART_OF_ORDERS:

   374

				case OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   375

					break;

   376

   377

				case OFB_NON_STOP | OFB_PART_OF_ORDERS:

   378

				case OFB_NON_STOP | OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   379

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

   380

					break;

   381

   382

				default: return CMD_ERROR;

   383

			}

   384

			break;

   385

		}

   386

   387

		case OT_GOTO_WAYPOINT: {

   388

			const Waypoint* wp;

   389

   390

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

   391

   392

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

   393

			wp = GetWaypoint(new_order.dest);

   394

   395

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

   396

   397

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

   398

			 * [non-stop]

   399

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

   400

			switch (new_order.flags) {

   401

				case 0: break;

   402

   403

				case OFB_NON_STOP:

   404

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

   405

					break;

   406

   407

				default: return CMD_ERROR;

   408

			}

   409

			break;

   410

		}

   411

   412

		default: return CMD_ERROR;

   413

	}

   414

   415

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

   416

   417

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

   418

   419

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

   420

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

   421

		const Order *prev = NULL;

   422

		uint n = 0;

   423

   424

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

   425

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

   426

		 * finds the last order in the list. */

   427

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

   428

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

   429

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

   430

		}

   431

		if (prev != NULL) {

   432

			uint dist = DistanceManhattan(

   433

				GetOrderLocation(*prev),

   434

				GetOrderLocation(new_order)

   435

			);

   436

			if (dist >= 130) {

   437

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   438

			}

   439

		}

   440

	}

   441

   442

	if (flags & DC_EXEC) {

   443

		Vehicle *u;

   444

		Order *new_o = new Order();

   445

		new_o->AssignOrder(new_order);

   446

   447

		/* Create new order and link in list */

   448

		if (v->orders == NULL) {

   449

			v->orders = new_o;

   450

		} else {

   451

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

   452

			    selected) */

   453

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

   454

   455

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

   456

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

   457

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

   458

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

   459

				    all vehicles */

   460

				SwapOrders(v->orders, new_o);

   461

				/* Now update the next pointers */

   462

				v->orders->next = new_o;

   463

			} else if (order == NULL) {

   464

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

   465

				order = GetLastVehicleOrder(v);

   466

				order->next = new_o;

   467

			} else {

   468

				/* Put the new order in between */

   469

				new_o->next = order->next;

   470

				order->next = new_o;

   471

			}

   472

		}

   473

   474

		u = GetFirstVehicleFromSharedList(v);

   475

		DeleteOrderWarnings(u);

   476

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

   477

			/* Increase amount of orders */

   478

			u->num_orders++;

   479

   480

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

   481

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

   482

   483

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

   484