1

/* $Id$ */

     2

     3

/** @file order_gui.cpp GUI related to orders. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "road_map.h"

     8

#include "station_map.h"

     9

#include "gui.h"

    10

#include "window_gui.h"

    11

#include "station_base.h"

    12

#include "town.h"

    13

#include "command_func.h"

    14

#include "viewport_func.h"

    15

#include "gfx_func.h"

    16

#include "depot_base.h"

    17

#include "waypoint.h"

    18

#include "train.h"

    19

#include "water_map.h"

    20

#include "vehicle_gui.h"

    21

#include "timetable.h"

    22

#include "cargotype.h"

    23

#include "strings_func.h"

    24

#include "window_func.h"

    25

#include "vehicle_func.h"

    26

#include "settings_type.h"

    27

#include "player_func.h"

    28

#include "newgrf_cargo.h"

    29

#include "widgets/dropdown_func.h"

    30

#include "textbuf_gui.h"

    31

#include "string_func.h"

    32

#include "depot_base.h"

    33

#include "tilehighlight_func.h"

    34

    35

#include "table/sprites.h"

    36

#include "table/strings.h"

    37

    38

enum OrderWindowWidgets {

    39

	ORDER_WIDGET_CLOSEBOX = 0,

    40

	ORDER_WIDGET_CAPTION,

    41

	ORDER_WIDGET_TIMETABLE_VIEW,

    42

	ORDER_WIDGET_ORDER_LIST,

    43

	ORDER_WIDGET_SCROLLBAR,

    44

	ORDER_WIDGET_SKIP,

    45

	ORDER_WIDGET_DELETE,

    46

	ORDER_WIDGET_NON_STOP_DROPDOWN,

    47

	ORDER_WIDGET_NON_STOP,

    48

	ORDER_WIDGET_GOTO_DROPDOWN,

    49

	ORDER_WIDGET_GOTO,

    50

	ORDER_WIDGET_FULL_LOAD_DROPDOWN,

    51

	ORDER_WIDGET_FULL_LOAD,

    52

	ORDER_WIDGET_UNLOAD_DROPDOWN,

    53

	ORDER_WIDGET_UNLOAD,

    54

	ORDER_WIDGET_REFIT,

    55

	ORDER_WIDGET_SERVICE,

    56

	ORDER_WIDGET_COND_VARIABLE,

    57

	ORDER_WIDGET_COND_COMPARATOR,

    58

	ORDER_WIDGET_COND_VALUE,

    59

	ORDER_WIDGET_RESIZE_BAR,

    60

	ORDER_WIDGET_SHARED_ORDER_LIST,

    61

	ORDER_WIDGET_RESIZE,

    62

};

    63

    64

/** Order load types that could be given to station orders. */

    65

static const StringID _station_load_types[][5] = {

    66

	{

    67

		STR_EMPTY,

    68

		INVALID_STRING_ID,

    69

		STR_ORDER_FULL_LOAD,

    70

		STR_ORDER_FULL_LOAD_ANY,

    71

		STR_ORDER_NO_LOAD,

    72

	}, {

    73

		STR_ORDER_UNLOAD,

    74

		INVALID_STRING_ID,

    75

		STR_ORDER_UNLOAD_FULL_LOAD,

    76

		STR_ORDER_UNLOAD_FULL_LOAD_ANY,

    77

		STR_ORDER_UNLOAD_NO_LOAD,

    78

	}, {

    79

		STR_ORDER_TRANSFER,

    80

		INVALID_STRING_ID,

    81

		STR_ORDER_TRANSFER_FULL_LOAD,

    82

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

    83

		STR_ORDER_TRANSFER_NO_LOAD,

    84

	}, {

    85

		/* Unload and transfer do not work together. */

    86

		INVALID_STRING_ID,

    87

		INVALID_STRING_ID,

    88

		INVALID_STRING_ID,

    89

		INVALID_STRING_ID,

    90

	}, {

    91

		STR_ORDER_NO_UNLOAD,

    92

		INVALID_STRING_ID,

    93

		STR_ORDER_NO_UNLOAD_FULL_LOAD,

    94

		STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,

    95

		INVALID_STRING_ID,

    96

	}

    97

};

    98

    99

static const StringID _order_non_stop_drowdown[] = {

   100

	STR_ORDER_GO_TO,

   101

	STR_ORDER_GO_NON_STOP_TO,

   102

	STR_ORDER_GO_VIA,

   103

	STR_ORDER_GO_NON_STOP_VIA,

   104

	INVALID_STRING_ID

   105

};

   106

   107

static const StringID _order_full_load_drowdown[] = {

   108

	STR_ORDER_DROP_LOAD_IF_POSSIBLE,

   109

	STR_EMPTY,

   110

	STR_ORDER_DROP_FULL_LOAD_ALL,

   111

	STR_ORDER_DROP_FULL_LOAD_ANY,

   112

	STR_ORDER_DROP_NO_LOADING,

   113

	INVALID_STRING_ID

   114

};

   115

   116

static const StringID _order_unload_drowdown[] = {

   117

	STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,

   118

	STR_ORDER_DROP_UNLOAD,

   119

	STR_ORDER_DROP_TRANSFER,

   120

	STR_EMPTY,

   121

	STR_ORDER_DROP_NO_UNLOADING,

   122

	INVALID_STRING_ID

   123

};

   124

   125

static const StringID _order_goto_dropdown[] = {

   126

	STR_ORDER_GO_TO,

   127

	STR_ORDER_GO_TO_NEAREST_DEPOT,

   128

	STR_ORDER_CONDITIONAL,

   129

	INVALID_STRING_ID

   130

};

   131

   132

static const StringID _order_goto_dropdown_aircraft[] = {

   133

	STR_ORDER_GO_TO,

   134

	STR_ORDER_GO_TO_NEAREST_HANGAR,

   135

	STR_ORDER_CONDITIONAL,

   136

	INVALID_STRING_ID

   137

};

   138

   139

static const StringID _order_conditional_variable[] = {

   140

	STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE,

   141

	STR_ORDER_CONDITIONAL_RELIABILITY,

   142

	STR_ORDER_CONDITIONAL_MAX_SPEED,

   143

	STR_ORDER_CONDITIONAL_AGE,

   144

	STR_ORDER_CONDITIONAL_REQUIRES_SERVICE,

   145

	STR_ORDER_CONDITIONAL_UNCONDITIONALLY,

   146

	INVALID_STRING_ID,

   147

};

   148

   149

static const StringID _order_conditional_condition[] = {

   150

	STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS,

   151

	STR_ORDER_CONDITIONAL_COMPARATOR_NOT_EQUALS,

   152

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_THAN,

   153

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_EQUALS,

   154

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_THAN,

   155

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_EQUALS,

   156

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_TRUE,

   157

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_FALSE,

   158

	INVALID_STRING_ID,

   159

};

   160

   161

extern uint ConvertSpeedToDisplaySpeed(uint speed);

   162

extern uint ConvertDisplaySpeedToSpeed(uint speed);

   163

   164

   165

void DrawOrderString(const Vehicle *v, const Order *order, int order_index, int y, bool selected, bool timetable)

   166

{

   167

	StringID str = (v->cur_order_index == order_index) ? STR_8805 : STR_8804;

   168

	SetDParam(6, STR_EMPTY);

   169

   170

	switch (order->GetType()) {

   171

		case OT_DUMMY:

   172

			SetDParam(1, STR_INVALID_ORDER);

   173

			SetDParam(2, order->GetDestination());

   174

			break;

   175

   176

		case OT_GOTO_STATION: {

   177

			OrderLoadFlags load = order->GetLoadType();

   178

			OrderUnloadFlags unload = order->GetUnloadType();

   179

   180

			SetDParam(1, STR_GO_TO_STATION);

   181

			SetDParam(2, STR_ORDER_GO_TO + ((v->type == VEH_TRAIN || v->type == VEH_ROAD) ? order->GetNonStopType() : 0));

   182

			SetDParam(3, order->GetDestination());

   183

   184

			if (timetable) {

   185

				SetDParam(4, STR_EMPTY);

   186

   187

				if (order->wait_time > 0) {

   188

					SetDParam(6, STR_TIMETABLE_STAY_FOR);

   189

					SetTimetableParams(7, 8, order->wait_time);

   190

				}

   191

			} else {

   192

				SetDParam(4, (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) ? STR_EMPTY : _station_load_types[unload][load]);

   193

			}

   194

		} break;

   195

   196

		case OT_GOTO_DEPOT:

   197

			if (v->type == VEH_AIRCRAFT) {

   198

				if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) {

   199

					SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   200

					SetDParam(3, STR_ORDER_NEAREST_HANGAR);

   201

				} else {

   202

					SetDParam(1, STR_GO_TO_HANGAR);

   203

					SetDParam(3, order->GetDestination());

   204

				}

   205

				SetDParam(4, STR_EMPTY);

   206

			} else {

   207

				if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) {

   208

					SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   209

					SetDParam(3, STR_ORDER_NEAREST_DEPOT);

   210

				} else {

   211

					SetDParam(1, STR_GO_TO_DEPOT);

   212

					SetDParam(3, GetDepot(order->GetDestination())->town_index);

   213

				}

   214

   215

				switch (v->type) {

   216

					case VEH_TRAIN: SetDParam(4, STR_ORDER_TRAIN_DEPOT); break;

   217

					case VEH_ROAD:  SetDParam(4, STR_ORDER_ROAD_DEPOT); break;

   218

					case VEH_SHIP:  SetDParam(4, STR_ORDER_SHIP_DEPOT); break;

   219

					default: NOT_REACHED();

   220

				}

   221

			}

   222

   223

			if (order->GetDepotOrderType() & ODTFB_SERVICE) {

   224

				SetDParam(2, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_ORDER_SERVICE_NON_STOP_AT : STR_ORDER_SERVICE_AT);

   225

			} else {

   226

				SetDParam(2, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_ORDER_GO_NON_STOP_TO : STR_ORDER_GO_TO);

   227

			}

   228

   229

			if (!timetable && order->IsRefit()) {

   230

				SetDParam(6, STR_REFIT_ORDER);

   231

				SetDParam(7, GetCargo(order->GetRefitCargo())->name);

   232

			}

   233

			break;

   234

   235

		case OT_GOTO_WAYPOINT:

   236

			SetDParam(1, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_GO_NON_STOP_TO_WAYPOINT : STR_GO_TO_WAYPOINT);

   237

			SetDParam(2, order->GetDestination());

   238

			break;

   239

   240

		case OT_CONDITIONAL:

   241

			SetDParam(2, order->GetConditionSkipToOrder() + 1);

   242

			if (order->GetConditionVariable() == OCV_UNCONDITIONALLY) {

   243

				SetDParam(1, STR_CONDITIONAL_UNCONDITIONAL);

   244

			} else {

   245

				OrderConditionComparator occ = order->GetConditionComparator();

   246

				SetDParam(1, (occ == OCC_IS_TRUE || occ == OCC_IS_FALSE) ? STR_CONDITIONAL_TRUE_FALSE : STR_CONDITIONAL_NUM);

   247

				SetDParam(3, STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + order->GetConditionVariable());

   248

				SetDParam(4, STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS + occ);

   249

   250

				uint value = order->GetConditionValue();

   251

				if (order->GetConditionVariable() == OCV_MAX_SPEED) value = ConvertSpeedToDisplaySpeed(value);

   252

				SetDParam(5, value);

   253

			}

   254

			break;

   255

   256

		default: NOT_REACHED();

   257

	}

   258

   259

	SetDParam(0, order_index + 1);

   260

	DrawString(2, y, str, selected ? TC_WHITE : TC_BLACK);

   261

}

   262

   263

   264

static Order GetOrderCmdFromTile(const Vehicle *v, TileIndex tile)

   265

{

   266

	Order order;

   267

	order.next  = NULL;

   268

	order.index = 0;

   269

   270

	/* check depot first */

   271

	if (_settings_game.order.gotodepot) {

   272

		switch (GetTileType(tile)) {

   273

			case MP_RAILWAY:

   274

				if (v->type == VEH_TRAIN && IsTileOwner(tile, _local_player)) {

   275

					if (IsRailDepot(tile)) {

   276

						order.MakeGoToDepot(GetDepotByTile(tile)->index, ODTFB_PART_OF_ORDERS);

   277

						if (_settings_client.gui.new_nonstop) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   278

						return order;

   279

					}

   280

				}

   281

				break;

   282

   283

			case MP_ROAD:

   284

				if (IsRoadDepot(tile) && v->type == VEH_ROAD && IsTileOwner(tile, _local_player)) {

   285

					order.MakeGoToDepot(GetDepotByTile(tile)->index, ODTFB_PART_OF_ORDERS);

   286

					if (_settings_client.gui.new_nonstop) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   287

					return order;

   288

				}

   289

				break;

   290

   291

			case MP_STATION:

   292

				if (v->type != VEH_AIRCRAFT) break;

   293

				if (IsHangar(tile) && IsTileOwner(tile, _local_player)) {

   294

					order.MakeGoToDepot(GetStationIndex(tile), ODTFB_PART_OF_ORDERS);

   295

					return order;

   296

				}

   297

				break;

   298

   299

			case MP_WATER:

   300

				if (v->type != VEH_SHIP) break;

   301

				if (IsShipDepot(tile) && IsTileOwner(tile, _local_player)) {

   302

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   303

   304

					order.MakeGoToDepot(GetDepotByTile(tile < tile2 ? tile : tile2)->index, ODTFB_PART_OF_ORDERS);

   305

					return order;

   306

				}

   307

   308

			default:

   309

				break;

   310

		}

   311

	}

   312

   313

	/* check waypoint */

   314

	if (IsTileType(tile, MP_RAILWAY) &&

   315

			v->type == VEH_TRAIN &&

   316

			IsTileOwner(tile, _local_player) &&

   317

			IsRailWaypoint(tile)) {

   318

		order.MakeGoToWaypoint(GetWaypointByTile(tile)->index);

   319

		if (_settings_client.gui.new_nonstop) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   320

		return order;

   321

	}

   322

   323

	if (IsTileType(tile, MP_STATION)) {

   324

		StationID st_index = GetStationIndex(tile);

   325

		const Station *st = GetStation(st_index);

   326

   327

		if (st->owner == _current_player || st->owner == OWNER_NONE) {

   328

			byte facil;

   329

			(facil = FACIL_DOCK, v->type == VEH_SHIP) ||

   330

			(facil = FACIL_TRAIN, v->type == VEH_TRAIN) ||

   331

			(facil = FACIL_AIRPORT, v->type == VEH_AIRCRAFT) ||

   332

			(facil = FACIL_BUS_STOP, v->type == VEH_ROAD && IsCargoInClass(v->cargo_type, CC_PASSENGERS)) ||

   333

			(facil = FACIL_TRUCK_STOP, 1);

   334

			if (st->facilities & facil) {

   335

				order.MakeGoToStation(st_index);

   336

				if (_settings_client.gui.new_nonstop && (v->type == VEH_TRAIN || v->type == VEH_ROAD)) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   337

				return order;

   338

			}

   339

		}

   340

	}

   341

   342

	/* not found */

   343

	order.Free();

   344

	return order;

   345

}

   346

   347

struct OrdersWindow : public Window {

   348

private:

   349

	/** Under what reason are we using the PlaceObject functionality? */

   350

	enum OrderPlaceObjectState {

   351

		OPOS_GOTO,

   352

		OPOS_CONDITIONAL,

   353

	};

   354

   355

	int selected_order;

   356

	OrderPlaceObjectState goto_type;

   357

	const Vehicle *vehicle;

   358

   359

	/**

   360

	 * Return the memorised selected order.

   361

	 * @return the memorised order if it is a vaild one

   362

	 *  else return the number of orders

   363

	 */

   364

	int OrderGetSel()

   365

	{

   366

		int num = this->selected_order;

   367

		return (num >= 0 && num < vehicle->num_orders) ? num : vehicle->num_orders;

   368

	}

   369

   370

	/**

   371

	 * Calculate the selected order.

   372

	 * The calculation is based on the relative (to the window) y click position and

   373

	 *  the position of the scrollbar.

   374

	 *

   375

	 * @param y Y-value of the click relative to the window origin

   376

	 * @param v current vehicle

   377

	 * @return the new selected order if the order is valid else return that

   378

	 *  an invalid one has been selected.

   379

	 */

   380

	int GetOrderFromPt(int y)

   381

	{

   382

		/*

   383

		 * Calculation description:

   384

		 * 15 = 14 (w->widget[ORDER_WIDGET_ORDER_LIST].top) + 1 (frame-line)

   385

		 * 10 = order text hight

   386

		 */

   387

		int sel = (y - this->widget[ORDER_WIDGET_ORDER_LIST].top - 1) / 10;

   388

   389

		if ((uint)sel >= this->vscroll.cap) return INVALID_ORDER;

   390

   391

		sel += this->vscroll.pos;

   392

   393

		return (sel <= vehicle->num_orders && sel >= 0) ? sel : INVALID_ORDER;

   394

	}

   395

   396

	bool HandleOrderVehClick(const Vehicle *u)

   397

	{

   398

		if (u->type != this->vehicle->type) return false;

   399

   400

		if (!u->IsPrimaryVehicle()) {

   401

			u = u->First();

   402

			if (!u->IsPrimaryVehicle()) return false;

   403

		}

   404

   405

		/* v is vehicle getting orders. Only copy/clone orders if vehicle doesn't have any orders yet

   406

		 * obviously if you press CTRL on a non-empty orders vehicle you know what you are doing */

   407

		if (this->vehicle->num_orders != 0 && _ctrl_pressed == 0) return false;

   408

   409

		if (DoCommandP(this->vehicle->tile, this->vehicle->index | (u->index << 16), _ctrl_pressed ? CO_SHARE : CO_COPY, NULL,

   410

			_ctrl_pressed ? CMD_CLONE_ORDER | CMD_MSG(STR_CANT_SHARE_ORDER_LIST) : CMD_CLONE_ORDER | CMD_MSG(STR_CANT_COPY_ORDER_LIST))) {

   411

			this->selected_order = -1;

   412

			ResetObjectToPlace();

   413

		}

   414

   415

		return true;

   416

	}

   417

   418

	/**

   419

	 * Handle the click on the goto button.

   420

	 *

   421

	 * @param w current window

   422

	 */

   423

	static void OrderClick_Goto(OrdersWindow *w, int i)

   424

	{

   425

		w->InvalidateWidget(ORDER_WIDGET_GOTO);

   426

		w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   427

		if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   428

			_place_clicked_vehicle = NULL;

   429

			SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   430

			w->goto_type = OPOS_GOTO;

   431

		} else {

   432

			ResetObjectToPlace();

   433

		}

   434

	}

   435

   436

	/**

   437

	 * Handle the click on the full load button.

   438

	 *

   439

	 * @param w current window

   440

	 * @param load_type the way to load.

   441

	 */

   442

	static void OrderClick_FullLoad(OrdersWindow *w, int load_type)

   443

	{

   444

		VehicleOrderID sel_ord = w->OrderGetSel();

   445

		const Order *order = GetVehicleOrder(w->vehicle, sel_ord);

   446

   447

		if (order == NULL || order->GetLoadType() == load_type) return;

   448

   449

		if (load_type < 0) {

   450

			load_type = order->GetLoadType() == OLF_LOAD_IF_POSSIBLE ? OLF_FULL_LOAD_ANY : OLF_LOAD_IF_POSSIBLE;

   451

		}

   452

		DoCommandP(w->vehicle->tile, w->vehicle->index + (sel_ord << 16), MOF_LOAD | (load_type << 4), NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   453

	}

   454

   455

	/**

   456

	 * Handle the click on the service.

   457

	 *

   458

	 * @param w current window

   459

	 */

   460

	static void OrderClick_Service(OrdersWindow *w, int i)

   461

	{

   462

		DoCommandP(w->vehicle->tile, w->vehicle->index + (w->OrderGetSel() << 16), MOF_DEPOT_ACTION, NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   463

	}

   464

   465

	/**

   466

	 * Handle the click on the service in nearest depot button.

   467

	 *

   468

	 * @param w current window

   469

	 */

   470

	static void OrderClick_NearestDepot(OrdersWindow *w, int i)

   471

	{

   472

		Order order;

   473

		order.next = NULL;

   474

		order.index = 0;

   475

		order.MakeGoToDepot(0, ODTFB_PART_OF_ORDERS);

   476

		order.SetDepotActionType(ODATFB_NEAREST_DEPOT);

   477

   478

		DoCommandP(w->vehicle->tile, w->vehicle->index + (w->OrderGetSel() << 16), order.Pack(), NULL, CMD_INSERT_ORDER | CMD_MSG(STR_8833_CAN_T_INSERT_NEW_ORDER));

   479

	}

   480

   481

	/**

   482

	 * Handle the click on the conditional order button.

   483

	 *

   484

	 * @param w current window

   485

	 */

   486

	static void OrderClick_Conditional(OrdersWindow *w, int i)

   487

	{

   488

		w->InvalidateWidget(ORDER_WIDGET_GOTO);

   489

		w->LowerWidget(ORDER_WIDGET_GOTO);

   490