1

/* $Id$ */

     2

     3

/** @file order_cmd.cpp Handling of orders. */

     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 "order_base.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

#include "depot_base.h"

    30

    31

#include "table/strings.h"

    32

    33

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

    34

 * be any of them

    35

 */

    36

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

    37

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

    38

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

    39

    40

TileIndex _backup_orders_tile;

    41

BackuppedOrders _backup_orders_data;

    42

    43

DEFINE_OLD_POOL_GENERIC(Order, Order);

    44

    45

void Order::Free()

    46

{

    47

	this->type  = OT_NOTHING;

    48

	this->flags = 0;

    49

	this->dest  = 0;

    50

	this->next  = NULL;

    51

}

    52

    53

void Order::MakeGoToStation(StationID destination)

    54

{

    55

	this->type = OT_GOTO_STATION;

    56

	this->flags = 0;

    57

	this->dest = destination;

    58

}

    59

    60

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

    61

{

    62

	this->type = OT_GOTO_DEPOT;

    63

	this->flags = 0;

    64

	this->SetDepotOrderType(order);

    65

	if (!(order & ODTFB_PART_OF_ORDERS)) {

    66

		this->SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

    67

	}

    68

	this->dest = destination;

    69

	this->SetRefit(cargo, subtype);

    70

}

    71

    72

void Order::MakeGoToWaypoint(WaypointID destination)

    73

{

    74

	this->type = OT_GOTO_WAYPOINT;

    75

	this->flags = 0;

    76

	this->dest = destination;

    77

}

    78

    79

void Order::MakeLoading(bool ordered)

    80

{

    81

	this->type = OT_LOADING;

    82

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

    83

}

    84

    85

void Order::MakeLeaveStation()

    86

{

    87

	this->type = OT_LEAVESTATION;

    88

	this->flags = 0;

    89

}

    90

    91

void Order::MakeDummy()

    92

{

    93

	this->type = OT_DUMMY;

    94

	this->flags = 0;

    95

}

    96

    97

void Order::MakeConditional(VehicleOrderID order)

    98

{

    99

	this->type = OT_CONDITIONAL;

   100

	this->flags = order;

   101

	this->dest = 0;

   102

}

   103

   104

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

   105

{

   106

	this->refit_cargo = cargo;

   107

	this->refit_subtype = subtype;

   108

}

   109

   110

void Order::FreeChain()

   111

{

   112

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

   113

	delete this;

   114

}

   115

   116

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

   117

{

   118

	return

   119

			this->type  == other.type &&

   120

			this->flags == other.flags &&

   121

			this->dest  == other.dest;

   122

}

   123

   124

static bool HasOrderPoolFree(uint amount)

   125

{

   126

	const Order *order;

   127

   128

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

   129

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   130

   131

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

   132

   133

	return false;

   134

}

   135

   136

uint32 Order::Pack() const

   137

{

   138

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

   139

}

   140

   141

Order::Order(uint32 packed)

   142

{

   143

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

   144

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

   145

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

   146

	this->next    = NULL;

   147

	this->refit_cargo   = CT_NO_REFIT;

   148

	this->refit_subtype = 0;

   149

	this->wait_time     = 0;

   150

	this->travel_time   = 0;

   151

}

   152

   153

void Order::ConvertFromOldSavegame()

   154

{

   155

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

   156

	if (_patches.sg_new_nonstop) {

   157

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

   158

	} else {

   159

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

   160

	}

   161

   162

	switch (this->GetType()) {

   163

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

   164

		case OT_GOTO_DEPOT: case OT_GOTO_STATION: case OT_LOADING: break;

   165

		default: return;

   166

	}

   167

   168

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

   169

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

   170

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

   171

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

   172

			this->SetLoadType(OLF_LOAD_IF_POSSIBLE);

   173

		} else {

   174

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

   175

		}

   176

	} else {

   177

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

   178

	}

   179

   180

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

   181

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

   182

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

   183

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

   184

		this->SetUnloadType((OrderUnloadFlags)t);

   185

   186

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

   187

			this->SetUnloadType(OUFB_TRANSFER);

   188

			this->SetLoadType(OLFB_NO_LOAD);

   189

		}

   190

	} else {

   191

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

   192

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

   193

		this->SetDepotOrderType((OrderDepotTypeFlags)t);

   194

	}

   195

}

   196

   197

/**

   198

 *

   199

 * Unpacks a order from savegames with version 4 and lower

   200

 *

   201

 */

   202

static Order UnpackVersion4Order(uint16 packed)

   203

{

   204

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

   205

}

   206

   207

/**

   208

 *

   209

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

   210

 *

   211

 */

   212

Order UnpackOldOrder(uint16 packed)

   213

{

   214

	Order order = UnpackVersion4Order(packed);

   215

   216

	/*

   217

	 * Sanity check

   218

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

   219

	 */

   220

	if (!order.IsValid() && packed != 0) order.MakeDummy();

   221

   222

	return order;

   223

}

   224

   225

/**

   226

 *

   227

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

   228

 *

   229

 */

   230

void InvalidateVehicleOrder(const Vehicle *v)

   231

{

   232

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   233

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   234

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   235

}

   236

   237

/**

   238

 *

   239

 * Swap two orders

   240

 *

   241

 */

   242

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

   243

{

   244

	Order temp_order;

   245

   246

	temp_order = *order1;

   247

	order1->AssignOrder(*order2);

   248

	order1->next = order2->next;

   249

	order2->AssignOrder(temp_order);

   250

	order2->next = temp_order.next;

   251

}

   252

   253

/**

   254

 *

   255

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

   256

 *   This function makes sure that the index is maintained correctly

   257

 *

   258

 */

   259

void Order::AssignOrder(const Order &other)

   260

{

   261

	this->type  = other.type;

   262

	this->flags = other.flags;

   263

	this->dest  = other.dest;

   264

   265

	this->refit_cargo   = other.refit_cargo;

   266

	this->refit_subtype = other.refit_subtype;

   267

   268

	this->wait_time   = other.wait_time;

   269

	this->travel_time = other.travel_time;

   270

}

   271

   272

   273

/**

   274

 * Delete all news items regarding defective orders about a vehicle

   275

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

   276

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

   277

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

   278

 */

   279

static void DeleteOrderWarnings(const Vehicle* v)

   280

{

   281

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

   282

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

   283

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

   284

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

   285

}

   286

   287

   288

static TileIndex GetOrderLocation(const Order& o)

   289

{

   290

	switch (o.GetType()) {

   291

		default: NOT_REACHED();

   292

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

   293

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

   294

	}

   295

}

   296

   297

   298

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

   299

 * @param tile unused

   300

 * @param flags operation to perform

   301

 * @param p1 various bitstuffed elements

   302

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

   303

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

   304

 *                        the order will be inserted before that one

   305

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

   306

 * @param p2 packed order to insert

   307

 */

   308

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

   309

{

   310

	Vehicle *v;

   311

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

   312

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

   313

	Order new_order(p2);

   314

   315

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   316

   317

	v = GetVehicle(veh);

   318

   319

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

   320

   321

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

   322

	 * and has the correct flags if any */

   323

	switch (new_order.GetType()) {

   324

		case OT_GOTO_STATION: {

   325

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

   326

   327

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

   328

   329

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

   330

				return CMD_ERROR;

   331

			}

   332

   333

			switch (v->type) {

   334

				case VEH_TRAIN:

   335

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

   336

					break;

   337

   338

				case VEH_ROAD:

   339

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

   340

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

   341

					} else {

   342

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

   343

					}

   344

					break;

   345

   346

				case VEH_SHIP:

   347

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

   348

					break;

   349

   350

				case VEH_AIRCRAFT:

   351

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

   352

						return CMD_ERROR;

   353

					}

   354

					break;

   355

   356

				default: return CMD_ERROR;

   357

			}

   358

   359

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

   360

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

   361

   362

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

   363

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

   364

   365

			/* Filter invalid load/unload types. */

   366

			switch (new_order.GetLoadType()) {

   367

				case OLF_LOAD_IF_POSSIBLE: case OLFB_FULL_LOAD: case OLF_FULL_LOAD_ANY: case OLFB_NO_LOAD: break;

   368

				default: return CMD_ERROR;

   369

			}

   370

			switch (new_order.GetUnloadType()) {

   371

				case OUF_UNLOAD_IF_POSSIBLE: case OUFB_UNLOAD: case OUFB_TRANSFER: case OUFB_NO_UNLOAD: break;

   372

				default: return CMD_ERROR;

   373

			}

   374

			break;

   375

		}

   376

   377

		case OT_GOTO_DEPOT: {

   378

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

   379

				if (v->type == VEH_AIRCRAFT) {

   380

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

   381

   382

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

   383

   384

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

   385

							!(st->facilities & FACIL_AIRPORT) ||

   386

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

   387

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

   388

						return CMD_ERROR;

   389

					}

   390

				} else {

   391

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

   392

   393

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

   394

   395

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

   396

   397

					switch (v->type) {

   398

						case VEH_TRAIN:

   399

							if (!IsRailDepotTile(dp->xy)) return CMD_ERROR;

   400

							break;

   401

   402

						case VEH_ROAD:

   403

							if (!IsRoadDepotTile(dp->xy)) return CMD_ERROR;

   404

							break;

   405

   406

						case VEH_SHIP:

   407

							if (!IsShipDepotTile(dp->xy)) return CMD_ERROR;

   408

							break;

   409

   410

						default: return CMD_ERROR;

   411

					}

   412

				}

   413

			} else {

   414

				if (!IsPlayerBuildableVehicleType(v)) return CMD_ERROR;

   415

			}

   416

   417

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

   418

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

   419

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

   420

			break;

   421

		}

   422

   423

		case OT_GOTO_WAYPOINT: {

   424

   425

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

   426

   427

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

   428

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

   429

   430

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

   431

   432

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

   433

			 * [non-stop]

   434

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

   435

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

   436

			break;

   437

		}

   438

   439

		case OT_CONDITIONAL: {

   440

			if (!IsPlayerBuildableVehicleType(v)) return CMD_ERROR;

   441

   442

			VehicleOrderID skip_to = new_order.GetConditionSkipToOrder();

   443

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

   444

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

   445

		} break;

   446

   447

		default: return CMD_ERROR;

   448

	}

   449

   450

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

   451

   452

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

   453

   454

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

   455

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

   456

		const Order *prev = NULL;

   457

		uint n = 0;

   458

   459

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

   460

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

   461

		 * finds the last order in the list. */

   462

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

   463

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

   464

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

   465

		}

   466

		if (prev != NULL) {

   467

			uint dist = DistanceManhattan(

   468

				GetOrderLocation(*prev),

   469

				GetOrderLocation(new_order)

   470

			);

   471

			if (dist >= 130) {

   472

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   473

			}

   474

		}

   475

	}

   476

   477

	if (flags & DC_EXEC) {

   478

		Vehicle *u;

   479

		Order *new_o = new Order();

   480

		new_o->AssignOrder(new_order);

   481

   482

		/* Create new order and link in list */

   483

		if (v->orders == NULL) {

   484

			v->orders = new_o;

   485

		} else {