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

#include "oldpool_func.h"

    29

    30

#include "table/strings.h"

    31

    32

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

    33

 * be any of them

    34

 */

    35

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

    36

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

    37

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

    38

    39

TileIndex _backup_orders_tile;

    40

BackuppedOrders _backup_orders_data;

    41

    42

DEFINE_OLD_POOL_GENERIC(Order, Order);

    43

    44

void Order::Free()

    45

{

    46

	this->type  = OT_NOTHING;

    47

	this->flags = 0;

    48

	this->dest  = 0;

    49

	this->next  = NULL;

    50

}

    51

    52

void Order::MakeGoToStation(StationID destination)

    53

{

    54

	this->type = OT_GOTO_STATION;

    55

	this->flags = 0;

    56

	this->dest = destination;

    57

}

    58

    59

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

    60

{

    61

	this->type = OT_GOTO_DEPOT;

    62

	this->flags = 0;

    63

	this->SetDepotOrderType(order);

    64

	if (!(order & ODTFB_PART_OF_ORDERS)) {

    65

		this->SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

    66

	}

    67

	this->dest = destination;

    68

	this->SetRefit(cargo, subtype);

    69

}

    70

    71

void Order::MakeGoToWaypoint(WaypointID destination)

    72

{

    73

	this->type = OT_GOTO_WAYPOINT;

    74

	this->flags = 0;

    75

	this->dest = destination;

    76

}

    77

    78

void Order::MakeLoading(bool ordered)

    79

{

    80

	this->type = OT_LOADING;

    81

	if (!ordered) this->flags = 0;

    82

}

    83

    84

void Order::MakeLeaveStation()

    85

{

    86

	this->type = OT_LEAVESTATION;

    87

	this->flags = 0;

    88

}

    89

    90

void Order::MakeDummy()

    91

{

    92

	this->type = OT_DUMMY;

    93

	this->flags = 0;

    94

}

    95

    96

void Order::MakeConditional(VehicleOrderID order)

    97

{

    98

	this->type = OT_CONDITIONAL;

    99

	this->flags = order;

   100

	this->dest = 0;

   101

}

   102

   103

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

   104

{

   105

	this->refit_cargo = cargo;

   106

	this->refit_subtype = subtype;

   107

}

   108

   109

void Order::FreeChain()

   110

{

   111

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

   112

	delete this;

   113

}

   114

   115

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

   116

{

   117

	return

   118

			this->type  == other.type &&

   119

			this->flags == other.flags &&

   120

			this->dest  == other.dest;

   121

}

   122

   123

static bool HasOrderPoolFree(uint amount)

   124

{

   125

	const Order *order;

   126

   127

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

   128

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   129

   130

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

   131

   132

	return false;

   133

}

   134

   135

uint32 Order::Pack() const

   136

{

   137

	return this->dest << 16 | this->flags << 8 | this->type;

   138

}

   139

   140

Order::Order(uint32 packed)

   141

{

   142

	this->type    = (OrderType)GB(packed,  0,  8);

   143

	this->flags   = GB(packed,  8,  8);

   144

	this->dest    = GB(packed, 16, 16);

   145

	this->next    = NULL;

   146

	this->refit_cargo   = CT_NO_REFIT;

   147

	this->refit_subtype = 0;

   148

	this->wait_time     = 0;

   149

	this->travel_time   = 0;

   150

}

   151

   152

void Order::ConvertFromOldSavegame()

   153

{

   154

	/* First handle non-stop, because those bits are going to be reused. */

   155

	if (_patches.sg_new_nonstop) {

   156

		this->SetNonStopType((this->flags & 0x08) ? ONSF_NO_STOP_AT_ANY_STATION : ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   157

	} else {

   158

		this->SetNonStopType((this->flags & 0x08) ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE);

   159

	}

   160

   161

	switch (this->GetType()) {

   162

		/* Only a few types need the other savegame conversions. */

   163

		case OT_GOTO_DEPOT: case OT_GOTO_STATION: case OT_LOADING: break;

   164

		default: return;

   165

	}

   166

   167

	/* Then the load/depot action flags because those bits are going to be reused too

   168

	 * and they reuse the non-stop bits. */

   169

	if (this->GetType() != OT_GOTO_DEPOT) {

   170

		if ((this->flags & 4) == 0) {

   171

			this->SetLoadType(OLF_LOAD_IF_POSSIBLE);

   172

		} else {

   173

			this->SetLoadType(_patches.sg_full_load_any ? OLF_FULL_LOAD_ANY : OLFB_FULL_LOAD);

   174

		}

   175

	} else {

   176

		this->SetDepotActionType(((this->flags & 6) == 4) ? ODATFB_HALT : ODATF_SERVICE_ONLY);

   177

	}

   178

   179

	/* Finally fix the unload/depot type flags. */

   180

	if (this->GetType() != OT_GOTO_DEPOT) {

   181

		uint t = ((this->flags & 1) == 0) ? OUF_UNLOAD_IF_POSSIBLE : OUFB_TRANSFER;

   182

		if ((this->flags & 2) != 0) t |= OUFB_UNLOAD;

   183

		this->SetUnloadType((OrderUnloadFlags)t);

   184

   185

		if ((this->GetUnloadType() & (OUFB_UNLOAD | OUFB_TRANSFER)) == (OUFB_UNLOAD | OUFB_TRANSFER)) {

   186

			this->SetUnloadType(OUFB_TRANSFER);

   187

			this->SetLoadType(OLFB_NO_LOAD);

   188

		}

   189

	} else {

   190

		uint t = ((this->flags & 6) == 6) ? ODTFB_SERVICE : ODTF_MANUAL;

   191

		if ((this->flags & 2) != 0) t |= ODTFB_PART_OF_ORDERS;

   192

		this->SetDepotOrderType((OrderDepotTypeFlags)t);

   193

	}

   194

}

   195

   196

/**

   197

 *

   198

 * Unpacks a order from savegames with version 4 and lower

   199

 *

   200

 */

   201

static Order UnpackVersion4Order(uint16 packed)

   202

{

   203

	return Order(GB(packed, 8, 8) << 16 | GB(packed, 4, 4) << 8 | GB(packed, 0, 4));

   204

}

   205

   206

/**

   207

 *

   208

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

   209

 *

   210

 */

   211

Order UnpackOldOrder(uint16 packed)

   212

{

   213

	Order order = UnpackVersion4Order(packed);

   214

   215

	/*

   216

	 * Sanity check

   217

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

   218

	 */

   220

   221

	return order;

   222

}

   223

   224

/**

   225

 *

   226

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

   227

 *

   228

 */

   229

void InvalidateVehicleOrder(const Vehicle *v)

   230

{

   231

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   232

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   233

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   234

}

   235

   236

/**

   237

 *

   238

 * Swap two orders

   239

 *

   240

 */

   241

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

   242

{

   243

	Order temp_order;

   244

   245

	temp_order = *order1;

   246

	order1->AssignOrder(*order2);

   247

	order1->next = order2->next;

   248

	order2->AssignOrder(temp_order);

   249

	order2->next = temp_order.next;

   250

}

   251

   252

/**

   253

 *

   254

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

   255

 *   This function makes sure that the index is maintained correctly

   256

 *

   257

 */

   258

void Order::AssignOrder(const Order &other)

   259

{

   260

	this->type  = other.type;

   261

	this->flags = other.flags;

   262

	this->dest  = other.dest;

   263

   264

	this->refit_cargo   = other.refit_cargo;

   265

	this->refit_subtype = other.refit_subtype;

   266

   267

	this->wait_time   = other.wait_time;

   268

	this->travel_time = other.travel_time;

   269

}

   270

   271

   272

/**

   273

 * Delete all news items regarding defective orders about a vehicle

   274

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

   275

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

   276

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

   277

 */

   278

static void DeleteOrderWarnings(const Vehicle* v)

   279

{

   280

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

   281

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

   282

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

   283

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

   284

}

   285

   286

   287

static TileIndex GetOrderLocation(const Order& o)

   288

{

   289

	switch (o.GetType()) {

   290

		default: NOT_REACHED();

   291

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

   292

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

   293

	}

   294

}

   295

   296

   297

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

   298

 * @param tile unused

   299

 * @param flags operation to perform

   300

 * @param p1 various bitstuffed elements

   301

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

   302

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

   303

 *                        the order will be inserted before that one

   304

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

   305

 * @param p2 packed order to insert

   306

 */

   307

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

   308

{

   309

	Vehicle *v;

   310

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

   311

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

   312

	Order new_order(p2);

   313

   314

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   315

   316

	v = GetVehicle(veh);

   317

   318

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

   319

   320

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

   321

	 * and has the correct flags if any */

   322

	switch (new_order.GetType()) {

   323

		case OT_GOTO_STATION: {

   324

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

   325

   326

			const Station *st = GetStation(new_order.GetDestination());

   327

   328

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

   329

				return CMD_ERROR;

   330

			}

   331

   332

			switch (v->type) {

   333

				case VEH_TRAIN:

   334

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

   335

					break;

   336

   337

				case VEH_ROAD:

   338

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

   339

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

   340

					} else {

   341

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

   342

					}

   343

					break;

   344

   345

				case VEH_SHIP:

   346

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

   347

					break;

   348

   349

				case VEH_AIRCRAFT:

   350

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

   351

						return CMD_ERROR;

   352

					}

   353

					break;

   354

   355

				default: return CMD_ERROR;

   356

			}

   357

   358

			/* Non stop not allowed for non-trains. */

   359

			if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN && v->type != VEH_ROAD) return CMD_ERROR;

   360

   361

			/* Full load and unload are mutual exclusive. */

   362

			if ((new_order.GetLoadType() & OLFB_FULL_LOAD) && (new_order.GetUnloadType() & OUFB_UNLOAD)) return CMD_ERROR;

   363

   364

			/* Filter invalid load/unload types. */

   365

			switch (new_order.GetLoadType()) {

   366

				case OLF_LOAD_IF_POSSIBLE: case OLFB_FULL_LOAD: case OLF_FULL_LOAD_ANY: break;

   367

				default: return CMD_ERROR;

   368

			}

   369

			if (new_order.GetUnloadType() & ~(OUFB_UNLOAD | OUFB_TRANSFER)) return CMD_ERROR;

   370

			break;

   371

		}

   372

   373

		case OT_GOTO_DEPOT: {

   374

			if (new_order.GetDepotActionType() != ODATFB_NEAREST_DEPOT) {

   375

				if (v->type == VEH_AIRCRAFT) {

   376

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

   377

   378

					const Station *st = GetStation(new_order.GetDestination());

   379

   380

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

   381

							!(st->facilities & FACIL_AIRPORT) ||

   382

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

   383

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

   384

						return CMD_ERROR;

   385

					}

   386

				} else {

   387

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

   388

   389

					const Depot *dp = GetDepot(new_order.GetDestination());

   390

   391

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

   392

   393

					switch (v->type) {

   394

						case VEH_TRAIN:

   395

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

   396

							break;

   397

   398

						case VEH_ROAD:

   399

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

   400

							break;

   401

   402

						case VEH_SHIP:

   403

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

   404

							break;

   405

   406

						default: return CMD_ERROR;

   407

					}

   408

				}

   409

			} else {

   410

				if (!IsPlayerBuildableVehicleType(v)) return CMD_ERROR;

   411

			}

   412

   413

			if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN && v->type != VEH_ROAD) return CMD_ERROR;

   414

			if (new_order.GetDepotOrderType() & ~ODTFB_PART_OF_ORDERS) return CMD_ERROR;

   415

			if (new_order.GetDepotActionType() & ~ODATFB_NEAREST_DEPOT) return CMD_ERROR;

   416

			break;

   417

		}

   418

   419

		case OT_GOTO_WAYPOINT: {

   420

   421

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

   422

   423

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

   424

			const Waypoint *wp = GetWaypoint(new_order.GetDestination());

   425

   426

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

   427

   428

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

   429

			 * [non-stop]

   430

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

   431

			if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN) return CMD_ERROR;

   432

			break;

   433

		}

   434

   435

		case OT_CONDITIONAL: {

   436

			if (!IsPlayerBuildableVehicleType(v)) return CMD_ERROR;

   437

   438

			VehicleOrderID skip_to = new_order.GetConditionSkipToOrder();

   439

			if (skip_to >= v->num_orders) return CMD_ERROR;

   440

			if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE) return CMD_ERROR;

   441

		} break;

   442

   443

		default: return CMD_ERROR;

   444

	}

   445

   446

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

   447

   448

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

   449

   450

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

   451

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

   452

		const Order *prev = NULL;

   453

		uint n = 0;

   454

   455

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

   456

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

   457

		 * finds the last order in the list. */

   458

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

   459

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

   460

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

   461

		}

   462

		if (prev != NULL) {

   463

			uint dist = DistanceManhattan(

   464

				GetOrderLocation(*prev),

   465

				GetOrderLocation(new_order)

   466

			);

   467

			if (dist >= 130) {

   468

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   469

			}

   470

		}

   471

	}

   472

   473

	if (flags & DC_EXEC) {

   474

		Vehicle *u;

   475

		Order *new_o = new Order();

   476

		new_o->AssignOrder(new_order);

   477

   478

		/* Create new order and link in list */

   479

		if (v->orders == NULL) {

   480

			v->orders = new_o;

   481

		} else {

   482

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

   483

			    selected) */

   484

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

   485

   486

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