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 "company_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

#include "network/network.h"

    35

    36

#include "table/sprites.h"

    37

#include "table/strings.h"

    38

    39

enum OrderWindowWidgets {

    40

	ORDER_WIDGET_CLOSEBOX = 0,

    41

	ORDER_WIDGET_CAPTION,

    42

	ORDER_WIDGET_TIMETABLE_VIEW,

    43

	ORDER_WIDGET_ORDER_LIST,

    44

	ORDER_WIDGET_SCROLLBAR,

    45

	ORDER_WIDGET_SKIP,

    46

	ORDER_WIDGET_DELETE,

    47

	ORDER_WIDGET_NON_STOP_DROPDOWN,

    48

	ORDER_WIDGET_NON_STOP,

    49

	ORDER_WIDGET_GOTO_DROPDOWN,

    50

	ORDER_WIDGET_GOTO,

    51

	ORDER_WIDGET_FULL_LOAD_DROPDOWN,

    52

	ORDER_WIDGET_FULL_LOAD,

    53

	ORDER_WIDGET_UNLOAD_DROPDOWN,

    54

	ORDER_WIDGET_UNLOAD,

    55

	ORDER_WIDGET_REFIT,

    56

	ORDER_WIDGET_SERVICE_DROPDOWN,

    57

	ORDER_WIDGET_SERVICE,

    58

	ORDER_WIDGET_COND_VARIABLE,

    59

	ORDER_WIDGET_COND_COMPARATOR,

    60

	ORDER_WIDGET_COND_VALUE,

    61

	ORDER_WIDGET_RESIZE_BAR,

    62

	ORDER_WIDGET_SHARED_ORDER_LIST,

    63

	ORDER_WIDGET_RESIZE,

    64

};

    65

    66

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

    67

static const StringID _station_load_types[][5] = {

    68

	{

    69

		STR_EMPTY,

    70

		INVALID_STRING_ID,

    71

		STR_ORDER_FULL_LOAD,

    72

		STR_ORDER_FULL_LOAD_ANY,

    73

		STR_ORDER_NO_LOAD,

    74

	}, {

    75

		STR_ORDER_UNLOAD,

    76

		INVALID_STRING_ID,

    77

		STR_ORDER_UNLOAD_FULL_LOAD,

    78

		STR_ORDER_UNLOAD_FULL_LOAD_ANY,

    79

		STR_ORDER_UNLOAD_NO_LOAD,

    80

	}, {

    81

		STR_ORDER_TRANSFER,

    82

		INVALID_STRING_ID,

    83

		STR_ORDER_TRANSFER_FULL_LOAD,

    84

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

    85

		STR_ORDER_TRANSFER_NO_LOAD,

    86

	}, {

    87

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

    88

		INVALID_STRING_ID,

    89

		INVALID_STRING_ID,

    90

		INVALID_STRING_ID,

    91

		INVALID_STRING_ID,

    92

	}, {

    93

		STR_ORDER_NO_UNLOAD,

    94

		INVALID_STRING_ID,

    95

		STR_ORDER_NO_UNLOAD_FULL_LOAD,

    96

		STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,

    97

		INVALID_STRING_ID,

    98

	}

    99

};

   100

   101

static const StringID _order_non_stop_drowdown[] = {

   102

	STR_ORDER_GO_TO,

   103

	STR_ORDER_GO_NON_STOP_TO,

   104

	STR_ORDER_GO_VIA,

   105

	STR_ORDER_GO_NON_STOP_VIA,

   106

	INVALID_STRING_ID

   107

};

   108

   109

static const StringID _order_full_load_drowdown[] = {

   110

	STR_ORDER_DROP_LOAD_IF_POSSIBLE,

   111

	STR_EMPTY,

   112

	STR_ORDER_DROP_FULL_LOAD_ALL,

   113

	STR_ORDER_DROP_FULL_LOAD_ANY,

   114

	STR_ORDER_DROP_NO_LOADING,

   115

	INVALID_STRING_ID

   116

};

   117

   118

static const StringID _order_unload_drowdown[] = {

   119

	STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,

   120

	STR_ORDER_DROP_UNLOAD,

   121

	STR_ORDER_DROP_TRANSFER,

   122

	STR_EMPTY,

   123

	STR_ORDER_DROP_NO_UNLOADING,

   124

	INVALID_STRING_ID

   125

};

   126

   127

static const StringID _order_goto_dropdown[] = {

   128

	STR_ORDER_GO_TO,

   129

	STR_ORDER_GO_TO_NEAREST_DEPOT,

   130

	STR_ORDER_CONDITIONAL,

   131

	INVALID_STRING_ID

   132

};

   133

   134

static const StringID _order_goto_dropdown_aircraft[] = {

   135

	STR_ORDER_GO_TO,

   136

	STR_ORDER_GO_TO_NEAREST_HANGAR,

   137

	STR_ORDER_CONDITIONAL,

   138

	INVALID_STRING_ID

   139

};

   140

   141

static const StringID _order_conditional_variable[] = {

   142

	STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE,

   143

	STR_ORDER_CONDITIONAL_RELIABILITY,

   144

	STR_ORDER_CONDITIONAL_MAX_SPEED,

   145

	STR_ORDER_CONDITIONAL_AGE,

   146

	STR_ORDER_CONDITIONAL_REQUIRES_SERVICE,

   147

	STR_ORDER_CONDITIONAL_UNCONDITIONALLY,

   148

	INVALID_STRING_ID,

   149

};

   150

   151

static const StringID _order_conditional_condition[] = {

   152

	STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS,

   153

	STR_ORDER_CONDITIONAL_COMPARATOR_NOT_EQUALS,

   154

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_THAN,

   155

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_EQUALS,

   156

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_THAN,

   157

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_EQUALS,

   158

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_TRUE,

   159

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_FALSE,

   160

	INVALID_STRING_ID,

   161

};

   162

   163

extern uint ConvertSpeedToDisplaySpeed(uint speed);

   164

extern uint ConvertDisplaySpeedToSpeed(uint speed);

   165

   166

static const StringID _order_depot_action_dropdown[] = {

   167

	STR_ORDER_DROP_GO_ALWAYS_DEPOT,

   168

	STR_ORDER_DROP_SERVICE_DEPOT,

   169

	STR_ORDER_DROP_HALT_DEPOT,

   170

	INVALID_STRING_ID

   171

};

   172

   173

static int DepotActionStringIndex(const Order *order)

   174

{

   175

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

   176

		return DA_STOP;

   177

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

   178

		return DA_SERVICE;

   179

	} else {

   180

		return DA_ALWAYS_GO;

   181

	}

   182

}

   183

   184

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

   185

{

   186

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

   187

	SetDParam(6, STR_EMPTY);

   188

   189

	switch (order->GetType()) {

   190

		case OT_DUMMY:

   191

			SetDParam(1, STR_INVALID_ORDER);

   192

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

   193

			break;

   194

   195

		case OT_GOTO_STATION: {

   196

			OrderLoadFlags load = order->GetLoadType();

   197

			OrderUnloadFlags unload = order->GetUnloadType();

   198

   199

			SetDParam(1, STR_GO_TO_STATION);

   200

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

   201

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

   202

   203

			if (timetable) {

   204

				SetDParam(4, STR_EMPTY);

   205

   206

				if (order->wait_time > 0) {

   207

					SetDParam(6, STR_TIMETABLE_STAY_FOR);

   208

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

   209

				}

   210

			} else {

   211

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

   212

			}

   213

		} break;

   214

   215

		case OT_GOTO_DEPOT:

   216

			if (v->type == VEH_AIRCRAFT) {

   217

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

   218

					SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   219

					SetDParam(3, STR_ORDER_NEAREST_HANGAR);

   220

				} else {

   221

					SetDParam(1, STR_GO_TO_HANGAR);

   222

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

   223

				}

   224

				SetDParam(4, STR_EMPTY);

   225

			} else {

   226

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

   227

					SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   228

					SetDParam(3, STR_ORDER_NEAREST_DEPOT);

   229

				} else {

   230

					SetDParam(1, STR_GO_TO_DEPOT);

   231

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

   232

				}

   233

   234

				switch (v->type) {

   235

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

   236

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

   237

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

   238

					default: NOT_REACHED();

   239

				}

   240

			}

   241

   242

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

   243

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

   244

			} else {

   245

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

   246

			}

   247

   248

			if (!timetable && (order->GetDepotActionType() & ODATFB_HALT)) {

   249

				SetDParam(6, STR_STOP_ORDER);

   250

			}

   251

   252

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

   253

				SetDParam(6, (order->GetDepotActionType() & ODATFB_HALT) ? STR_REFIT_STOP_ORDER : STR_REFIT_ORDER);

   254

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

   255

			}

   256

			break;

   257

   258

		case OT_GOTO_WAYPOINT:

   259

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

   260

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

   261

			break;

   262

   263

		case OT_CONDITIONAL:

   264

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

   265

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

   266

				SetDParam(1, STR_CONDITIONAL_UNCONDITIONAL);

   267

			} else {

   268

				OrderConditionComparator occ = order->GetConditionComparator();

   269

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

   270

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

   271

				SetDParam(4, STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS + occ);

   272

   273

				uint value = order->GetConditionValue();

   274

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

   275

				SetDParam(5, value);

   276

			}

   277

   278

			if (timetable && order->wait_time > 0) {

   279

				SetDParam(6, STR_TIMETABLE_AND_TRAVEL_FOR);

   280

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

   281

			} else {

   282

				SetDParam(6, STR_EMPTY);

   283

			}

   284

			break;

   285

   286

		default: NOT_REACHED();

   287

	}

   288

   289

	SetDParam(0, order_index + 1);

   290

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

   291

}

   292

   293

   294

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

   295

{

   296

	Order order;

   297

	order.next  = NULL;

   298

	order.index = 0;

   299

   300

	/* check depot first */

   301

	if (_settings_game.order.gotodepot) {

   302

		switch (GetTileType(tile)) {

   303

			case MP_RAILWAY:

   304

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

   305

					if (IsRailDepot(tile)) {

   306

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

   307

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

   308

						return order;

   309

					}

   310

				}

   311

				break;

   312

   313

			case MP_ROAD:

   314

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

   315

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

   316

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

   317

					return order;

   318

				}

   319

				break;

   320

   321

			case MP_STATION:

   322

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

   323

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

   324

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

   325

					return order;

   326

				}

   327

				break;

   328

   329

			case MP_WATER:

   330

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

   331

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

   332

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   333

   334

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

   335

					return order;

   336

				}

   337

   338

			default:

   339

				break;

   340

		}

   341

	}

   342

   343

	/* check waypoint */

   344

	if (IsRailWaypointTile(tile) &&

   345

			v->type == VEH_TRAIN &&

   346

			IsTileOwner(tile, _local_company)) {

   347

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

   348

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

   349

		return order;

   350

	}

   351

   352

	if (IsTileType(tile, MP_STATION)) {

   353

		StationID st_index = GetStationIndex(tile);

   354

		const Station *st = GetStation(st_index);

   355

   356

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

   357

			byte facil;

   358

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

   359

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

   360

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

   361

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

   362

			(facil = FACIL_TRUCK_STOP, 1);

   363

			if (st->facilities & facil) {

   364

				order.MakeGoToStation(st_index);

   365

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

   366

				return order;

   367

			}

   368

		}

   369

	}

   370

   371

	/* not found */

   372

	order.Free();

   373

	return order;

   374

}

   375

   376

struct OrdersWindow : public Window {

   377

private:

   378

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

   379

	enum OrderPlaceObjectState {

   380

		OPOS_GOTO,

   381

		OPOS_CONDITIONAL,

   382

	};

   383

   384

	int selected_order;

   385

	OrderPlaceObjectState goto_type;

   386

	const Vehicle *vehicle;

   387

   388

	/**

   389

	 * Return the memorised selected order.

   390

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

   391

	 *  else return the number of orders

   392

	 */

   393

	int OrderGetSel()

   394

	{

   395

		int num = this->selected_order;

   396

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

   397

	}

   398

   399

	/**

   400

	 * Calculate the selected order.

   401

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

   402

	 *  the position of the scrollbar.

   403

	 *

   404

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

   405

	 * @param v current vehicle

   406

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

   407

	 *  an invalid one has been selected.

   408

	 */

   409

	int GetOrderFromPt(int y)

   410

	{

   411

		/*

   412

		 * Calculation description:

   413

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

   414

		 * 10 = order text hight

   415

		 */

   416

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

   417

   418

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

   419

   420

		sel += this->vscroll.pos;

   421

   422

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

   423

	}

   424

   425

	bool HandleOrderVehClick(const Vehicle *u)

   426

	{

   427

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

   428

   429

		if (!u->IsPrimaryVehicle()) {

   430

			u = u->First();

   431

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

   432

		}

   433

   434

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

   435

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

   436

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

   437

   438

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

   439

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

   440

			this->selected_order = -1;

   441

			ResetObjectToPlace();

   442

		}

   443

   444

		return true;

   445

	}

   446

   447

	/**

   448

	 * Handle the click on the goto button.

   449

	 *

   450

	 * @param w current window

   451

	 */

   452

	static void OrderClick_Goto(OrdersWindow *w, int i)

   453

	{

   454

		w->InvalidateWidget(ORDER_WIDGET_GOTO);

   455

		w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   456

		if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   457

			_place_clicked_vehicle = NULL;

   458

			SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   459

			w->goto_type = OPOS_GOTO;

   460

		} else {

   461

			ResetObjectToPlace();

   462

		}

   463

	}

   464

   465

	/**

   466

	 * Handle the click on the full load button.

   467

	 *

   468

	 * @param w current window

   469

	 * @param load_type the way to load.

   470

	 */

   471

	static void OrderClick_FullLoad(OrdersWindow *w, int load_type)

   472

	{

   473

		VehicleOrderID sel_ord = w->OrderGetSel();

   474

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

   475

   476

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

   477

   478

		if (load_type < 0) {

   479

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

   480

		}

   481

		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));

   482

	}

   483

   484

	/**

   485

	 * Handle the click on the service.

   486

	 *

   487

	 * @param w current window