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

/**

    48

 * Return the memorised selected order.

    49

 *

    50

 * @param w current window

    51

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

    52

 *  else return the number of orders

    53

 */

    54

static int OrderGetSel(const Window *w)

    55

{

    56

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

    57

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

    58

    59

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

    60

}

    61

    62

/**

    63

 * Calculate the selected order.

    64

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

    65

 *  the position of the scrollbar.

    66

 *

    67

 * @param w current window

    68

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

    69

 * @param v current vehicle

    70

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

    71

 *  an invalid one has been selected.

    72

 */

    73

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

    74

{

    75

	/*

    76

	 * Calculation description:

    77

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

    78

	 * 10 = order text hight

    79

	 */

    80

	int sel = (y - 15) / 10;

    81

    82

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

    83

    84

	sel += w->vscroll.pos;

    85

    86

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

    87

}

    88

    89

static StringID StationOrderStrings[] = {

    90

	STR_8806_GO_TO,

    91

	STR_8807_GO_TO_TRANSFER,

    92

	STR_8808_GO_TO_UNLOAD,

    93

	STR_8809_GO_TO_TRANSFER_UNLOAD,

    94

	STR_880A_GO_TO_LOAD,

    95

	STR_880B_GO_TO_TRANSFER_LOAD,

    96

	STR_NULL,

    97

	STR_NULL,

    98

	STR_880C_GO_NON_STOP_TO,

    99

	STR_880D_GO_TO_NON_STOP_TRANSFER,

   100

	STR_880E_GO_NON_STOP_TO_UNLOAD,

   101

	STR_880F_GO_TO_NON_STOP_TRANSFER_UNLOAD,

   102

	STR_8810_GO_NON_STOP_TO_LOAD,

   103

	STR_8811_GO_TO_NON_STOP_TRANSFER_LOAD,

   104

	STR_NULL

   105

};

   106

   107

static void DrawOrdersWindow(Window *w)

   108

{

   109

	const Vehicle *v;

   110

	const Order *order;

   111

	StringID str;

   112

	int sel;

   113

	int y, i;

   114

	bool shared_orders;

   115

	byte color;

   116

   117

	v = GetVehicle(w->window_number);

   118

   119

	shared_orders = IsOrderListShared(v);

   120

   121

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

   122

   123

	sel = OrderGetSel(w);

   124

	SetDParam(2, STR_8827_FULL_LOAD);

   125

   126

	order = GetVehicleOrder(v, sel);

   127

   128

	if (v->owner == _local_player) {

   129

		/* skip */

   130

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

   131

   132

		/* delete */

   133

		SetWindowWidgetDisabledState(w, ORDER_WIDGET_DELETE,

   134

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

   135

   136

		/* non-stop only for trains */

   137

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

   138

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

   139

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

   140

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

   141

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

   142

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

   143

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

   144

		HideWindowWidget(w, ORDER_WIDGET_REFIT); // Refit

   145

	} else {

   146

		DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   147

	}

   148

   149

	ShowWindowWidget(w, ORDER_WIDGET_UNLOAD); // Unload

   150

   151

	if (order != NULL) {

   152

		switch (order->type) {

   153

			case OT_GOTO_STATION: break;

   154

   155

			case OT_GOTO_DEPOT:

   156

				DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   157

   158

				/* Remove unload and replace it with refit */

   159

				HideWindowWidget(w, ORDER_WIDGET_UNLOAD);

   160

				ShowWindowWidget(w, ORDER_WIDGET_REFIT);

   161

				SetDParam(2,STR_SERVICE);

   162

				break;

   163

   164

			case OT_GOTO_WAYPOINT:

   165

				DisableWindowWidget(w, ORDER_WIDGET_FULL_LOAD);

   166

				DisableWindowWidget(w, ORDER_WIDGET_UNLOAD);

   167

				DisableWindowWidget(w, ORDER_WIDGET_TRANSFER);

   168

				break;

   169

   170

			default: // every other orders

   171

				DisableWindowWidget(w, ORDER_WIDGET_NON_STOP);

   172

				DisableWindowWidget(w, ORDER_WIDGET_FULL_LOAD);

   173

				DisableWindowWidget(w, ORDER_WIDGET_UNLOAD);

   174

		}

   175

	}

   176

   177

	SetDParam(0, v->string_id);

   178

	SetDParam(1, v->unitnumber);

   179

	DrawWindowWidgets(w);

   180

   181

	y = 15;

   182

   183

	i = w->vscroll.pos;

   184

	order = GetVehicleOrder(v, i);

   185

	while (order != NULL) {

   186

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

   187

		SetDParam(3, STR_EMPTY);

   188

   189

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

   190

			SetDParam(1, 6);

   191

   192

			switch (order->type) {

   193

				case OT_GOTO_STATION:

   194

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

   195

					SetDParam(2, order->dest);

   196

					break;

   197

   198

				case OT_GOTO_DEPOT: {

   199

					StringID s = STR_NULL;

   200

   201

					if (v->type == VEH_AIRCRAFT) {

   202

						s = STR_GO_TO_AIRPORT_HANGAR;

   203

						SetDParam(2, order->dest);

   204

					} else {

   205

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

   206

   207

						switch (v->type) {

   208

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

   209

							case VEH_ROAD:  s = STR_9038_GO_TO_ROADVEH_DEPOT; break;

   210

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   211

							default: break;

   212

						}

   213

					}

   214

   215

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

   216

   217

					SetDParam(1, s);

   218

					if (order->refit_cargo < NUM_CARGO) {

   219

						SetDParam(3, STR_REFIT_ORDER);

   220

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

   221

					} else {

   222

						SetDParam(3, STR_EMPTY);

   223

					}

   224

					break;

   225

				}

   226

   227

				case OT_GOTO_WAYPOINT:

   228

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

   229

					SetDParam(2, order->dest);

   230

					break;

   231

   232

				default: break;

   233

			}

   234

   235

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

   236

			SetDParam(0, i + 1);

   237

			if (order->type != OT_DUMMY) {

   238

				DrawString(2, y, str, color);

   239

			} else {

   240

				SetDParam(1, STR_INVALID_ORDER);

   241

				SetDParam(2, order->dest);

   242

				DrawString(2, y, str, color);

   243

			}

   244

			y += 10;

   245

		}

   246

   247

		i++;

   248

		order = order->next;

   249

	}

   250

   251

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

   252

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   253

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

   254

		DrawString(2, y, str, color);

   255

	}

   256

}

   257

   258

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

   259

{

   260

	Order order;

   261

	order.next  = NULL;

   262

	order.index = 0;

   263

	order.refit_cargo   = CT_INVALID;

   264

	order.refit_subtype = 0;

   265

   266

	// check depot first

   267

	if (_patches.gotodepot) {

   268

		switch (GetTileType(tile)) {

   269

		case MP_RAILWAY:

   270

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

   271

				if (IsRailDepot(tile)) {

   272

					order.type = OT_GOTO_DEPOT;

   273

					order.flags = OF_PART_OF_ORDERS;

   274

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

   275

					return order;

   276

				}

   277

			}

   278

			break;

   279

   280

		case MP_STREET:

   281

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

   282

				order.type = OT_GOTO_DEPOT;

   283

				order.flags = OF_PART_OF_ORDERS;

   284

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

   285

				return order;

   286

			}

   287

			break;

   288

   289

		case MP_STATION:

   290

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

   291

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

   292

				order.type = OT_GOTO_DEPOT;

   293

				order.flags = OF_PART_OF_ORDERS;

   294

				order.dest = GetStationIndex(tile);

   295

				return order;

   296

			}

   297

			break;

   298

   299

		case MP_WATER:

   300

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

   301

			if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   302

					IsTileOwner(tile, _local_player)) {

   303

				TileIndex tile2 = GetOtherShipDepotTile(tile);

   304

   305

				order.type = OT_GOTO_DEPOT;

   306

				order.flags = OF_PART_OF_ORDERS;

   307

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

   308

				return order;

   309

			}

   310

   311

			default:

   312

				break;

   313

		}

   314

	}

   315

   316

	// check waypoint

   317

	if (IsTileType(tile, MP_RAILWAY) &&

   318

			v->type == VEH_TRAIN &&

   319

			IsTileOwner(tile, _local_player) &&

   320

			IsRailWaypoint(tile)) {

   321

		order.type = OT_GOTO_WAYPOINT;

   322

		order.flags = 0;

   323

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

   324

		return order;

   325

	}

   326

   327

	if (IsTileType(tile, MP_STATION)) {

   328

		StationID st_index = GetStationIndex(tile);

   329

		const Station *st = GetStation(st_index);

   330

   331

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

   332

			byte facil;

   333

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

   334

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

   335

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

   336

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

   337

			(facil=FACIL_TRUCK_STOP, 1);

   338

			if (st->facilities & facil) {

   339

				order.type = OT_GOTO_STATION;

   340

				order.flags = 0;

   341

				order.dest = st_index;

   342

				return order;

   343

			}

   344

		}

   345

	}

   346

   347

	// not found

   348

	order.Free();

   349

	order.dest = INVALID_STATION;

   350

	return order;

   351

}

   352

   353

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

   354

{

   355

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

   356

   357

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

   358

		u = GetFirstVehicleInChain(u);

   359

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

   360

	}

   361

   362

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

   363

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

   364

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

   365

   366

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

   367

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

   368

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

   369

		ResetObjectToPlace();

   370

	}

   371

   372

	return true;

   373

}

   374

   375

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

   376

{

   377

	Order cmd;

   378

	const Vehicle *u;

   379

   380

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

   381

	u = CheckMouseOverVehicle();

   382

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

   383

   384

	cmd = GetOrderCmdFromTile(v, tile);

   385

	if (!cmd.IsValid()) return;

   386

   387

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

   388

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

   389

		ResetObjectToPlace();

   390

	}

   391

}

   392

   393

/**

   394

 * Handle the click on the goto button.

   395

 *

   396

 * @param w current window

   397

 * @param v current vehicle

   398

 */

   399

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

   400

{

   401

	InvalidateWidget(w, ORDER_WIDGET_GOTO);

   402

	ToggleWidgetLoweredState(w, ORDER_WIDGET_GOTO);

   403

	if (IsWindowWidgetLowered(w, ORDER_WIDGET_GOTO)) {

   404

		_place_clicked_vehicle = NULL;

   405

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, 1, w);

   406

	} else {

   407

		ResetObjectToPlace();

   408

	}

   409

}

   410

   411

/**

   412

 * Handle the click on the full load button.

   413

 *

   414

 * @param w current window

   415

 * @param v current vehicle

   416

 */

   417

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

   418

{

   419

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

   420

}

   421

   422

/**

   423

 * Handle the click on the unload button.

   424

 *

   425

 * @param w current window

   426

 * @param v current vehicle

   427

 */

   428

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

   429

{

   430

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

   431

}

   432

   433

/**

   434

 * Handle the click on the nonstop button.

   435

 *

   436

 * @param w current window

   437

 * @param v current vehicle

   438

 */

   439

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

   440

{

   441

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

   442

}

   443

   444

/**

   445

 * Handle the click on the transfer button.

   446

 *

   447

 * @param w current window

   448

 * @param v current vehicle

   449

 */

   450

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

   451

{

   452

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

   453

}

   454

   455

/**

   456

 * Handle the click on the skip button.

   457

 * If ctrl is pressed skip to selected order.

   458

 *  Else skip to current order + 1

   459

 *

   460

 * @param w current window

   461

 * @param v current vehicle

   462

 */

   463

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

   464

{

   465

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

   466

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

   467

   468

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

   469

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

   470

}

   471

   472

/**

   473

 * Handle the click on the unload button.

   474

 *

   475

 * @param w current window

   476

 * @param v current vehicle

   477

 */

   478

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

   479

{

   480

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

   481

}

   482

   483

/**

   484

 * Handle the click on the refit button.

   485

 * If ctrl is pressed cancel refitting.

   486

 *  Else show the refit window.

   487

 *