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

    12

#include "functions.h"

    13

#include "map.h"

    14

#include "tile.h"

    15

#include "window.h"

    16

#include "gui.h"

    17

#include "gfx.h"

    18

#include "vehicle.h"

    19

#include "station.h"

    20

#include "town.h"

    21

#include "command.h"

    22

#include "viewport.h"

    23

#include "depot.h"

    24

#include "waypoint.h"

    25

#include "train.h"

    26

#include "water_map.h"

    27

#include "vehicle_gui.h"

    28

#include "timetable.h"

    29

#include "cargotype.h"

    30

    31

enum OrderWindowWidgets {

    32

	ORDER_WIDGET_CLOSEBOX = 0,

    33

	ORDER_WIDGET_CAPTION,

    34

	ORDER_WIDGET_TIMETABLE_VIEW,

    35

	ORDER_WIDGET_ORDER_LIST,

    36

	ORDER_WIDGET_SCROLLBAR,

    37

	ORDER_WIDGET_SKIP,

    38

	ORDER_WIDGET_DELETE,

    39

	ORDER_WIDGET_NON_STOP,

    40

	ORDER_WIDGET_GOTO,

    41

	ORDER_WIDGET_FULL_LOAD,

    42

	ORDER_WIDGET_UNLOAD,

    43

	ORDER_WIDGET_REFIT,

    44

	ORDER_WIDGET_TRANSFER,

    45

	ORDER_WIDGET_SHARED_ORDER_LIST,

    46

	ORDER_WIDGET_RESIZE_BAR,

    47

	ORDER_WIDGET_RESIZE,

    48

};

    49

    50

/**

    51

 * Return the memorised selected order.

    52

 *

    53

 * @param w current window

    54

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

    55

 *  else return the number of orders

    56

 */

    57

static int OrderGetSel(const Window *w)

    58

{

    59

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

    60

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

    61

    62

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

    63

}

    64

    65

/**

    66

 * Calculate the selected order.

    67

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

    68

 *  the position of the scrollbar.

    69

 *

    70

 * @param w current window

    71

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

    72

 * @param v current vehicle

    73

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

    74

 *  an invalid one has been selected.

    75

 */

    76

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

    77

{

    78

	/*

    79

	 * Calculation description:

    80

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

    81

	 * 10 = order text hight

    82

	 */

    83

	int sel = (y - 15) / 10;

    84

    85

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

    86

    87

	sel += w->vscroll.pos;

    88

    89

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

    90

}

    91

    92

static StringID StationOrderStrings[] = {

    93

	STR_8806_GO_TO,

    94

	STR_8807_GO_TO_TRANSFER,

    95

	STR_8808_GO_TO_UNLOAD,

    96

	STR_8809_GO_TO_TRANSFER_UNLOAD,

    97

	STR_880A_GO_TO_LOAD,

    98

	STR_880B_GO_TO_TRANSFER_LOAD,

    99

	STR_NULL,

   100

	STR_NULL,

   101

	STR_880C_GO_NON_STOP_TO,

   102

	STR_880D_GO_TO_NON_STOP_TRANSFER,

   103

	STR_880E_GO_NON_STOP_TO_UNLOAD,

   104

	STR_880F_GO_TO_NON_STOP_TRANSFER_UNLOAD,

   105

	STR_8810_GO_NON_STOP_TO_LOAD,

   106

	STR_8811_GO_TO_NON_STOP_TRANSFER_LOAD,

   107

	STR_NULL

   108

};

   109

   110

static void DrawOrdersWindow(Window *w)

   111

{

   112

	const Vehicle *v;

   113

	const Order *order;

   114

	StringID str;

   115

	int sel;

   116

	int y, i;

   117

	bool shared_orders;

   118

   119

	v = GetVehicle(w->window_number);

   120

   121

	shared_orders = IsOrderListShared(v);

   122

   123

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

   124

   125

	sel = OrderGetSel(w);

   126

	SetDParam(2, STR_8827_FULL_LOAD);

   127

   128

	order = GetVehicleOrder(v, sel);

   129

   130

	if (v->owner == _local_player) {

   131

		/* skip */

   132

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

   133

   134

		/* delete */

   135

		SetWindowWidgetDisabledState(w, ORDER_WIDGET_DELETE,

   136

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

   137

   138

		/* non-stop only for trains */

   139

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

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   146

		HideWindowWidget(w, ORDER_WIDGET_REFIT); // Refit

   147

	} else {

   148

		DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   149

	}

   150

   151

	ShowWindowWidget(w, ORDER_WIDGET_UNLOAD); // Unload

   152

   153

	if (order != NULL) {

   154

		switch (order->type) {

   155

			case OT_GOTO_STATION: break;

   156

   157

			case OT_GOTO_DEPOT:

   158

				DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   159

   160

				/* Remove unload and replace it with refit */

   161

				HideWindowWidget(w, ORDER_WIDGET_UNLOAD);

   162

				ShowWindowWidget(w, ORDER_WIDGET_REFIT);

   163

				SetDParam(2,STR_SERVICE);

   164

				break;

   165

   166

			case OT_GOTO_WAYPOINT:

   167

				DisableWindowWidget(w, ORDER_WIDGET_FULL_LOAD);

   168

				DisableWindowWidget(w, ORDER_WIDGET_UNLOAD);

   169

				DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   170

				break;

   171

   172

			default: // every other orders

   173

				DisableWindowWidget(w, ORDER_WIDGET_NON_STOP);

   174

				DisableWindowWidget(w, ORDER_WIDGET_FULL_LOAD);

   175

				DisableWindowWidget(w, ORDER_WIDGET_UNLOAD);

   176

		}

   177

	}

   178

   179

	SetDParam(0, v->index);

   180

	DrawWindowWidgets(w);

   181

   182

	y = 15;

   183

   184

	i = w->vscroll.pos;

   185

	order = GetVehicleOrder(v, i);

   186

	while (order != NULL) {

   187

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

   188

		SetDParam(3, STR_EMPTY);

   189

   190

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

   191

			SetDParam(1, 6);

   192

   193

			switch (order->type) {

   194

				case OT_DUMMY:

   195

					SetDParam(1, STR_INVALID_ORDER);

   196

					SetDParam(2, order->dest);

   197

					break;

   198

   199

				case OT_GOTO_STATION:

   200

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

   201

					SetDParam(2, order->dest);

   202

					break;

   203

   204

				case OT_GOTO_DEPOT: {

   205

					StringID s = STR_NULL;

   206

   207

					if (v->type == VEH_AIRCRAFT) {

   208

						s = STR_GO_TO_AIRPORT_HANGAR;

   209

						SetDParam(2, order->dest);

   210

					} else {

   211

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

   212

   213

						switch (v->type) {

   214

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

   215

							case VEH_ROAD:  s = STR_9038_GO_TO_ROADVEH_DEPOT; break;

   216

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   217

							default: break;

   218

						}

   219

					}

   220

   221

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

   222

   223

					SetDParam(1, s);

   224

					if (order->refit_cargo < NUM_CARGO) {

   225

						SetDParam(3, STR_REFIT_ORDER);

   226

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

   227

					} else {

   228

						SetDParam(3, STR_EMPTY);

   229

					}

   230

					break;

   231

				}

   232

   233

				case OT_GOTO_WAYPOINT:

   234

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

   235

					SetDParam(2, order->dest);

   236

					break;

   237

   238

				default: break;

   239

			}

   240

   241

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

   242

			SetDParam(0, i + 1);

   243

			DrawString(2, y, str, colour);

   244

   245

			y += 10;

   246

		}

   247

   248

		i++;

   249

		order = order->next;

   250

	}

   251

   252

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

   253

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   254

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

   255

		DrawString(2, y, str, colour);

   256

	}

   257

}

   258

   259

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

   260

{

   261

	Order order;

   262

	order.next  = NULL;

   263

	order.index = 0;

   264

	order.refit_cargo   = CT_INVALID;

   265

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

   274

					order.flags = OF_PART_OF_ORDERS;

   275

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

   276

					return order;

   277

				}

   278

			}

   279

			break;

   280

   281

		case MP_ROAD:

   282

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

   283

				order.type = OT_GOTO_DEPOT;

   284

				order.flags = OF_PART_OF_ORDERS;

   285

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

   286

				return order;

   287

			}

   288

			break;

   289

   290

		case MP_STATION:

   291

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

   292

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

   293

				order.type = OT_GOTO_DEPOT;

   294

				order.flags = OF_PART_OF_ORDERS;

   295

				order.dest = GetStationIndex(tile);

   296

				return order;

   297

			}

   298

			break;

   299

   300

		case MP_WATER:

   301

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

   302

			if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   303

					IsTileOwner(tile, _local_player)) {

   304

				TileIndex tile2 = GetOtherShipDepotTile(tile);

   305

   306

				order.type = OT_GOTO_DEPOT;

   307

				order.flags = OF_PART_OF_ORDERS;

   308

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

   309

				return order;

   310

			}

   311

   312

			default:

   313

				break;

   314

		}

   315

	}

   316

   317

	// check waypoint

   318

	if (IsTileType(tile, MP_RAILWAY) &&

   319

			v->type == VEH_TRAIN &&

   320

			IsTileOwner(tile, _local_player) &&

   321

			IsRailWaypoint(tile)) {

   322

		order.type = OT_GOTO_WAYPOINT;

   323

		order.flags = 0;

   324

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

   325

		return order;

   326

	}

   327

   328

	if (IsTileType(tile, MP_STATION)) {

   329

		StationID st_index = GetStationIndex(tile);

   330

		const Station *st = GetStation(st_index);

   331

   332

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

   333

			byte facil;

   334

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

   335

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

   336

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

   337

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

   338

			(facil=FACIL_TRUCK_STOP, 1);

   339

			if (st->facilities & facil) {

   340

				order.type = OT_GOTO_STATION;

   341

				order.flags = 0;

   342

				order.dest = st_index;

   343

				return order;

   344

			}

   345

		}

   346

	}

   347

   348

	// not found

   349

	order.Free();

   350

	order.dest = INVALID_STATION;

   351

	return order;

   352

}

   353

   354

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

   355

{

   356

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

   357

   358

	if (!u->IsPrimaryVehicle()) {

   359

		u = u->First();

   360

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

   361

	}

   362

   363

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

   364

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

   365

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

   366

   367

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

   368

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

   369

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

   370

		ResetObjectToPlace();

   371

	}

   372

   373

	return true;

   374

}

   375

   376

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

   377

{

   378

	Order cmd;

   379

	const Vehicle *u;

   380

   381

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

   382

	u = CheckMouseOverVehicle();

   383

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

   384

   385

	cmd = GetOrderCmdFromTile(v, tile);

   386

	if (!cmd.IsValid()) return;

   387

   388

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

   389

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

   390

		ResetObjectToPlace();

   391

	}

   392

}

   393

   394

/**

   395

 * Handle the click on the goto button.

   396

 *

   397

 * @param w current window

   398

 * @param v current vehicle

   399

 */

   400

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

   401

{

   402

	InvalidateWidget(w, ORDER_WIDGET_GOTO);

   403

	ToggleWidgetLoweredState(w, ORDER_WIDGET_GOTO);

   404

	if (IsWindowWidgetLowered(w, ORDER_WIDGET_GOTO)) {

   405

		_place_clicked_vehicle = NULL;

   406

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, 1, w);

   407

	} else {

   408

		ResetObjectToPlace();

   409

	}

   410

}

   411

   412

/**

   413

 * Handle the click on the full load button.

   414

 *

   415

 * @param w current window

   416

 * @param v current vehicle

   417

 */

   418

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

   419

{

   420

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

   421

}

   422

   423

/**

   424

 * Handle the click on the unload button.

   425

 *

   426

 * @param w current window

   427

 * @param v current vehicle

   428

 */

   429

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

   430

{

   431

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

   432

}

   433

   434

/**

   435

 * Handle the click on the nonstop button.

   436

 *

   437

 * @param w current window

   438

 * @param v current vehicle

   439

 */

   440

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

   441

{

   442

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

   443

}

   444

   445

/**

   446

 * Handle the click on the transfer button.

   447

 *

   448

 * @param w current window

   449

 * @param v current vehicle

   450

 */

   451

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

   452

{

   453

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

   454

}

   455

   456

/**

   457

 * Handle the click on the skip button.

   458

 * If ctrl is pressed skip to selected order.

   459

 *  Else skip to current order + 1

   460

 *

   461

 * @param w current window

   462

 * @param v current vehicle

   463

 */

   464

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

   465

{

   466

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

   467

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

   468

   469

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

   470

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

   471

}

   472

   473

/**

   474

 * Handle the click on the unload button.

   475

 *

   476

 * @param w current window

   477

 * @param v current vehicle

   478

 */

   479

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

   480

{

   481

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

   482

}

   483

   484

/**

   485

 * Handle the click on the refit button.

   486

 * If ctrl is pressed cancel refitting.