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 "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "gui.h"

    12

#include "window_gui.h"

    13

#include "station.h"

    14

#include "town.h"

    15

#include "command_func.h"

    16

#include "viewport_func.h"

    17

#include "gfx_func.h"

    18

#include "depot.h"

    19

#include "waypoint.h"

    20

#include "train.h"

    21

#include "water_map.h"

    22

#include "vehicle_gui.h"

    23

#include "timetable.h"

    24

#include "cargotype.h"

    25

#include "order.h"

    26

#include "strings_func.h"

    27

#include "window_func.h"

    28

#include "vehicle_func.h"

    29

#include "settings_type.h"

    31

    32

enum OrderWindowWidgets {

    33

	ORDER_WIDGET_CLOSEBOX = 0,

    34

	ORDER_WIDGET_CAPTION,

    35

	ORDER_WIDGET_TIMETABLE_VIEW,

    36

	ORDER_WIDGET_ORDER_LIST,

    37

	ORDER_WIDGET_SCROLLBAR,

    38

	ORDER_WIDGET_SKIP,

    39

	ORDER_WIDGET_DELETE,

    40

	ORDER_WIDGET_NON_STOP,

    41

	ORDER_WIDGET_GOTO,

    42

	ORDER_WIDGET_FULL_LOAD,

    43

	ORDER_WIDGET_UNLOAD,

    44

	ORDER_WIDGET_REFIT,

    45

	ORDER_WIDGET_TRANSFER,

    46

	ORDER_WIDGET_SHARED_ORDER_LIST,

    47

	ORDER_WIDGET_RESIZE_BAR,

    48

	ORDER_WIDGET_RESIZE,

    49

};

    50

    51

/**

    52

 * Return the memorised selected order.

    53

 *

    54

 * @param w current window

    55

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

    56

 *  else return the number of orders

    57

 */

    58

static int OrderGetSel(const Window *w)

    59

{

    60

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

    61

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

    62

    63

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

    64

}

    65

    66

/**

    67

 * Calculate the selected order.

    68

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

    69

 *  the position of the scrollbar.

    70

 *

    71

 * @param w current window

    72

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

    73

 * @param v current vehicle

    74

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

    75

 *  an invalid one has been selected.

    76

 */

    77

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

    78

{

    79

	/*

    80

	 * Calculation description:

    81

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

    82

	 * 10 = order text hight

    83

	 */

    84

	int sel = (y - 15) / 10;

    85

    86

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

    87

    88

	sel += w->vscroll.pos;

    89

    90

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

    91

}

    92

    93

static StringID StationOrderStrings[] = {

    94

	STR_8806_GO_TO,

    95

	STR_8807_GO_TO_TRANSFER,

    96

	STR_8808_GO_TO_UNLOAD,

    97

	STR_8809_GO_TO_TRANSFER_UNLOAD,

    98

	STR_880A_GO_TO_LOAD,

    99

	STR_880B_GO_TO_TRANSFER_LOAD,

   100

	STR_NULL,

   101

	STR_NULL,

   102

	STR_880C_GO_NON_STOP_TO,

   103

	STR_880D_GO_TO_NON_STOP_TRANSFER,

   104

	STR_880E_GO_NON_STOP_TO_UNLOAD,

   105

	STR_880F_GO_TO_NON_STOP_TRANSFER_UNLOAD,

   106

	STR_8810_GO_NON_STOP_TO_LOAD,

   107

	STR_8811_GO_TO_NON_STOP_TRANSFER_LOAD,

   108

	STR_NULL

   109

};

   110

   111

static void DrawOrdersWindow(Window *w)

   112

{

   113

	const Vehicle *v;

   114

	const Order *order;

   115

	StringID str;

   116

	int sel;

   117

	int y, i;

   118

	bool shared_orders;

   119

   120

	v = GetVehicle(w->window_number);

   121

   122

	shared_orders = IsOrderListShared(v);

   123

   124

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

   125

   126

	sel = OrderGetSel(w);

   127

	SetDParam(2, STR_8827_FULL_LOAD);

   128

   129

	order = GetVehicleOrder(v, sel);

   130

   131

	if (v->owner == _local_player) {

   132

		/* skip */

   133

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

   134

   135

		/* delete */

   136

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   137

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

   138

   139

		/* non-stop only for trains */

   140

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

   141

		w->SetWidgetDisabledState(ORDER_WIDGET_FULL_LOAD, order == NULL); // full load

   142

		w->SetWidgetDisabledState(ORDER_WIDGET_UNLOAD,    order == NULL); // unload

   143

		w->SetWidgetDisabledState(ORDER_WIDGET_TRANSFER,  order == NULL); // transfer

   144

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

   145

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

   146

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

   147

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   148

	} else {

   149

		w->DisableWidget(ORDER_WIDGET_TRANSFER);

   150

	}

   151

   152

	w->ShowWidget(ORDER_WIDGET_UNLOAD); // Unload

   153

   154

	if (order != NULL) {

   155

		switch (order->type) {

   156

			case OT_GOTO_STATION:

   157

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

   158

				/* Fall-through */

   159

   160

			case OT_GOTO_WAYPOINT:

   161

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   162

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   163

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   164

				break;

   165

   166

			case OT_GOTO_DEPOT:

   167

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   168

   169

				/* Remove unload and replace it with refit */

   170

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   171

				w->ShowWidget(ORDER_WIDGET_REFIT);

   172

				SetDParam(2,STR_SERVICE);

   173

				break;

   174

   175

			default: // every other orders

   176

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   177

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   178

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   179

		}

   180

	}

   181

   182

	SetDParam(0, v->index);

   183

	DrawWindowWidgets(w);

   184

   185

	y = 15;

   186

   187

	i = w->vscroll.pos;

   188

	order = GetVehicleOrder(v, i);

   189

	while (order != NULL) {

   190

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

   191

		SetDParam(3, STR_EMPTY);

   192

   193

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

   194

			SetDParam(1, 6);

   195

   196

			switch (order->type) {

   197

				case OT_DUMMY:

   198

					SetDParam(1, STR_INVALID_ORDER);

   199

					SetDParam(2, order->dest);

   200

					break;

   201

   202

				case OT_GOTO_STATION:

   203

					SetDParam(1, StationOrderStrings[order->flags]);

   204

					SetDParam(2, order->dest);

   205

					break;

   206

   207

				case OT_GOTO_DEPOT: {

   208

					StringID s = STR_NULL;

   209

   210

					if (v->type == VEH_AIRCRAFT) {

   211

						s = STR_GO_TO_AIRPORT_HANGAR;

   212

						SetDParam(2, order->dest);

   213

					} else {

   214

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

   215

   216

						switch (v->type) {

   217

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

   218

							case VEH_ROAD:  s = STR_9038_GO_TO_ROADVEH_DEPOT; break;

   219

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   220

							default: break;

   221

						}

   222

					}

   223

   224

					if (order->flags & OF_FULL_LOAD) s++; /* service at */

   225

   226

					SetDParam(1, s);

   227

					if (order->refit_cargo < NUM_CARGO) {

   228

						SetDParam(3, STR_REFIT_ORDER);

   229

						SetDParam(4, GetCargo(order->refit_cargo)->name);

   230

					} else {

   231

						SetDParam(3, STR_EMPTY);

   232

					}

   233

					break;

   234

				}

   235

   236

				case OT_GOTO_WAYPOINT:

   237

					SetDParam(1, (order->flags & OF_NON_STOP) ? STR_GO_NON_STOP_TO_WAYPOINT : STR_GO_TO_WAYPOINT);

   238

					SetDParam(2, order->dest);

   239

					break;

   240

   241

				default: break;

   242

			}

   243

   244

			SetDParam(0, i + 1);

   245

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

   246

   247

			y += 10;

   248

		}

   249

   250

		i++;

   251

		order = order->next;

   252

	}

   253

   254

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

   255

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   256

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

   257

	}

   258

}

   259

   260

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

   261

{

   262

	Order order;

   263

	order.next  = NULL;

   264

	order.index = 0;

   265

	order.refit_cargo   = CT_INVALID;

   266

	order.refit_subtype = 0;

   267

   268

	// check depot first

   269

	if (_patches.gotodepot) {

   270

		switch (GetTileType(tile)) {

   271

		case MP_RAILWAY:

   272

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

   273

				if (IsRailDepot(tile)) {

   274

					order.type = OT_GOTO_DEPOT;

   275

					order.flags = OF_PART_OF_ORDERS;

   276

					order.dest = GetDepotByTile(tile)->index;

   277

					return order;

   278

				}

   279

			}

   280

			break;

   281

   282

		case MP_ROAD:

   283

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

   284

				order.type = OT_GOTO_DEPOT;

   285

				order.flags = OF_PART_OF_ORDERS;

   286

				order.dest = GetDepotByTile(tile)->index;

   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.type = OT_GOTO_DEPOT;

   295

				order.flags = OF_PART_OF_ORDERS;

   296

				order.dest = GetStationIndex(tile);

   297

				return order;

   298

			}

   299

			break;

   300

   301

		case MP_WATER:

   302

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

   303

			if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   304

					IsTileOwner(tile, _local_player)) {

   305

				TileIndex tile2 = GetOtherShipDepotTile(tile);

   306

   307

				order.type = OT_GOTO_DEPOT;

   308

				order.flags = OF_PART_OF_ORDERS;

   309

				order.dest = GetDepotByTile(tile < tile2 ? tile : tile2)->index;

   310

				return order;

   311

			}

   312

   313

			default:

   314

				break;

   315

		}

   316

	}

   317

   318

	// check waypoint

   319

	if (IsTileType(tile, MP_RAILWAY) &&

   320

			v->type == VEH_TRAIN &&

   321

			IsTileOwner(tile, _local_player) &&

   322

			IsRailWaypoint(tile)) {

   323

		order.type = OT_GOTO_WAYPOINT;

   324

		order.flags = 0;

   325

		order.dest = GetWaypointByTile(tile)->index;

   326

		return order;

   327

	}

   328

   329

	if (IsTileType(tile, MP_STATION)) {

   330

		StationID st_index = GetStationIndex(tile);

   331

		const Station *st = GetStation(st_index);

   332

   333

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

   334

			byte facil;

   335

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

   336

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

   337

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

   338

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

   339

			(facil=FACIL_TRUCK_STOP, 1);

   340

			if (st->facilities & facil) {

   341

				order.type = OT_GOTO_STATION;

   342

				order.flags = 0;

   343

				order.dest = st_index;

   344

				return order;

   345

			}

   346

		}

   347

	}

   348

   349

	// not found

   350

	order.Free();

   351

	order.dest = INVALID_STATION;

   352

	return order;

   353

}

   354

   355

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

   356

{

   357

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

   358

   359

	if (!u->IsPrimaryVehicle()) {

   360

		u = u->First();

   361

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

   362

	}

   363

   364

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

   365

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

   366

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

   367

   368

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

   369

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

   370

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

   371

		ResetObjectToPlace();

   372

	}

   373

   374

	return true;

   375

}

   376

   377

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

   378

{

   379

	Order cmd;

   380

	const Vehicle *u;

   381

   382

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

   383

	u = CheckMouseOverVehicle();

   384

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

   385

   386

	cmd = GetOrderCmdFromTile(v, tile);

   387

	if (!cmd.IsValid()) return;

   388

   389

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

   390

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

   391

		ResetObjectToPlace();

   392

	}

   393

}

   394

   395

/**

   396

 * Handle the click on the goto button.

   397

 *

   398

 * @param w current window

   399

 * @param v current vehicle

   400

 */

   401

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

   402

{

   403

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   404

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   405

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   406

		_place_clicked_vehicle = NULL;

   407

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   408

	} else {

   409

		ResetObjectToPlace();

   410

	}

   411

}

   412

   413

/**

   414

 * Handle the click on the full load button.

   415

 *

   416

 * @param w current window

   417

 * @param v current vehicle

   418

 */

   419

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

   420

{

   421

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

   422

}

   423

   424

/**

   425

 * Handle the click on the unload button.

   426

 *

   427

 * @param w current window

   428

 * @param v current vehicle

   429

 */

   430

static void OrderClick_Unload(Window *w, const Vehicle *v)

   431

{

   432

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

   433

}

   434

   435

/**

   436

 * Handle the click on the nonstop button.

   437

 *

   438

 * @param w current window

   439

 * @param v current vehicle

   440

 */

   441

static void OrderClick_Nonstop(Window *w, const Vehicle *v)

   442

{

   443

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

   444

}

   445

   446

/**

   447

 * Handle the click on the transfer button.

   448

 *

   449

 * @param w current window

   450

 * @param v current vehicle

   451

 */

   452

static void OrderClick_Transfer(Window* w, const Vehicle* v)

   453

{

   454

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

   455

}

   456

   457

/**

   458

 * Handle the click on the skip button.

   459

 * If ctrl is pressed skip to selected order.

   460

 *  Else skip to current order + 1

   461

 *

   462

 * @param w current window

   463

 * @param v current vehicle

   464

 */

   465

static void OrderClick_Skip(Window *w, const Vehicle *v)

   466

{

   467

	/* Don't skip when there's nothing to skip */

   468

	if (_ctrl_pressed && v->cur_order_index == OrderGetSel(w)) return;

   469

   470

	DoCommandP(v->tile, v->index, _ctrl_pressed ? OrderGetSel(w) : ((v->cur_order_index + 1) % v->num_orders),

   471

			NULL, CMD_SKIP_TO_ORDER | CMD_MSG(_ctrl_pressed ? STR_CAN_T_SKIP_TO_ORDER : STR_CAN_T_SKIP_ORDER));

   472

}

   473

   474

/**

   475

 * Handle the click on the unload button.

   476

 *

   477

 * @param w current window

   478

 * @param v current vehicle

   479

 */

   480

static void OrderClick_Delete(Window *w, const Vehicle *v)

   481

{

   482

	DoCommandP(v->tile, v->index, OrderGetSel(w), NULL, CMD_DELETE_ORDER | CMD_MSG(STR_8834_CAN_T_DELETE_THIS_ORDER));

   483

}

   484

   485

/**