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

OrderNonStopFlags Order::GetNonStopType() const

    45

{

    46

	return (this->flags & 0x8) ?

    47

			((!_patches.new_nonstop || !this->IsType(OT_GOTO_STATION)) ?

    48

					ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS :

    49

					ONSF_NO_STOP_AT_DESTINATION_STATION) :

    50

			ONSF_STOP_EVERYWHERE;

    51

}

    52

    53

void Order::Free()

    54

{

    55

	this->type  = OT_NOTHING;

    56

	this->flags = 0;

    57

	this->dest  = 0;

    58

	this->next  = NULL;

    59

}

    60

    61

void Order::MakeGoToStation(StationID destination)

    62

{

    63

	this->type = OT_GOTO_STATION;

    64

	this->flags = 0;

    65

	this->dest = destination;

    66

}

    67

    68

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

    69

{

    70

	this->type = OT_GOTO_DEPOT;

    71

	this->flags = 0;

    72

	if (order) {

    73

		this->SetDepotOrderType(OFB_PART_OF_ORDERS);

    74

	} else {

    75

		this->SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

    76

	}

    77

	this->dest = destination;

    78

	this->SetRefit(cargo, subtype);

    79

}

    80

    81

void Order::MakeGoToWaypoint(WaypointID destination)

    82

{

    83

	this->type = OT_GOTO_WAYPOINT;

    84

	this->flags = 0;

    85

	this->dest = destination;

    86

}

    87

    88

void Order::MakeLoading(bool ordered)

    89

{

    90

	this->type = OT_LOADING;

    91

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

    92

}

    93

    94

void Order::MakeLeaveStation()

    95

{

    96

	this->type = OT_LEAVESTATION;

    97

	this->flags = 0;

    98

}

    99

   100

void Order::MakeDummy()

   101

{

   102

	this->type = OT_DUMMY;

   103

	this->flags = 0;

   104

}

   105

   106

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

   107

{

   108

	this->refit_cargo = cargo;

   109

	this->refit_subtype = subtype;

   110

}

   111

   112

void Order::FreeChain()

   113

{

   114

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

   115

	delete this;

   116

}

   117

   118

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

   119

{

   120

	return

   121

			this->type  == other.type &&

   122

			this->flags == other.flags &&

   123

			this->dest  == other.dest;

   124

}

   125

   126

static bool HasOrderPoolFree(uint amount)

   127

{

   128

	const Order *order;

   129

   130

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

   131

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   132

   133

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

   134

   135

	return false;

   136

}

   137

   138

uint32 Order::Pack() const

   139

{

   140

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

   141

}

   142

   143

Order::Order(uint32 packed)

   144

{

   145

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

   146

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

   147

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

   148

	this->next    = NULL;

   149

	this->refit_cargo   = CT_NO_REFIT;

   150

	this->refit_subtype = 0;

   151

	this->wait_time     = 0;

   152

	this->travel_time   = 0;

   153

}

   154

   155

/**

   156

 *

   157

 * Unpacks a order from savegames with version 4 and lower

   158

 *

   159

 */

   160

static Order UnpackVersion4Order(uint16 packed)

   161

{

   162

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

   163

}

   164

   165

/**

   166

 *

   167

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

   168

 *

   169

 */

   170

Order UnpackOldOrder(uint16 packed)

   171

{

   172

	Order order = UnpackVersion4Order(packed);

   173

   174

	/*

   175

	 * Sanity check

   176

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

   177

	 */

   178

	if (!order.IsValid() && (order.GetLoadType() != 0 || order.GetUnloadType() != 0 || order.GetDestination() != 0)) {

   179

		order.MakeDummy();

   180

	}

   181

   182

	return order;

   183

}

   184

   185

/**

   186

 *

   187

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

   188

 *

   189

 */

   190

void InvalidateVehicleOrder(const Vehicle *v)

   191

{

   192

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   193

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   194

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   195

}

   196

   197

/**

   198

 *

   199

 * Swap two orders

   200

 *

   201

 */

   202

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

   203

{

   204

	Order temp_order;

   205

   206

	temp_order = *order1;

   207

	order1->AssignOrder(*order2);

   208

	order1->next = order2->next;

   209

	order2->AssignOrder(temp_order);

   210

	order2->next = temp_order.next;

   211

}

   212

   213

/**

   214

 *

   215

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

   216

 *   This function makes sure that the index is maintained correctly

   217

 *

   218

 */

   219

void Order::AssignOrder(const Order &other)

   220

{

   221

	this->type  = other.type;

   222

	this->flags = other.flags;

   223

	this->dest  = other.dest;

   224

   225

	this->refit_cargo   = other.refit_cargo;

   226

	this->refit_subtype = other.refit_subtype;

   227

   228

	this->wait_time   = other.wait_time;

   229

	this->travel_time = other.travel_time;

   230

}

   231

   232

   233

/**

   234

 * Delete all news items regarding defective orders about a vehicle

   235

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

   236

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

   237

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

   238

 */

   239

static void DeleteOrderWarnings(const Vehicle* v)

   240

{

   241

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

   242

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

   243

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

   244

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

   245

}

   246

   247

   248

static TileIndex GetOrderLocation(const Order& o)

   249

{

   250

	switch (o.GetType()) {

   251

		default: NOT_REACHED();

   252

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

   253

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

   254

	}

   255

}

   256

   257

   258

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

   259

 * @param tile unused

   260

 * @param flags operation to perform

   261

 * @param p1 various bitstuffed elements

   262

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

   263

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

   264

 *                        the order will be inserted before that one

   265

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

   266

 * @param p2 packed order to insert

   267

 */

   268

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

   269

{

   270

	Vehicle *v;

   271

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

   272

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

   273

	Order new_order(p2);

   274

   275

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   276

   277

	v = GetVehicle(veh);

   278

   279

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

   280

   281

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

   282

	 * and has the correct flags if any */

   283

	switch (new_order.GetType()) {

   284

		case OT_GOTO_STATION: {

   285

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

   286

   287

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

   288

   289

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

   290

				return CMD_ERROR;

   291

			}

   292

   293

			switch (v->type) {

   294

				case VEH_TRAIN:

   295

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

   296

					break;

   297

   298

				case VEH_ROAD:

   299

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

   300

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

   301

					} else {

   302

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

   303

					}

   304

					break;

   305

   306

				case VEH_SHIP:

   307

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

   308

					break;

   309

   310

				case VEH_AIRCRAFT:

   311

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

   312

						return CMD_ERROR;

   313

					}

   314

					break;

   315

   316

				default: return CMD_ERROR;

   317

			}

   318

   319

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

   320

   321

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

   322

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

   323

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

   324

			switch (new_order.GetLoadType() | new_order.GetUnloadType()) {

   325

				case 0:

   326

				case OFB_FULL_LOAD:

   327

				case OFB_FULL_LOAD | OFB_TRANSFER:

   328

				case OFB_UNLOAD:

   329

				case OFB_UNLOAD | OFB_TRANSFER:

   330

				case OFB_TRANSFER:

   331

					break;

   332

   333

				default: return CMD_ERROR;

   334

			}

   335

			break;

   336

		}

   337

   338

		case OT_GOTO_DEPOT: {

   339

			if (v->type == VEH_AIRCRAFT) {

   340

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

   341

   342

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

   343

   344

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

   345

						!(st->facilities & FACIL_AIRPORT) ||

   346

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

   347

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

   348

					return CMD_ERROR;

   349

				}

   350

			} else {

   351

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

   352

   353

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

   354

   355

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

   356

   357

				switch (v->type) {

   358

					case VEH_TRAIN:

   359

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

   360

						break;

   361

   362

					case VEH_ROAD:

   363

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

   364

						break;

   365

   366

					case VEH_SHIP:

   367

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

   368

						break;

   369

   370

					default: return CMD_ERROR;

   371

				}

   372

			}

   373

   374

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

   375

   376

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

   377

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

   378

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

   379

			switch (new_order.GetDepotOrderType() | new_order.GetDepotActionType()) {

   380

				case OFB_PART_OF_ORDERS:

   381

				case OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   382

					break;

   383

   384

				default: return CMD_ERROR;

   385

			}

   386

			break;

   387

		}

   388

   389

		case OT_GOTO_WAYPOINT: {

   390

   391

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

   392

   393

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

   394

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

   395

   396

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

   397

   398

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

   399

			 * [non-stop]

   400

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

   401

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

   402

		}

   403

   404

		default: return CMD_ERROR;

   405

	}

   406

   407

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

   408

   409

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

   410

   411

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

   412

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

   413

		const Order *prev = NULL;

   414

		uint n = 0;

   415

   416

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

   417

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

   418

		 * finds the last order in the list. */

   419

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

   420

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

   421

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

   422

		}

   423

		if (prev != NULL) {

   424

			uint dist = DistanceManhattan(

   425

				GetOrderLocation(*prev),

   426

				GetOrderLocation(new_order)

   427

			);

   428

			if (dist >= 130) {

   429

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   430

			}

   431

		}

   432

	}

   433

   434

	if (flags & DC_EXEC) {

   435

		Vehicle *u;

   436

		Order *new_o = new Order();

   437

		new_o->AssignOrder(new_order);

   438

   439

		/* Create new order and link in list */

   440

		if (v->orders == NULL) {

   441

			v->orders = new_o;

   442

		} else {

   443

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

   444

			    selected) */

   445

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

   446

   447

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

   448

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

   449

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

   450

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

   451

				    all vehicles */

   452

				SwapOrders(v->orders, new_o);

   453

				/* Now update the next pointers */

   454

				v->orders->next = new_o;

   455

			} else if (order == NULL) {

   456

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

   457

				order = GetLastVehicleOrder(v);

   458

				order->next = new_o;

   459

			} else {

   460

				/* Put the new order in between */

   461

				new_o->next = order->next;

   462

				order->next = new_o;

   463

			}

   464

		}

   465

   466

		u = GetFirstVehicleFromSharedList(v);

   467

		DeleteOrderWarnings(u);

   468

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

   469

			/* Increase amount of orders */

   470

			u->num_orders++;

   471

   472

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

   473

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

   474

   475

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

   476

   477

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

   478

			to update the selected order */

   479

			if (sel_ord <= u->cur_order_index) {

   480

				uint cur = u->cur_order_index + 1;

   481

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

   482

				if (cur < u->num_orders)

   483

					u->cur_order_index = cur;

   484

			}