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"

    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,

    47

	ORDER_WIDGET_GOTO,

    48

	ORDER_WIDGET_GOTO_DROPDOWN,

    49

	ORDER_WIDGET_FULL_LOAD,

    50

	ORDER_WIDGET_UNLOAD,

    51

	ORDER_WIDGET_REFIT,

    52

	ORDER_WIDGET_SERVICE,

    53

	ORDER_WIDGET_COND_VARIABLE,

    54

	ORDER_WIDGET_COND_COMPARATOR,

    55

	ORDER_WIDGET_COND_VALUE,

    56

	ORDER_WIDGET_RESIZE_BAR,

    57

	ORDER_WIDGET_SHARED_ORDER_LIST,

    58

	ORDER_WIDGET_RESIZE,

    59

};

    60

    61

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

    62

enum OrderPlaceObjectState {

    63

	OPOS_GOTO,

    64

	OPOS_CONDITIONAL,

    65

};

    66

    67

struct order_d {

    68

	int sel;

    69

	OrderPlaceObjectState goto_type;

    70

};

    71

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(order_d));

    72

    73

/**

    74

 * Return the memorised selected order.

    75

 *

    76

 * @param w current window

    77

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

    78

 *  else return the number of orders

    79

 */

    80

static int OrderGetSel(const Window *w)

    81

{

    82

	const Vehicle *v = GetVehicle(w->window_number);

    83

	int num = WP(w, order_d).sel;

    84

    85

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

    86

}

    87

    88

/**

    89

 * Calculate the selected order.

    90

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

    91

 *  the position of the scrollbar.

    92

 *

    93

 * @param w current window

    94

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

    95

 * @param v current vehicle

    96

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

    97

 *  an invalid one has been selected.

    98

 */

    99

static int GetOrderFromOrderWndPt(Window *w, int y, const Vehicle *v)

   100

{

   101

	/*

   102

	 * Calculation description:

   103

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

   104

	 * 10 = order text hight

   105

	 */

   106

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

   107

   108

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

   109

   110

	sel += w->vscroll.pos;

   111

   112

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

   113

}

   114

   115

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

   116

static const StringID _station_load_types[][5] = {

   117

	{

   118

		STR_EMPTY,

   119

		INVALID_STRING_ID,

   120

		STR_ORDER_FULL_LOAD,

   121

		STR_ORDER_FULL_LOAD_ANY,

   122

		STR_ORDER_NO_LOAD,

   123

	}, {

   124

		STR_ORDER_UNLOAD,

   125

		INVALID_STRING_ID,

   126

		STR_ORDER_UNLOAD_FULL_LOAD,

   127

		STR_ORDER_UNLOAD_FULL_LOAD_ANY,

   128

		STR_ORDER_UNLOAD_NO_LOAD,

   129

	}, {

   130

		STR_ORDER_TRANSFER,

   131

		INVALID_STRING_ID,

   132

		STR_ORDER_TRANSFER_FULL_LOAD,

   133

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

   134

		STR_ORDER_TRANSFER_NO_LOAD,

   135

	}, {

   136

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

   137

		INVALID_STRING_ID,

   138

		INVALID_STRING_ID,

   139

		INVALID_STRING_ID,

   140

		INVALID_STRING_ID,

   141

	}, {

   142

		STR_ORDER_NO_UNLOAD,

   143

		INVALID_STRING_ID,

   144

		STR_ORDER_NO_UNLOAD_FULL_LOAD,

   145

		STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,

   146

		INVALID_STRING_ID,

   147

	}

   148

};

   149

   150

static const StringID _order_non_stop_drowdown[] = {

   151

	STR_ORDER_GO_TO,

   152

	STR_ORDER_GO_NON_STOP_TO,

   153

	STR_ORDER_GO_VIA,

   154

	STR_ORDER_GO_NON_STOP_VIA,

   155

	INVALID_STRING_ID

   156

};

   157

   158

static const StringID _order_full_load_drowdown[] = {

   159

	STR_ORDER_DROP_LOAD_IF_POSSIBLE,

   160

	STR_EMPTY,

   161

	STR_ORDER_DROP_FULL_LOAD_ALL,

   162

	STR_ORDER_DROP_FULL_LOAD_ANY,

   163

	STR_ORDER_DROP_NO_LOADING,

   164

	INVALID_STRING_ID

   165

};

   166

   167

static const StringID _order_unload_drowdown[] = {

   168

	STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,

   169

	STR_ORDER_DROP_UNLOAD,

   170

	STR_ORDER_DROP_TRANSFER,

   171

	STR_EMPTY,

   172

	STR_ORDER_DROP_NO_UNLOADING,

   173

	INVALID_STRING_ID

   174

};

   175

   176

static const StringID _order_goto_dropdown[] = {

   177

	STR_ORDER_GO_TO,

   178

	STR_ORDER_GO_TO_NEAREST_DEPOT,

   179

	STR_ORDER_CONDITIONAL,

   180

	INVALID_STRING_ID

   181

};

   182

   183

static const StringID _order_goto_dropdown_aircraft[] = {

   184

	STR_ORDER_GO_TO,

   185

	STR_ORDER_GO_TO_NEAREST_HANGAR,

   186

	STR_ORDER_CONDITIONAL,

   187

	INVALID_STRING_ID

   188

};

   189

   190

static const StringID _order_conditional_variable[] = {

   191

	STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE,

   192

	STR_ORDER_CONDITIONAL_RELIABILITY,

   193

	STR_ORDER_CONDITIONAL_MAX_SPEED,

   194

	STR_ORDER_CONDITIONAL_AGE,

   195

	STR_ORDER_CONDITIONAL_REQUIRES_SERVICE,

   196

	STR_ORDER_CONDITIONAL_UNCONDITIONALLY,

   197

	INVALID_STRING_ID,

   198

};

   199

   200

static const StringID _order_conditional_condition[] = {

   201

	STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS,

   202

	STR_ORDER_CONDITIONAL_COMPARATOR_NOT_EQUALS,

   203

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_THAN,

   204

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_EQUALS,

   205

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_THAN,

   206

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_EQUALS,

   207

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_TRUE,

   208

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_FALSE,

   209

	INVALID_STRING_ID,

   210

};

   211

   212

extern uint ConvertSpeedToDisplaySpeed(uint speed);

   213

extern uint ConvertDisplaySpeedToSpeed(uint speed);

   214

   215

   216

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

   217

{

   218

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

   219

	SetDParam(6, STR_EMPTY);

   220

   221

	switch (order->GetType()) {

   222

		case OT_DUMMY:

   223

			SetDParam(1, STR_INVALID_ORDER);

   224

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

   225

			break;

   226

   227

		case OT_GOTO_STATION: {

   228

			OrderLoadFlags load = order->GetLoadType();

   229

			OrderUnloadFlags unload = order->GetUnloadType();

   230

   231

			SetDParam(1, STR_GO_TO_STATION);

   232

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

   233

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

   234

   235

			if (timetable) {

   236

				SetDParam(4, STR_EMPTY);

   237

   238

				if (order->wait_time > 0) {

   239

					SetDParam(6, STR_TIMETABLE_STAY_FOR);

   240

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

   241

				}

   242

			} else {

   243

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

   244

			}

   245

		} break;

   246

   247

		case OT_GOTO_DEPOT:

   248

			if (v->type == VEH_AIRCRAFT) {

   249

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

   250

					SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   251

					SetDParam(3, STR_ORDER_NEAREST_HANGAR);

   252

				} else {

   253

					SetDParam(1, STR_GO_TO_HANGAR);

   254

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

   255

				}

   256

				SetDParam(4, STR_EMPTY);

   257

			} else {

   258

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

   259

					SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   260

					SetDParam(3, STR_ORDER_NEAREST_DEPOT);

   261

				} else {

   262

					SetDParam(1, STR_GO_TO_DEPOT);

   263

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

   264

				}

   265

   266

				switch (v->type) {

   267

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

   268

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

   269

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

   270

					default: NOT_REACHED();

   271

				}

   272

			}

   273

   274

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

   275

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

   276

			} else {

   277

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

   278

			}

   279

   280

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

   281

				SetDParam(6, STR_REFIT_ORDER);

   282

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

   283

			}

   284

			break;

   285

   286

		case OT_GOTO_WAYPOINT:

   287

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

   288

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

   289

			break;

   290

   291

		case OT_CONDITIONAL:

   292

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

   293

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

   294

				SetDParam(1, STR_CONDITIONAL_UNCONDITIONAL);

   295

			} else {

   296

				OrderConditionComparator occ = order->GetConditionComparator();

   297

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

   298

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

   299

				SetDParam(4, STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS + occ);

   300

   301

				uint value = order->GetConditionValue();

   302

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

   303

				SetDParam(5, value);

   304

			}

   305

			break;

   306

   307

		default: NOT_REACHED();

   308

	}

   309

   310

	SetDParam(0, order_index + 1);

   311

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

   312

}

   313

   314

   315

static void DrawOrdersWindow(Window *w)

   316

{

   317

	const Vehicle *v = GetVehicle(w->window_number);

   318

	bool shared_orders = v->IsOrderListShared();

   319

   320

	SetVScrollCount(w, v->num_orders + 1);

   321

   322

	int sel = OrderGetSel(w);

   323

	const Order *order = GetVehicleOrder(v, sel);

   324

   325

	if (v->owner == _local_player) {

   326

		/* Set the strings for the dropdown boxes. */

   327

		w->widget[ORDER_WIDGET_NON_STOP].data        = _order_non_stop_drowdown[order == NULL ? 0 : order->GetNonStopType()];

   328

		w->widget[ORDER_WIDGET_FULL_LOAD].data       = _order_full_load_drowdown[order == NULL ? 0 : order->GetLoadType()];

   329

		w->widget[ORDER_WIDGET_UNLOAD].data          = _order_unload_drowdown[order == NULL ? 0 : order->GetUnloadType()];

   330

		w->widget[ORDER_WIDGET_COND_VARIABLE].data   = _order_conditional_variable[order == NULL ? 0 : order->GetConditionVariable()];

   331

		w->widget[ORDER_WIDGET_COND_COMPARATOR].data = _order_conditional_condition[order == NULL ? 0 : order->GetConditionComparator()];

   332

   333

		/* skip */

   334

		w->SetWidgetDisabledState(ORDER_WIDGET_SKIP, v->num_orders <= 1);

   335

   336

		/* delete */

   337

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   338

				(uint)v->num_orders + ((shared_orders || v->num_orders != 0) ? 1 : 0) <= (uint)WP(w, order_d).sel);

   339

   340

		/* non-stop only for trains */

   341

		w->SetWidgetDisabledState(ORDER_WIDGET_NON_STOP,  (v->type != VEH_TRAIN && v->type != VEH_ROAD) || order == NULL);

   342

		w->SetWidgetDisabledState(ORDER_WIDGET_FULL_LOAD, order == NULL || (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) != 0); // full load

   343

		w->SetWidgetDisabledState(ORDER_WIDGET_UNLOAD,    order == NULL || (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) != 0); // unload

   344

		/* Disable list of vehicles with the same shared orders if there is no list */

   345

		w->SetWidgetDisabledState(ORDER_WIDGET_SHARED_ORDER_LIST, !shared_orders || v->orders == NULL);

   346

		w->SetWidgetDisabledState(ORDER_WIDGET_REFIT,     order == NULL); // Refit

   347

		w->SetWidgetDisabledState(ORDER_WIDGET_SERVICE,   order == NULL); // Refit

   348

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   349

		w->HideWidget(ORDER_WIDGET_SERVICE); // Service

   350

   351

		w->HideWidget(ORDER_WIDGET_COND_VARIABLE);

   352

		w->HideWidget(ORDER_WIDGET_COND_COMPARATOR);

   353

		w->HideWidget(ORDER_WIDGET_COND_VALUE);

   354

	}

   355

   356

	w->ShowWidget(ORDER_WIDGET_NON_STOP);

   357

	w->ShowWidget(ORDER_WIDGET_UNLOAD);

   358

	w->ShowWidget(ORDER_WIDGET_FULL_LOAD);

   359

   360

	if (order != NULL) {

   361

		switch (order->GetType()) {

   362

			case OT_GOTO_STATION:

   363

				if (!GetStation(order->GetDestination())->IsBuoy()) break;

   364

				/* Fall-through */

   365

   366

			case OT_GOTO_WAYPOINT:

   367

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   368

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   369

				break;

   370

   371

			case OT_GOTO_DEPOT:

   372

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   373

   374

				/* Remove unload and replace it with refit */

   375

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   376

				w->ShowWidget(ORDER_WIDGET_REFIT);

   377

				w->HideWidget(ORDER_WIDGET_FULL_LOAD);

   378

				w->ShowWidget(ORDER_WIDGET_SERVICE);

   379

				break;

   380

   381

			case OT_CONDITIONAL: {

   382

				w->HideWidget(ORDER_WIDGET_NON_STOP);

   383

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   384

				w->HideWidget(ORDER_WIDGET_FULL_LOAD);

   385

				w->ShowWidget(ORDER_WIDGET_COND_VARIABLE);

   386

				w->ShowWidget(ORDER_WIDGET_COND_COMPARATOR);

   387

				w->ShowWidget(ORDER_WIDGET_COND_VALUE);

   388

   389

				OrderConditionVariable ocv = order->GetConditionVariable();

   390

				w->SetWidgetDisabledState(ORDER_WIDGET_COND_COMPARATOR, ocv == OCV_UNCONDITIONALLY);

   391

				w->SetWidgetDisabledState(ORDER_WIDGET_COND_VALUE, ocv == OCV_REQUIRES_SERVICE || ocv == OCV_UNCONDITIONALLY);

   392

   393

				uint value = order->GetConditionValue();

   394

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

   395

				SetDParam(1, value);

   396

			} break;

   397

   398

			default: // every other orders

   399

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   400

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   401

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   402

		}

   403

	}

   404

   405

	SetDParam(0, v->index);

   406

	DrawWindowWidgets(w);

   407

   408

	int y = 15;

   409

   410

	int i = w->vscroll.pos;

   411

	order = GetVehicleOrder(v, i);

   412

	StringID str;

   413

	while (order != NULL) {

   414

		/* Don't draw anything if it extends past the end of the window. */

   415

		if (i - w->vscroll.pos >= w->vscroll.cap) break;

   416

   417

		DrawOrderString(v, order, i, y, i == WP(w, order_d).sel, false);

   418

		y += 10;

   419

   420

		i++;

   421

		order = order->next;

   422

	}

   423

   424

	if (i - w->vscroll.pos < w->vscroll.cap) {

   425

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   426

		DrawString(2, y, str, (i == WP(w, order_d).sel) ? TC_WHITE : TC_BLACK);

   427

	}

   428

}

   429

   430

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

   431

{

   432

	Order order;

   433

	order.next  = NULL;

   434

	order.index = 0;

   435

   436

	/* check depot first */

   437

	if (_patches.gotodepot) {

   438

		switch (GetTileType(tile)) {

   439

			case MP_RAILWAY:

   440

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

   441

					if (IsRailDepot(tile)) {

   442

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

   443

						if (_patches.new_nonstop) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   444

						return order;

   445

					}

   446

				}

   447

				break;

   448

   449

			case MP_ROAD:

   450

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

   451

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

   452

					if (_patches.new_nonstop) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   453

					return order;

   454

				}

   455

				break;

   456

   457

			case MP_STATION:

   458

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

   459

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

   460

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

   461

					return order;

   462

				}

   463

				break;

   464

   465

			case MP_WATER:

   466

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

   467

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

   468

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   469

   470

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

   471

					return order;

   472

				}

   473

   474

			default:

   475

				break;

   476

		}

   477

	}

   478

   479

	/* check waypoint */

   480

	if (IsTileType(tile, MP_RAILWAY) &&

   481

			v->type == VEH_TRAIN &&

   482

			IsTileOwner(tile, _local_player) &&

   483

			IsRailWaypoint(tile)) {

   484

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

   485

		if (_patches.new_nonstop) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   486

		return order;

   487