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 "functions.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "window.h"

    15

#include "gui.h"

    16

#include "gfx.h"

    17

#include "vehicle.h"

    18

#include "station.h"

    19

#include "town.h"

    20

#include "command.h"

    21

#include "viewport.h"

    22

#include "depot.h"

    23

#include "waypoint.h"

    24

#include "train.h"

    25

#include "water_map.h"

    26

#include "vehicle_gui.h"

    27

#include "cargotype.h"

    28

    29

enum OrderWindowWidgets {

    30

	ORDER_WIDGET_CLOSEBOX = 0,

    31

	ORDER_WIDGET_CAPTION,

    32

	ORDER_WIDGET_ORDER_LIST,

    33

	ORDER_WIDGET_SCROLLBAR,

    34

	ORDER_WIDGET_SKIP,

    35

	ORDER_WIDGET_DELETE,

    36

	ORDER_WIDGET_NON_STOP,

    37

	ORDER_WIDGET_GOTO,

    38

	ORDER_WIDGET_FULL_LOAD,

    39

	ORDER_WIDGET_UNLOAD,

    40

	ORDER_WIDGET_REFIT,

    41

	ORDER_WIDGET_TRANSFER,

    42

	ORDER_WIDGET_SHARED_ORDER_LIST,

    43

	ORDER_WIDGET_RESIZE_BAR,

    44

	ORDER_WIDGET_RESIZE,

    45

};

    46

    47

static int OrderGetSel(const Window *w)

    48

{

    49

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

    50

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

    51

    52

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

    53

}

    54

    55

static StringID StationOrderStrings[] = {

    56

	STR_8806_GO_TO,

    57

	STR_8807_GO_TO_TRANSFER,

    58

	STR_8808_GO_TO_UNLOAD,

    59

	STR_8809_GO_TO_TRANSFER_UNLOAD,

    60

	STR_880A_GO_TO_LOAD,

    61

	STR_880B_GO_TO_TRANSFER_LOAD,

    62

	STR_NULL,

    63

	STR_NULL,

    64

	STR_880C_GO_NON_STOP_TO,

    65

	STR_880D_GO_TO_NON_STOP_TRANSFER,

    66

	STR_880E_GO_NON_STOP_TO_UNLOAD,

    67

	STR_880F_GO_TO_NON_STOP_TRANSFER_UNLOAD,

    68

	STR_8810_GO_NON_STOP_TO_LOAD,

    69

	STR_8811_GO_TO_NON_STOP_TRANSFER_LOAD,

    70

	STR_NULL

    71

};

    72

    73

static void DrawOrdersWindow(Window *w)

    74

{

    75

	const Vehicle *v;

    76

	const Order *order;

    77

	StringID str;

    78

	int sel;

    79

	int y, i;

    80

	bool shared_orders;

    81

	byte color;

    82

    83

	v = GetVehicle(w->window_number);

    84

    85

	shared_orders = IsOrderListShared(v);

    86

    87

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

    88

    89

	sel = OrderGetSel(w);

    90

	SetDParam(2, STR_8827_FULL_LOAD);

    91

    92

	order = GetVehicleOrder(v, sel);

    93

    94

	if (v->owner == _local_player) {

    95

		/* skip */

    97

    98

		/* delete */

    99

		SetWindowWidgetDisabledState(w, ORDER_WIDGET_DELETE,

   100

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

   101

   102

		/* non-stop only for trains */

   103

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

   104

		SetWindowWidgetDisabledState(w, ORDER_WIDGET_FULL_LOAD, order == NULL); // full load

   105

		SetWindowWidgetDisabledState(w, ORDER_WIDGET_UNLOAD,    order == NULL); // unload

   106

		SetWindowWidgetDisabledState(w, ORDER_WIDGET_TRANSFER,  order == NULL); // transfer

   107

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

   108

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

   109

		SetWindowWidgetDisabledState(w, ORDER_WIDGET_REFIT,     order == NULL); // Refit

   110

		HideWindowWidget(w, ORDER_WIDGET_REFIT); // Refit

   111

	} else {

   112

		DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   113

	}

   114

   115

	ShowWindowWidget(w, ORDER_WIDGET_UNLOAD); // Unload

   116

   117

	if (order != NULL) {

   118

		switch (order->type) {

   119

			case OT_GOTO_STATION: break;

   120

   121

			case OT_GOTO_DEPOT:

   122

				DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   123

   124

				/* Remove unload and replace it with refit */

   125

				HideWindowWidget(w, ORDER_WIDGET_UNLOAD);

   126

				ShowWindowWidget(w, ORDER_WIDGET_REFIT);

   127

				SetDParam(2,STR_SERVICE);

   128

				break;

   129

   130

			case OT_GOTO_WAYPOINT:

   131

				DisableWindowWidget(w, ORDER_WIDGET_FULL_LOAD);

   132

				DisableWindowWidget(w, ORDER_WIDGET_UNLOAD);

   133

				DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   134

				break;

   135

   136

			default: // every other orders

   137

				DisableWindowWidget(w, ORDER_WIDGET_NON_STOP);

   138

				DisableWindowWidget(w, ORDER_WIDGET_FULL_LOAD);

   139

				DisableWindowWidget(w, ORDER_WIDGET_UNLOAD);

   140

		}

   141

	}

   142

   143

	SetDParam(0, v->string_id);

   144

	SetDParam(1, v->unitnumber);

   145

	DrawWindowWidgets(w);

   146

   147

	y = 15;

   148

   149

	i = w->vscroll.pos;

   150

	order = GetVehicleOrder(v, i);

   151

	while (order != NULL) {

   152

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

   153

		SetDParam(3, STR_EMPTY);

   154

   155

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

   156

			SetDParam(1, 6);

   157

   158

			switch (order->type) {

   159

				case OT_GOTO_STATION:

   160

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

   161

					SetDParam(2, order->dest);

   162

					break;

   163

   164

				case OT_GOTO_DEPOT: {

   165

					StringID s = STR_NULL;

   166

   167

					if (v->type == VEH_AIRCRAFT) {

   168

						s = STR_GO_TO_AIRPORT_HANGAR;

   169

						SetDParam(2, order->dest);

   170

					} else {

   171

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

   172

   173

						switch (v->type) {

   174

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

   175

							case VEH_ROAD:  s = STR_9038_GO_TO_ROADVEH_DEPOT; break;

   176

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   177

							default: break;

   178

						}

   179

					}

   180

   181

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

   182

   183

					SetDParam(1, s);

   184

					if (order->refit_cargo < NUM_CARGO) {

   185

						SetDParam(3, STR_REFIT_ORDER);

   186

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

   187

					} else {

   188

						SetDParam(3, STR_EMPTY);

   189

					}

   190

					break;

   191

				}

   192

   193

				case OT_GOTO_WAYPOINT:

   194

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

   195

					SetDParam(2, order->dest);

   196

					break;

   197

   198

				default: break;

   199

			}

   200

   201

			color = (i == WP(w,order_d).sel) ? 0xC : 0x10;

   202

			SetDParam(0, i + 1);

   203

			if (order->type != OT_DUMMY) {

   204

				DrawString(2, y, str, color);

   205

			} else {

   206

				SetDParam(1, STR_INVALID_ORDER);

   207

				SetDParam(2, order->dest);

   208

				DrawString(2, y, str, color);

   209

			}

   210

			y += 10;

   211

		}

   212

   213

		i++;

   214

		order = order->next;

   215

	}

   216

   217

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

   218

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   219

		color = (i == WP(w,order_d).sel) ? 0xC : 0x10;

   220

		DrawString(2, y, str, color);

   221

	}

   222

}

   223

   224

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

   225

{

   226

	Order order;

   227

	order.next  = NULL;

   228

	order.index = 0;

   229

	order.refit_cargo   = CT_INVALID;

   230

	order.refit_subtype = 0;

   231

   232

	// check depot first

   233

	if (_patches.gotodepot) {

   234

		switch (GetTileType(tile)) {

   235

		case MP_RAILWAY:

   236

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

   237

				if (IsRailDepot(tile)) {

   238

					order.type = OT_GOTO_DEPOT;

   239

					order.flags = OF_PART_OF_ORDERS;

   240

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

   241

					return order;

   242

				}

   243

			}

   244

			break;

   245

   246

		case MP_STREET:

   247

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

   248

				order.type = OT_GOTO_DEPOT;

   249

				order.flags = OF_PART_OF_ORDERS;

   250

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

   251

				return order;

   252

			}

   253

			break;

   254

   255

		case MP_STATION:

   256

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

   257

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

   258

				order.type = OT_GOTO_DEPOT;

   259

				order.flags = OF_PART_OF_ORDERS;

   260

				order.dest = GetStationIndex(tile);

   261

				return order;

   262

			}

   263

			break;

   264

   265

		case MP_WATER:

   266

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

   267

			if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   268

					IsTileOwner(tile, _local_player)) {

   269

				TileIndex tile2 = GetOtherShipDepotTile(tile);

   270

   271

				order.type = OT_GOTO_DEPOT;

   272

				order.flags = OF_PART_OF_ORDERS;

   273

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

   274

				return order;

   275

			}

   276

   277

			default:

   278

				break;

   279

		}

   280

	}

   281

   282

	// check waypoint

   283

	if (IsTileType(tile, MP_RAILWAY) &&

   284

			v->type == VEH_TRAIN &&

   285

			IsTileOwner(tile, _local_player) &&

   286

			IsRailWaypoint(tile)) {

   287

		order.type = OT_GOTO_WAYPOINT;

   288

		order.flags = 0;

   289

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

   290

		return order;

   291

	}

   292

   293

	if (IsTileType(tile, MP_STATION)) {

   294

		StationID st_index = GetStationIndex(tile);

   295

		const Station *st = GetStation(st_index);

   296

   297

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

   298

			byte facil;

   299

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

   300

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

   301

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

   302

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

   303

			(facil=FACIL_TRUCK_STOP, 1);

   304

			if (st->facilities & facil) {

   305

				order.type = OT_GOTO_STATION;

   306

				order.flags = 0;

   307

				order.dest = st_index;

   308

				return order;

   309

			}

   310

		}

   311

	}

   312

   313

	// not found

   314

	order.Free();

   315

	order.dest = INVALID_STATION;

   316

	return order;

   317

}

   318

   319

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

   320

{

   321

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

   322

   323

	if (u->HasFront() && !u->IsPrimaryVehicle()) {

   324

		u = GetFirstVehicleInChain(u);

   325

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

   326

	}

   327

   328

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

   329

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

   330

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

   331

   332

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

   333

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

   334

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

   335

		ResetObjectToPlace();

   336

	}

   337

   338

	return true;

   339

}

   340

   341

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

   342

{

   343

	Order cmd;

   344

	const Vehicle *u;

   345

   346

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

   347

	u = CheckMouseOverVehicle();

   348

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

   349

   350

	cmd = GetOrderCmdFromTile(v, tile);

   351

	if (!cmd.IsValid()) return;

   352

   353

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

   354

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

   355

		ResetObjectToPlace();

   356

	}

   357

}

   358

   359

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

   360

{

   361

	InvalidateWidget(w, ORDER_WIDGET_GOTO);

   362

	ToggleWidgetLoweredState(w, ORDER_WIDGET_GOTO);

   363

	if (IsWindowWidgetLowered(w, ORDER_WIDGET_GOTO)) {

   364

		_place_clicked_vehicle = NULL;

   365

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, 1, w);

   366

	} else {

   367

		ResetObjectToPlace();

   368

	}

   369

}

   370

   371

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

   372

{

   373

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

   374

}

   375

   376

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

   377

{

   378

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

   379

}

   380

   381

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

   382

{

   383

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

   384

}

   385

   386

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

   387

{

   388

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

   389

}

   390

   391

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

   392

{

   398

}

   399

   400

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

   401

{

   402

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

   403

}

   404

   405

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

   406

{

   407

	if (_ctrl_pressed) {

   408

		/* Cancel refitting */

   409

		DoCommandP(v->tile, v->index, (WP(w,order_d).sel << 16) | (CT_NO_REFIT << 8) | CT_NO_REFIT, NULL, CMD_ORDER_REFIT);

   410

	} else {

   411

		ShowVehicleRefitWindow(v, WP(w,order_d).sel);

   412

	}

   413

}

   414

   415

typedef void OnButtonVehClick(Window *w, const Vehicle *v);

   416

   417

static OnButtonVehClick* const _order_button_proc[] = {

   418

	OrderClick_Skip,

   419

	OrderClick_Delete,

   420

	OrderClick_Nonstop,

   421

	OrderClick_Goto,

   422

	OrderClick_FullLoad,

   423

	OrderClick_Unload,

   424

	OrderClick_Transfer

   425

};

   426

   427

static const uint16 _order_keycodes[] = {

   428

	'D', //skip order

   429

	'F', //delete order

   430

	'G', //non-stop

   431

	'H', //goto order

   432

	'J', //full load

   433

	'K'  //unload

   434

};

   435

   436

static void OrdersWndProc(Window *w, WindowEvent *e)

   437

{

   438

	switch (e->event) {

   439

		case WE_CREATE:

   440

			/* Ensure that the refit and unload buttons always remain at the same location.

   441

			 * Only one of them can be active at any one time and takes turns on being disabled.

   442

			 * To ensure that they stay at the same location, we also verify that they behave the same

   443

			 * when resizing. */

   444

			if (GetVehicle(w->window_number)->owner == _local_player) { // only the vehicle owner got these buttons

   445

				assert(w->widget[ORDER_WIDGET_REFIT].left          == w->widget[ORDER_WIDGET_UNLOAD].left);

   446

				assert(w->widget[ORDER_WIDGET_REFIT].right         == w->widget[ORDER_WIDGET_UNLOAD].right);

   447

				assert(w->widget[ORDER_WIDGET_REFIT].top           == w->widget[ORDER_WIDGET_UNLOAD].top);

   448

				assert(w->widget[ORDER_WIDGET_REFIT].bottom        == w->widget[ORDER_WIDGET_UNLOAD].bottom);

   449

				assert(w->widget[ORDER_WIDGET_REFIT].display_flags == w->widget[ORDER_WIDGET_UNLOAD].display_flags);

   450

			}

   451

			break;

   452

   453

	case WE_PAINT:

   454

		DrawOrdersWindow(w);

   455

		break;

   456

   457

	case WE_CLICK: {

   458

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

   459

		switch (e->we.click.widget) {

   460

		case ORDER_WIDGET_ORDER_LIST: {

   461

			int sel = (e->we.click.pt.y - 15) / 10;

   462

   463

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

   464

   465

			sel += w->vscroll.pos;

   466

   467

			if (_ctrl_pressed && sel < v->num_orders) {

   468

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

   469

				TileIndex xy;

   470

   471

				switch (ord->type) {

   472

					case OT_GOTO_STATION:  xy = GetStation(ord->dest)->xy ; break;

   473

					case OT_GOTO_DEPOT:    xy = (v->type == VEH_AIRCRAFT) ?  GetStation(ord->dest)->xy : GetDepot(ord->dest)->xy;    break;

   474

					case OT_GOTO_WAYPOINT: xy = GetWaypoint(ord->dest)->xy; break;

   475

					default:               xy = 0; break;

   476

				}

   477

   478

				if (xy != 0) ScrollMainWindowToTile(xy);

   479

				return;

   480

			}

   481

   482

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

   483

			WP(w,order_d).sel = sel;

   484

			SetWindowDirty(w);

   485

		} break;

   486