1

/* $Id$ */

     2

     3

/** @file order_gui.cpp */

     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.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

    31

#include "table/sprites.h"

    32

#include "table/strings.h"

    33

    34

enum OrderWindowWidgets {

    35

	ORDER_WIDGET_CLOSEBOX = 0,

    36

	ORDER_WIDGET_CAPTION,

    37

	ORDER_WIDGET_TIMETABLE_VIEW,

    38

	ORDER_WIDGET_ORDER_LIST,

    39

	ORDER_WIDGET_SCROLLBAR,

    40

	ORDER_WIDGET_SKIP,

    41

	ORDER_WIDGET_DELETE,

    42

	ORDER_WIDGET_NON_STOP,

    43

	ORDER_WIDGET_GOTO,

    44

	ORDER_WIDGET_FULL_LOAD,

    45

	ORDER_WIDGET_UNLOAD,

    46

	ORDER_WIDGET_REFIT,

    47

	ORDER_WIDGET_SERVICE,

    48

	ORDER_WIDGET_RESIZE_BAR,

    49

	ORDER_WIDGET_SHARED_ORDER_LIST,

    50

	ORDER_WIDGET_RESIZE,

    51

};

    52

    53

/**

    54

 * Return the memorised selected order.

    55

 *

    56

 * @param w current window

    57

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

    58

 *  else return the number of orders

    59

 */

    60

static int OrderGetSel(const Window *w)

    61

{

    62

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

    63

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

    64

    65

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

    66

}

    67

    68

/**

    69

 * Calculate the selected order.

    70

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

    71

 *  the position of the scrollbar.

    72

 *

    73

 * @param w current window

    74

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

    75

 * @param v current vehicle

    76

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

    77

 *  an invalid one has been selected.

    78

 */

    79

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

    80

{

    81

	/*

    82

	 * Calculation description:

    83

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

    84

	 * 10 = order text hight

    85

	 */

    86

	int sel = (y - 15) / 10;

    87

    88

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

    89

    90

	sel += w->vscroll.pos;

    91

    92

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

    93

}

    94

    95

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

    96

static const StringID _station_load_types[][5] = {

    97

	{

    98

		STR_EMPTY,

    99

		INVALID_STRING_ID,

   100

		STR_ORDER_FULL_LOAD,

   101

		STR_ORDER_FULL_LOAD_ANY,

   102

		STR_ORDER_NO_LOAD,

   103

	}, {

   104

		STR_ORDER_UNLOAD,

   105

		INVALID_STRING_ID,

   106

		STR_ORDER_UNLOAD_FULL_LOAD,

   107

		STR_ORDER_UNLOAD_FULL_LOAD_ANY,

   108

		STR_ORDER_UNLOAD_NO_LOAD,

   109

	}, {

   110

		STR_ORDER_TRANSFER,

   111

		INVALID_STRING_ID,

   112

		STR_ORDER_TRANSFER_FULL_LOAD,

   113

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

   114

		STR_ORDER_TRANSFER_NO_LOAD,

   115

	}, {

   116

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

   117

		INVALID_STRING_ID,

   118

		INVALID_STRING_ID,

   119

		INVALID_STRING_ID,

   120

		INVALID_STRING_ID,

   121

	}, {

   122

		STR_ORDER_NO_UNLOAD,

   123

		INVALID_STRING_ID,

   124

		STR_ORDER_NO_UNLOAD_FULL_LOAD,

   125

		STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,

   126

		INVALID_STRING_ID,

   127

	}

   128

};

   129

   130

static const StringID _order_non_stop_drowdown[] = {

   131

	STR_ORDER_GO_TO,

   132

	STR_ORDER_GO_NON_STOP_TO,

   133

	STR_ORDER_GO_VIA,

   134

	STR_ORDER_GO_NON_STOP_VIA,

   135

	INVALID_STRING_ID

   136

};

   137

   138

static const StringID _order_full_load_drowdown[] = {

   139

	STR_ORDER_DROP_LOAD_IF_POSSIBLE,

   140

	STR_EMPTY,

   141

	STR_ORDER_DROP_FULL_LOAD_ALL,

   142

	STR_ORDER_DROP_FULL_LOAD_ANY,

   143

	STR_ORDER_DROP_NO_LOADING,

   144

	INVALID_STRING_ID

   145

};

   146

   147

static const StringID _order_unload_drowdown[] = {

   148

	STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,

   149

	STR_ORDER_DROP_UNLOAD,

   150

	STR_ORDER_DROP_TRANSFER,

   151

	STR_EMPTY,

   152

	STR_ORDER_DROP_NO_UNLOADING,

   153

	INVALID_STRING_ID

   154

};

   155

   156

static void DrawOrdersWindow(Window *w)

   157

{

   158

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

   159

	bool shared_orders = v->IsOrderListShared();

   160

   161

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

   162

   163

	int sel = OrderGetSel(w);

   164

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

   165

   166

	if (v->owner == _local_player) {

   167

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

   168

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

   169

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

   170

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

   171

   172

		/* skip */

   173

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

   174

   175

		/* delete */

   176

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   177

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

   178

   179

		/* non-stop only for trains */

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

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

   187

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   188

		w->HideWidget(ORDER_WIDGET_SERVICE); // Service

   189

	} else {

   190

		w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   191

	}

   192

   193

	w->ShowWidget(ORDER_WIDGET_UNLOAD);

   194

	w->ShowWidget(ORDER_WIDGET_FULL_LOAD);

   195

   196

	if (order != NULL) {

   197

		switch (order->GetType()) {

   198

			case OT_GOTO_STATION:

   199

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

   200

				/* Fall-through */

   201

   202

			case OT_GOTO_WAYPOINT:

   203

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   204

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   205

				break;

   206

   207

			case OT_GOTO_DEPOT:

   208

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   209

   210

				/* Remove unload and replace it with refit */

   211

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   212

				w->ShowWidget(ORDER_WIDGET_REFIT);

   213

				w->HideWidget(ORDER_WIDGET_FULL_LOAD);

   214

				w->ShowWidget(ORDER_WIDGET_SERVICE);

   215

				break;

   216

   217

			default: // every other orders

   218

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   219

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   220

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   221

		}

   222

	}

   223

   224

	SetDParam(0, v->index);

   225

	DrawWindowWidgets(w);

   226

   227

	int y = 15;

   228

   229

	int i = w->vscroll.pos;

   230

	order = GetVehicleOrder(v, i);

   231

	StringID str;

   232

	while (order != NULL) {

   233

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

   234

		SetDParam(5, STR_EMPTY);

   235

   236

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

   237

			SetDParam(1, 6);

   238

   239

			switch (order->GetType()) {

   240

				case OT_DUMMY:

   241

					SetDParam(1, STR_INVALID_ORDER);

   242

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

   243

					break;

   244

   245

				case OT_GOTO_STATION: {

   246

					OrderLoadFlags load = order->GetLoadType();

   247

					OrderUnloadFlags unload = order->GetUnloadType();

   248

   249

					SetDParam(1, STR_GO_TO_STATION);

   250

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

   251

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

   252

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

   253

				} break;

   254

   255

				case OT_GOTO_DEPOT: {

   256

					StringID s = STR_NULL;

   257

   258

					if (v->type == VEH_AIRCRAFT) {

   259

						s = STR_GO_TO_AIRPORT_HANGAR;

   260

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

   261

					} else {

   262

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

   263

   264

						switch (v->type) {

   265

							case VEH_TRAIN: s = (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_880F_GO_NON_STOP_TO_TRAIN_DEPOT : STR_GO_TO_TRAIN_DEPOT; break;

   266

							case VEH_ROAD:  s = STR_GO_TO_ROADVEH_DEPOT; break;

   267

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   268

							default: break;

   269

						}

   270

					}

   271

   272

					if (order->GetDepotOrderType() & ODTFB_SERVICE) s++; // service at

   273

   274

					SetDParam(1, s);

   275

					if (order->IsRefit()) {

   276

						SetDParam(5, STR_REFIT_ORDER);

   277

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

   278

					}

   279

					break;

   280

				}

   281

   282

				case OT_GOTO_WAYPOINT:

   283

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

   284

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

   285

					break;

   286

   287

				default: break;

   288

			}

   289

   290

			SetDParam(0, i + 1);

   291

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

   292

   293

			y += 10;

   294

		}

   295

   296

		i++;

   297

		order = order->next;

   298

	}

   299

   300

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

   301

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   302

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

   303

	}

   304

}

   305

   306

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

   307

{

   308

	Order order;

   309

	order.next  = NULL;

   310

	order.index = 0;

   311

   312

	/* check depot first */

   313

	if (_patches.gotodepot) {

   314

		switch (GetTileType(tile)) {

   315

			case MP_RAILWAY:

   316

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

   317

					if (IsRailDepot(tile)) {

   318

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

   319

						return order;

   320

					}

   321

				}

   322

				break;

   323

   324

			case MP_ROAD:

   325

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

   326

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

   327

					return order;

   328

				}

   329

				break;

   330

   331

			case MP_STATION:

   332

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

   333

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

   334

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

   335

					return order;

   336

				}

   337

				break;

   338

   339

			case MP_WATER:

   340

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

   341

				if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   342

						IsTileOwner(tile, _local_player)) {

   343

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   344

   345

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

   346

					return order;

   347

				}

   348

   349

			default:

   350

				break;

   351

		}

   352

	}

   353

   354

	/* check waypoint */

   355

	if (IsTileType(tile, MP_RAILWAY) &&

   356

			v->type == VEH_TRAIN &&

   357

			IsTileOwner(tile, _local_player) &&

   358

			IsRailWaypoint(tile)) {

   359

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

   360

		return order;

   361

	}

   362

   363

	if (IsTileType(tile, MP_STATION)) {

   364

		StationID st_index = GetStationIndex(tile);

   365

		const Station *st = GetStation(st_index);

   366

   367

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

   368

			byte facil;

   369

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

   370

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

   371

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

   372

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

   373

			(facil = FACIL_TRUCK_STOP, 1);

   374

			if (st->facilities & facil) {

   375

				order.MakeGoToStation(st_index);

   376

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

   377

				return order;

   378

			}

   379

		}

   380

	}

   381

   382

	/* not found */

   383

	order.Free();

   384

	return order;

   385

}

   386

   387

static bool HandleOrderVehClick(const Vehicle *v, const Vehicle *u, Window *w)

   388

{

   389

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

   390

   391

	if (!u->IsPrimaryVehicle()) {

   392

		u = u->First();

   393

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

   394

	}

   395

   396

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

   397

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

   398

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

   399

   400

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

   401

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

   402

		WP(w, order_d).sel = -1;

   403

		ResetObjectToPlace();

   404

	}

   405

   406

	return true;

   407

}

   408

   409

static void OrdersPlaceObj(const Vehicle *v, TileIndex tile, Window *w)

   410

{

   411

	/* check if we're clicking on a vehicle first.. clone orders in that case. */

   412

	const Vehicle *u = CheckMouseOverVehicle();

   413

	if (u != NULL && HandleOrderVehClick(v, u, w)) return;

   414

   415

	const Order cmd = GetOrderCmdFromTile(v, tile);

   416

	if (!cmd.IsValid()) return;

   417

   418

	if (DoCommandP(v->tile, v->index + (OrderGetSel(w) << 16), cmd.Pack(), NULL, CMD_INSERT_ORDER | CMD_MSG(STR_8833_CAN_T_INSERT_NEW_ORDER))) {

   419

		if (WP(w, order_d).sel != -1) WP(w,order_d).sel++;

   420

		ResetObjectToPlace();

   421

	}

   422

}

   423

   424

/**

   425

 * Handle the click on the goto button.

   426

 *

   427

 * @param w current window

   428

 * @param v current vehicle

   429

 */

   430

static void OrderClick_Goto(Window *w, const Vehicle *v, int i)

   431

{

   432

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   433

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   434

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   435

		_place_clicked_vehicle = NULL;

   436

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   437

	} else {

   438

		ResetObjectToPlace();

   439

	}

   440

}

   441

   442

/**

   443

 * Handle the click on the full load button.

   444

 *

   445

 * @param w current window

   446

 * @param v current vehicle

   447

 * @param load_type the way to load.

   448

 */

   449

static void OrderClick_FullLoad(Window *w, const Vehicle *v, int load_type)

   450

{

   451

	VehicleOrderID sel_ord = OrderGetSel(w);

   452

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

   453

   454

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

   455

   456

	if (load_type < 0) {

   457

		switch (order->GetLoadType()) {

   458

			case OLF_LOAD_IF_POSSIBLE: load_type = OLFB_FULL_LOAD;       break;

   459

			case OLFB_FULL_LOAD:       load_type = OLF_FULL_LOAD_ANY;    break;

   460

			case OLF_FULL_LOAD_ANY:    load_type = OLFB_NO_LOAD;         break;

   461

			case OLFB_NO_LOAD:         load_type = OLF_LOAD_IF_POSSIBLE; break;

   462

			default: NOT_REACHED();

   463

		}

   464

	}

   465

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

   466

}

   467

   468

/**

   469

 * Handle the click on the service.

   470

 *

   471

 * @param w current window

   472

 * @param v current vehicle

   473

 */

   474

static void OrderClick_Service(Window *w, const Vehicle *v, int i)

   475

{

   476

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

   477

}

   478

   479

/**

   480

 * Handle the click on the unload button.

   481

 *

   482

 * @param w current window

   483

 * @param v current vehicle

   484

 */