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,

    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

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

    62

static const StringID _station_load_types[][5] = {

    63

	{

    64

		STR_EMPTY,

    65

		INVALID_STRING_ID,

    66

		STR_ORDER_FULL_LOAD,

    67

		STR_ORDER_FULL_LOAD_ANY,

    68

		STR_ORDER_NO_LOAD,

    69

	}, {

    70

		STR_ORDER_UNLOAD,

    71

		INVALID_STRING_ID,

    72

		STR_ORDER_UNLOAD_FULL_LOAD,

    73

		STR_ORDER_UNLOAD_FULL_LOAD_ANY,

    74

		STR_ORDER_UNLOAD_NO_LOAD,

    75

	}, {

    76

		STR_ORDER_TRANSFER,

    77

		INVALID_STRING_ID,

    78

		STR_ORDER_TRANSFER_FULL_LOAD,

    79

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

    80

		STR_ORDER_TRANSFER_NO_LOAD,

    81

	}, {

    82

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

    83

		INVALID_STRING_ID,

    84

		INVALID_STRING_ID,

    85

		INVALID_STRING_ID,

    86

		INVALID_STRING_ID,

    87

	}, {

    88

		STR_ORDER_NO_UNLOAD,

    89

		INVALID_STRING_ID,

    90

		STR_ORDER_NO_UNLOAD_FULL_LOAD,

    91

		STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,

    92

		INVALID_STRING_ID,

    93

	}

    94

};

    95

    96

static const StringID _order_non_stop_drowdown[] = {

    97

	STR_ORDER_GO_TO,

    98

	STR_ORDER_GO_NON_STOP_TO,

    99

	STR_ORDER_GO_VIA,

   100

	STR_ORDER_GO_NON_STOP_VIA,

   101

	INVALID_STRING_ID

   102

};

   103

   104

static const StringID _order_full_load_drowdown[] = {

   105

	STR_ORDER_DROP_LOAD_IF_POSSIBLE,

   106

	STR_EMPTY,

   107

	STR_ORDER_DROP_FULL_LOAD_ALL,

   108

	STR_ORDER_DROP_FULL_LOAD_ANY,

   109

	STR_ORDER_DROP_NO_LOADING,

   110

	INVALID_STRING_ID

   111

};

   112

   113

static const StringID _order_unload_drowdown[] = {

   114

	STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,

   115

	STR_ORDER_DROP_UNLOAD,

   116

	STR_ORDER_DROP_TRANSFER,

   117

	STR_EMPTY,

   118

	STR_ORDER_DROP_NO_UNLOADING,

   119

	INVALID_STRING_ID

   120

};

   121

   122

static const StringID _order_goto_dropdown[] = {

   123

	STR_ORDER_GO_TO,

   124

	STR_ORDER_GO_TO_NEAREST_DEPOT,

   125

	STR_ORDER_CONDITIONAL,

   126

	INVALID_STRING_ID

   127

};

   128

   129

static const StringID _order_goto_dropdown_aircraft[] = {

   130

	STR_ORDER_GO_TO,

   131

	STR_ORDER_GO_TO_NEAREST_HANGAR,

   132

	STR_ORDER_CONDITIONAL,

   133

	INVALID_STRING_ID

   134

};

   135

   136

static const StringID _order_conditional_variable[] = {

   137

	STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE,

   138

	STR_ORDER_CONDITIONAL_RELIABILITY,

   139

	STR_ORDER_CONDITIONAL_MAX_SPEED,

   140

	STR_ORDER_CONDITIONAL_AGE,

   141

	STR_ORDER_CONDITIONAL_REQUIRES_SERVICE,

   142

	STR_ORDER_CONDITIONAL_UNCONDITIONALLY,

   143

	INVALID_STRING_ID,

   144

};

   145

   146

static const StringID _order_conditional_condition[] = {

   147

	STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS,

   148

	STR_ORDER_CONDITIONAL_COMPARATOR_NOT_EQUALS,

   149

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_THAN,

   150

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_EQUALS,

   151

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_THAN,

   152

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_EQUALS,

   153

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_TRUE,

   154

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_FALSE,

   155

	INVALID_STRING_ID,

   156

};

   157

   158

extern uint ConvertSpeedToDisplaySpeed(uint speed);

   159

extern uint ConvertDisplaySpeedToSpeed(uint speed);

   160

   161

   162

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

   163

{

   164

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

   165

	SetDParam(6, STR_EMPTY);

   166

   167

	switch (order->GetType()) {

   168

		case OT_DUMMY:

   169

			SetDParam(1, STR_INVALID_ORDER);

   170

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

   171

			break;

   172

   173

		case OT_GOTO_STATION: {

   174

			OrderLoadFlags load = order->GetLoadType();

   175

			OrderUnloadFlags unload = order->GetUnloadType();

   176

   177

			SetDParam(1, STR_GO_TO_STATION);

   178

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

   179

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

   180

   181

			if (timetable) {

   182

				SetDParam(4, STR_EMPTY);

   183

   184

				if (order->wait_time > 0) {

   185

					SetDParam(6, STR_TIMETABLE_STAY_FOR);

   186

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

   187

				}

   188

			} else {

   189

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

   190

			}

   191

		} break;

   192

   193

		case OT_GOTO_DEPOT:

   194

			if (v->type == VEH_AIRCRAFT) {

   195

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

   196

					SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   197

					SetDParam(3, STR_ORDER_NEAREST_HANGAR);

   198

				} else {

   199

					SetDParam(1, STR_GO_TO_HANGAR);

   200

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

   201

				}

   202

				SetDParam(4, STR_EMPTY);

   203

			} else {

   204

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

   205

					SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   206

					SetDParam(3, STR_ORDER_NEAREST_DEPOT);

   207

				} else {

   208

					SetDParam(1, STR_GO_TO_DEPOT);

   209

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

   210

				}

   211

   212

				switch (v->type) {

   213

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

   214

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

   215

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

   216

					default: NOT_REACHED();

   217

				}

   218

			}

   219

   220

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

   221

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

   222

			} else {

   223

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

   224

			}

   225

   226

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

   227

				SetDParam(6, STR_REFIT_ORDER);

   228

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

   229

			}

   230

			break;

   231

   232

		case OT_GOTO_WAYPOINT:

   233

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

   234

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

   235

			break;

   236

   237

		case OT_CONDITIONAL:

   238

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

   239

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

   240

				SetDParam(1, STR_CONDITIONAL_UNCONDITIONAL);

   241

			} else {

   242

				OrderConditionComparator occ = order->GetConditionComparator();

   243

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

   244

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

   245

				SetDParam(4, STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS + occ);

   246

   247

				uint value = order->GetConditionValue();

   248

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

   249

				SetDParam(5, value);

   250

			}

   251

			break;

   252

   253

		default: NOT_REACHED();

   254

	}

   255

   256

	SetDParam(0, order_index + 1);

   257

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

   258

}

   259

   260

   261

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

   262

{

   263

	Order order;

   264

	order.next  = NULL;

   265

	order.index = 0;

   266

   267

	/* check depot first */

   268

	if (_patches.gotodepot) {

   269

		switch (GetTileType(tile)) {

   270

			case MP_RAILWAY:

   271

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

   272

					if (IsRailDepot(tile)) {

   273

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

   274

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

   275

						return order;

   276

					}

   277

				}

   278

				break;

   279

   280

			case MP_ROAD:

   281

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

   282

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

   283

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

   284

					return order;

   285

				}

   286

				break;

   287

   288

			case MP_STATION:

   289

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

   290

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

   291

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

   292

					return order;

   293

				}

   294

				break;

   295

   296

			case MP_WATER:

   297

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

   298

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

   299

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   300

   301

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

   302

					return order;

   303

				}

   304

   305

			default:

   306

				break;

   307

		}

   308

	}

   309

   310

	/* check waypoint */

   311

	if (IsTileType(tile, MP_RAILWAY) &&

   312

			v->type == VEH_TRAIN &&

   313

			IsTileOwner(tile, _local_player) &&

   314

			IsRailWaypoint(tile)) {

   315

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

   316

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

   317

		return order;

   318

	}

   319

   320

	if (IsTileType(tile, MP_STATION)) {

   321

		StationID st_index = GetStationIndex(tile);

   322

		const Station *st = GetStation(st_index);

   323

   324

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

   325

			byte facil;

   326

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

   327

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

   328

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

   329

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

   330

			(facil = FACIL_TRUCK_STOP, 1);

   331

			if (st->facilities & facil) {

   332

				order.MakeGoToStation(st_index);

   333

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

   334

				return order;

   335

			}

   336

		}

   337

	}

   338

   339

	/* not found */

   340

	order.Free();

   341

	return order;

   342

}

   343

   344

struct OrdersWindow : public Window {

   345

private:

   346

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

   347

	enum OrderPlaceObjectState {

   348

		OPOS_GOTO,

   349

		OPOS_CONDITIONAL,

   350

	};

   351

   352

	int selected_order;

   353

	OrderPlaceObjectState goto_type;

   354

	const Vehicle *vehicle;

   355

   356

	/**

   357

	 * Return the memorised selected order.

   358

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

   359

	 *  else return the number of orders

   360

	 */

   361

	int OrderGetSel()

   362

	{

   363

		int num = this->selected_order;

   364

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

   365

	}

   366

   367

	/**

   368

	 * Calculate the selected order.

   369

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

   370

	 *  the position of the scrollbar.

   371

	 *

   372

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

   373

	 * @param v current vehicle

   374

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

   375

	 *  an invalid one has been selected.

   376

	 */

   377

	int GetOrderFromPt(int y)

   378

	{

   379

		/*

   380

		 * Calculation description:

   381

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

   382

		 * 10 = order text hight

   383

		 */

   384

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

   385

   386

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

   387

   388

		sel += this->vscroll.pos;

   389

   390

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

   391

	}

   392

   393

	bool HandleOrderVehClick(const Vehicle *u)

   394

	{

   395

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

   396

   397

		if (!u->IsPrimaryVehicle()) {

   398

			u = u->First();

   399

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

   400

		}

   401

   402

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

   403

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

   404

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

   405

   406

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

   407

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

   408

			this->selected_order = -1;

   409

			ResetObjectToPlace();

   410

		}

   411

   412

		return true;

   413

	}

   414

   415

	/**

   416

	 * Handle the click on the goto button.

   417

	 *

   418

	 * @param w current window

   419

	 */

   420

	static void OrderClick_Goto(OrdersWindow *w, int i)

   421

	{

   422

		w->InvalidateWidget(ORDER_WIDGET_GOTO);

   423

		w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   424

		if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   425

			_place_clicked_vehicle = NULL;

   426

			SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   427

			w->goto_type = OPOS_GOTO;

   428

		} else {

   429

			ResetObjectToPlace();

   430

		}

   431

	}

   432

   433

	/**

   434

	 * Handle the click on the full load button.

   435

	 *

   436

	 * @param w current window

   437

	 * @param load_type the way to load.

   438

	 */

   439

	static void OrderClick_FullLoad(OrdersWindow *w, int load_type)

   440

	{

   441

		VehicleOrderID sel_ord = w->OrderGetSel();

   442

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

   443

   444

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

   445

   446

		if (load_type < 0) {

   447

			switch (order->GetLoadType()) {

   448

				case OLF_LOAD_IF_POSSIBLE: load_type = OLFB_FULL_LOAD;       break;

   449

				case OLFB_FULL_LOAD:       load_type = OLF_FULL_LOAD_ANY;    break;

   450

				case OLF_FULL_LOAD_ANY:    load_type = OLFB_NO_LOAD;         break;

   451

				case OLFB_NO_LOAD:         load_type = OLF_LOAD_IF_POSSIBLE; break;

   452

				default: NOT_REACHED();

   453

			}

   454

		}

   455

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

   456

	}

   457

   458

	/**

   459

	 * Handle the click on the service.

   460

	 *

   461

	 * @param w current window

   462

	 */

   463

	static void OrderClick_Service(OrdersWindow *w, int i)

   464

	{

   465

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

   466

	}

   467

   468

	/**

   469

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

   470

	 *

   471

	 * @param w current window

   472

	 */

   473

	static void OrderClick_NearestDepot(OrdersWindow *w, int i)

   474

	{

   475

		Order order;

   476

		order.next = NULL;

   477

		order.index = 0;

   478

		order.MakeGoToDepot(0, ODTFB_PART_OF_ORDERS);

   479

		order.SetDepotActionType(ODATFB_NEAREST_DEPOT);

   480

   481

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

   482

	}

   483

   484

	/**

   485

	 * Handle the click on the conditional order button.

   486

	 *

   487

	 * @param w current window

   488

	 */