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

    24

#include "strings_func.h"

    25

#include "window_func.h"

    26

#include "vehicle_func.h"

    27

#include "settings_type.h"

    28

#include "player_func.h"

    29

    30

#include "table/sprites.h"

    31

#include "table/strings.h"

    32

    33

enum OrderWindowWidgets {

    34

	ORDER_WIDGET_CLOSEBOX = 0,

    35

	ORDER_WIDGET_CAPTION,

    36

	ORDER_WIDGET_TIMETABLE_VIEW,

    37

	ORDER_WIDGET_ORDER_LIST,

    38

	ORDER_WIDGET_SCROLLBAR,

    39

	ORDER_WIDGET_SKIP,

    40

	ORDER_WIDGET_DELETE,

    41

	ORDER_WIDGET_NON_STOP,

    42

	ORDER_WIDGET_GOTO,

    43

	ORDER_WIDGET_FULL_LOAD,

    44

	ORDER_WIDGET_UNLOAD,

    45

	ORDER_WIDGET_REFIT,

    46

	ORDER_WIDGET_TRANSFER,

    47

	ORDER_WIDGET_SHARED_ORDER_LIST,

    48

	ORDER_WIDGET_RESIZE_BAR,

    49

	ORDER_WIDGET_RESIZE,

    50

};

    51

    52

/**

    53

 * Return the memorised selected order.

    54

 *

    55

 * @param w current window

    56

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

    57

 *  else return the number of orders

    58

 */

    59

static int OrderGetSel(const Window *w)

    60

{

    61

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

    62

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

    63

    64

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

    65

}

    66

    67

/**

    68

 * Calculate the selected order.

    69

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

    70

 *  the position of the scrollbar.

    71

 *

    72

 * @param w current window

    73

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

    74

 * @param v current vehicle

    75

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

    76

 *  an invalid one has been selected.

    77

 */

    78

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

    79

{

    80

	/*

    81

	 * Calculation description:

    82

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

    83

	 * 10 = order text hight

    84

	 */

    85

	int sel = (y - 15) / 10;

    86

    87

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

    88

    89

	sel += w->vscroll.pos;

    90

    91

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

    92

}

    93

    94

static StringID StationOrderStrings[] = {

    95

	STR_8806_GO_TO,

    96

	STR_GO_TO_TRANSFER,

    97

	STR_8807_GO_TO_UNLOAD,

    98

	STR_GO_TO_TRANSFER_UNLOAD,

    99

	STR_8808_GO_TO_LOAD,

   100

	STR_GO_TO_TRANSFER_LOAD,

   101

	STR_NULL,

   102

	STR_NULL,

   103

	STR_880A_GO_NON_STOP_TO,

   104

	STR_GO_TO_NON_STOP_TRANSFER,

   105

	STR_880B_GO_NON_STOP_TO_UNLOAD,

   106

	STR_GO_TO_NON_STOP_TRANSFER_UNLOAD,

   107

	STR_880C_GO_NON_STOP_TO_LOAD,

   108

	STR_GO_TO_NON_STOP_TRANSFER_LOAD,

   109

	STR_NULL

   110

};

   111

   112

static void DrawOrdersWindow(Window *w)

   113

{

   114

	const Vehicle *v;

   115

	const Order *order;

   116

	StringID str;

   117

	int sel;

   118

	int y, i;

   119

	bool shared_orders;

   120

   121

	v = GetVehicle(w->window_number);

   122

   123

	shared_orders = v->IsOrderListShared();

   124

   125

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

   126

   127

	sel = OrderGetSel(w);

   128

	SetDParam(2, STR_8827_FULL_LOAD);

   129

   130

	order = GetVehicleOrder(v, sel);

   131

   132

	if (v->owner == _local_player) {

   133

		/* skip */

   134

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

   135

   136

		/* delete */

   137

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   138

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

   139

   140

		/* non-stop only for trains */

   141

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

   142

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

   143

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

   144

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

   145

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

   146

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

   147

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

   148

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   149

	} else {

   150

		w->DisableWidget(ORDER_WIDGET_TRANSFER);

   151

	}

   152

   153

	w->ShowWidget(ORDER_WIDGET_UNLOAD); // Unload

   154

   155

	if (order != NULL) {

   156

		switch (order->type) {

   157

			case OT_GOTO_STATION:

   158

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

   159

				/* Fall-through */

   160

   161

			case OT_GOTO_WAYPOINT:

   162

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   163

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   164

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   165

				break;

   166

   167

			case OT_GOTO_DEPOT:

   168

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   169

   170

				/* Remove unload and replace it with refit */

   171

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   172

				w->ShowWidget(ORDER_WIDGET_REFIT);

   173

				SetDParam(2,STR_SERVICE);

   174

				break;

   175

   176

			default: // every other orders

   177

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   178

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   179

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   180

		}

   181

	}

   182

   183

	SetDParam(0, v->index);

   184

	DrawWindowWidgets(w);

   185

   186

	y = 15;

   187

   188

	i = w->vscroll.pos;

   189

	order = GetVehicleOrder(v, i);

   190

	while (order != NULL) {

   191

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

   192

		SetDParam(3, STR_EMPTY);

   193

   194

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

   195

			SetDParam(1, 6);

   196

   197

			switch (order->type) {

   198

				case OT_DUMMY:

   199

					SetDParam(1, STR_INVALID_ORDER);

   200

					SetDParam(2, order->dest);

   201

					break;

   202

   203

				case OT_GOTO_STATION:

   204

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

   205

					SetDParam(2, order->dest);

   206

					break;

   207

   208

				case OT_GOTO_DEPOT: {

   209

					StringID s = STR_NULL;

   210

   211

					if (v->type == VEH_AIRCRAFT) {

   212

						s = STR_GO_TO_AIRPORT_HANGAR;

   213

						SetDParam(2, order->dest);

   214

					} else {

   215

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

   216

   217

						switch (v->type) {

   218

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

   219

							case VEH_ROAD:  s = STR_GO_TO_ROADVEH_DEPOT; break;

   220

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   221

							default: break;

   222

						}

   223

					}

   224

   225

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

   226

   227

					SetDParam(1, s);

   228

					if (order->refit_cargo < NUM_CARGO) {

   229

						SetDParam(3, STR_REFIT_ORDER);

   230

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

   231

					} else {

   232

						SetDParam(3, STR_EMPTY);

   233

					}

   234

					break;

   235

				}

   236

   237

				case OT_GOTO_WAYPOINT:

   238

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

   239

					SetDParam(2, order->dest);

   240

					break;

   241

   242

				default: break;

   243

			}

   244

   245

			SetDParam(0, i + 1);

   246

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

   247

   248

			y += 10;

   249

		}

   250

   251

		i++;

   252

		order = order->next;

   253

	}

   254

   255

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

   256

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   257

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

   258

	}

   259

}

   260

   261

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

   262

{

   263

	Order order;

   264

	order.next  = NULL;

   265

	order.index = 0;

   266

	order.refit_cargo   = CT_INVALID;

   267

	order.refit_subtype = 0;

   268

   269

	// check depot first

   270

	if (_patches.gotodepot) {

   271

		switch (GetTileType(tile)) {

   272

		case MP_RAILWAY:

   273

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

   274

				if (IsRailDepot(tile)) {

   275

					order.type = OT_GOTO_DEPOT;

   276

					order.flags = OFB_PART_OF_ORDERS;

   277

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

   278

					return order;

   279

				}

   280

			}

   281

			break;

   282

   283

		case MP_ROAD:

   285

				order.type = OT_GOTO_DEPOT;

   286

				order.flags = OFB_PART_OF_ORDERS;

   287

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

   288

				return order;

   289

			}

   290

			break;

   291

   292

		case MP_STATION:

   293

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

   294

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

   295

				order.type = OT_GOTO_DEPOT;

   296

				order.flags = OFB_PART_OF_ORDERS;

   297

				order.dest = GetStationIndex(tile);

   298

				return order;

   299

			}

   300

			break;

   301

   302

		case MP_WATER:

   303

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

   304

			if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   305

					IsTileOwner(tile, _local_player)) {

   306

				TileIndex tile2 = GetOtherShipDepotTile(tile);

   307

   308

				order.type = OT_GOTO_DEPOT;

   309

				order.flags = OFB_PART_OF_ORDERS;

   310

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

   311

				return order;

   312

			}

   313

   314

			default:

   315

				break;

   316

		}

   317

	}

   318

   319

	// check waypoint

   320

	if (IsTileType(tile, MP_RAILWAY) &&

   321

			v->type == VEH_TRAIN &&

   322

			IsTileOwner(tile, _local_player) &&

   323

			IsRailWaypoint(tile)) {

   324

		order.type = OT_GOTO_WAYPOINT;

   325

		order.flags = 0;

   326

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

   327

		return order;

   328

	}

   329

   330

	if (IsTileType(tile, MP_STATION)) {

   331

		StationID st_index = GetStationIndex(tile);

   332

		const Station *st = GetStation(st_index);

   333

   334

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

   335

			byte facil;

   336

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

   337

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

   338

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

   339

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

   340

			(facil=FACIL_TRUCK_STOP, 1);

   341

			if (st->facilities & facil) {

   342

				order.type = OT_GOTO_STATION;

   343

				order.flags = 0;

   344

				order.dest = st_index;

   345

				return order;

   346

			}

   347

		}

   348

	}

   349

   350

	// not found

   351

	order.Free();

   352

	order.dest = INVALID_STATION;

   353

	return order;

   354

}

   355

   356

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

   357

{

   358

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

   359

   360

	if (!u->IsPrimaryVehicle()) {

   361

		u = u->First();

   362

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

   363

	}

   364

   365

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

   366

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

   367

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

   368

   369

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

   370

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

   371

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

   372

		ResetObjectToPlace();

   373

	}

   374

   375

	return true;

   376

}

   377

   378

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

   379

{

   380

	Order cmd;

   381

	const Vehicle *u;

   382

   383

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

   384

	u = CheckMouseOverVehicle();

   385

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

   386

   387

	cmd = GetOrderCmdFromTile(v, tile);

   388

	if (!cmd.IsValid()) return;

   389

   390

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

   391

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

   392

		ResetObjectToPlace();

   393

	}

   394

}

   395

   396

/**

   397

 * Handle the click on the goto button.

   398

 *

   399

 * @param w current window

   400

 * @param v current vehicle

   401

 */

   402

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

   403

{

   404

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   405

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   406

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   407

		_place_clicked_vehicle = NULL;

   408

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   409

	} else {

   410

		ResetObjectToPlace();

   411

	}

   412

}

   413

   414

/**

   415

 * Handle the click on the full load button.

   416

 *

   417

 * @param w current window

   418

 * @param v current vehicle

   419

 */

   420

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

   421

{

   422

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

   423

}

   424

   425

/**

   426

 * Handle the click on the unload button.

   427

 *

   428

 * @param w current window

   429

 * @param v current vehicle

   430

 */

   431

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

   432

{

   433

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

   434

}

   435

   436

/**

   437

 * Handle the click on the nonstop button.

   438

 *

   439

 * @param w current window

   440

 * @param v current vehicle

   441

 */

   442

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

   443

{

   444

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

   445

}

   446

   447

/**

   448

 * Handle the click on the transfer button.

   449

 *

   450

 * @param w current window

   451

 * @param v current vehicle

   452

 */

   453

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

   454

{

   455

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

   456

}

   457

   458

/**

   459

 * Handle the click on the skip button.

   460

 * If ctrl is pressed skip to selected order.

   461

 *  Else skip to current order + 1

   462

 *

   463

 * @param w current window

   464

 * @param v current vehicle

   465

 */

   466

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

   467

{

   468

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

   469

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

   470

   471

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

   472

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

   473

}

   474

   475

/**

   476

 * Handle the click on the unload button.

   477

 *

   478

 * @param w current window

   479

 * @param v current vehicle

   480

 */

   481

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

   482

{

   483

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

   484

}