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_base.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 "strings_func.h"

    24

#include "window_func.h"

    25

#include "vehicle_func.h"

    26

#include "settings_type.h"

    27

#include "player_func.h"

    28

#include "newgrf_cargo.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 _station_order_strings[][7] = {

    95

	{

    96

		STR_8806_GO_TO,

    97

		STR_GO_TO_TRANSFER,

    98

		STR_8807_GO_TO_UNLOAD,

    99

		STR_GO_TO_TRANSFER_UNLOAD,

   100

		STR_8808_GO_TO_LOAD,

   101

		STR_GO_TO_TRANSFER_LOAD

   102

	}, {

   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

	}

   110

};

   111

   112

static void DrawOrdersWindow(Window *w)

   113

{

   116

   117

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

   118

   120

	SetDParam(2, STR_8827_FULL_LOAD);

   121

   123

   124

	if (v->owner == _local_player) {

   125

		/* skip */

   126

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

   127

   128

		/* delete */

   129

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   130

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

   131

   132

		/* non-stop only for trains */

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

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

   140

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   141

	} else {

   142

		w->DisableWidget(ORDER_WIDGET_TRANSFER);

   143

	}

   144

   145

	w->ShowWidget(ORDER_WIDGET_UNLOAD); // Unload

   146

   147

	if (order != NULL) {

   148

		switch (order->GetType()) {

   149

			case OT_GOTO_STATION:

   150

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

   151

				/* Fall-through */

   152

   153

			case OT_GOTO_WAYPOINT:

   154

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   155

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   156

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   157

				break;

   158

   159

			case OT_GOTO_DEPOT:

   160

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   161

   162

				/* Remove unload and replace it with refit */

   163

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   164

				w->ShowWidget(ORDER_WIDGET_REFIT);

   165

				SetDParam(2,STR_SERVICE);

   166

				break;

   167

   168

			default: // every other orders

   169

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   170

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   171

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   172

		}

   173

	}

   174

   175

	SetDParam(0, v->index);

   176

	DrawWindowWidgets(w);

   177

   179

   181

	order = GetVehicleOrder(v, i);

   183

	while (order != NULL) {

   184

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

   185

		SetDParam(3, STR_EMPTY);

   186

   187

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

   188

			SetDParam(1, 6);

   189

   190

			switch (order->GetType()) {

   191

				case OT_DUMMY:

   192

					SetDParam(1, STR_INVALID_ORDER);

   193

					SetDParam(2, order->GetDestination());

   194

					break;

   195

   196

				case OT_GOTO_STATION:

   197

					SetDParam(1, _station_order_strings[!(order->GetNonStopType() == (_patches.new_nonstop ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE))][order->GetLoadType() | order->GetUnloadType()]);

   198

					SetDParam(2, order->GetDestination());

   199

					break;

   200

   201

				case OT_GOTO_DEPOT: {

   202

					StringID s = STR_NULL;

   203

   204

					if (v->type == VEH_AIRCRAFT) {

   205

						s = STR_GO_TO_AIRPORT_HANGAR;

   206

						SetDParam(2, order->GetDestination());

   207

					} else {

   208

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

   209

   210

						switch (v->type) {

   211

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

   212

							case VEH_ROAD:  s = STR_GO_TO_ROADVEH_DEPOT; break;

   213

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   214

							default: break;

   215

						}

   216

					}

   217

   219

   220

					SetDParam(1, s);

   221

					if (order->IsRefit()) {

   222

						SetDParam(3, STR_REFIT_ORDER);

   223

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

   224

					} else {

   225

						SetDParam(3, STR_EMPTY);

   226

					}

   227

					break;

   228

				}

   229

   230

				case OT_GOTO_WAYPOINT:

   231

					SetDParam(1, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_GO_NON_STOP_TO_WAYPOINT : STR_GO_TO_WAYPOINT);

   232

					SetDParam(2, order->GetDestination());

   233

					break;

   234

   235

				default: break;

   236

			}

   237

   238

			SetDParam(0, i + 1);

   239

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

   240

   241

			y += 10;

   242

		}

   243

   244

		i++;

   245

		order = order->next;

   246

	}

   247

   248

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

   249

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   250

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

   251

	}

   252

}

   253

   254

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

   255

{

   256

	Order order;

   257

	order.next  = NULL;

   258

	order.index = 0;

   259

   261

	if (_patches.gotodepot) {

   262

		switch (GetTileType(tile)) {

   274

					order.MakeGoToDepot(GetDepotByTile(tile)->index, ODTFB_PART_OF_ORDERS);

   275

					return order;

   276

				}

   278

   286

   292

   296

   297

			default:

   298

				break;

   299

		}

   300

	}

   301

   303

	if (IsTileType(tile, MP_RAILWAY) &&

   304

			v->type == VEH_TRAIN &&

   305

			IsTileOwner(tile, _local_player) &&

   306

			IsRailWaypoint(tile)) {

   307

		order.MakeGoToWaypoint(GetWaypointByTile(tile)->index);

   308

		return order;

   309

	}

   310

   311

	if (IsTileType(tile, MP_STATION)) {

   312

		StationID st_index = GetStationIndex(tile);

   313

		const Station *st = GetStation(st_index);

   314

   315

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

   316

			byte facil;

   322

			if (st->facilities & facil) {

   323

				order.MakeGoToStation(st_index);

   324

				return order;

   325

			}

   326

		}

   327

	}

   328

   330

	order.Free();

   331

	return order;

   332

}

   333

   334

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

   335

{

   336

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

   337

   338

	if (!u->IsPrimaryVehicle()) {

   339

		u = u->First();

   340

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

   341

	}

   342

   345

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

   346

   347

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

   348

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

   349

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

   350

		ResetObjectToPlace();

   351

	}

   352

   353

	return true;

   354

}

   355

   356

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

   357

{

   360

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

   361

   363

	if (!cmd.IsValid()) return;

   364

   365

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

   366

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

   367

		ResetObjectToPlace();

   368

	}

   369

}

   370

   371

/**

   372

 * Handle the click on the goto button.

   373

 *

   374

 * @param w current window

   375

 * @param v current vehicle

   376

 */

   377

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

   378

{

   379

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   380

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   381

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   382

		_place_clicked_vehicle = NULL;

   383

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   384

	} else {

   385

		ResetObjectToPlace();

   386

	}

   387

}

   388

   389

/**

   390

 * Handle the click on the full load button.

   391

 *

   392

 * @param w current window

   393

 * @param v current vehicle

   394

 */

   395

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

   396

{

   397

	VehicleOrderID sel_ord = OrderGetSel(w);

   398

	const Order *order = GetVehicleOrder(v, sel_ord);

   399

   400

	if (order->IsType(OT_GOTO_STATION)) {

   401

		DoCommandP(v->tile, v->index + (sel_ord << 16), MOF_LOAD | (order->GetLoadType() ^ OLFB_FULL_LOAD) << 2, NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   402

	} else {

   403

		DoCommandP(v->tile, v->index + (sel_ord << 16), MOF_DEPOT_ACTION, NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   404

	}

   405

}

   406

   407

/**

   408

 * Handle the click on the unload button.

   409

 *

   410

 * @param w current window

   411

 * @param v current vehicle

   412

 */

   413

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

   414

{

   415

	VehicleOrderID sel_ord = OrderGetSel(w);

   416

	const Order *order = GetVehicleOrder(v, sel_ord);

   417

   418

	DoCommandP(v->tile, v->index + (sel_ord << 16), MOF_UNLOAD | (order->GetUnloadType() ^ OUFB_UNLOAD) << 2, NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   419

}

   420

   421

/**

   422

 * Handle the click on the nonstop button.

   423

 *

   424

 * @param w current window

   425

 * @param v current vehicle

   426

 */

   427

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

   428

{

   429

	VehicleOrderID sel_ord = OrderGetSel(w);

   430

	const Order *order = GetVehicleOrder(v, sel_ord);

   431

   432

	DoCommandP(v->tile, v->index + (sel_ord << 16), MOF_NON_STOP | ((order->GetNonStopType() == (_patches.new_nonstop ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE)) ? ONSF_NO_STOP_AT_ANY_STATION : ONSF_STOP_EVERYWHERE) << 2,  NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   433

}

   434

   435

/**

   436

 * Handle the click on the transfer button.

   437

 *

   438

 * @param w current window

   439

 * @param v current vehicle

   440

 */

   441

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

   442

{

   443

	VehicleOrderID sel_ord = OrderGetSel(w);

   444

	const Order *order = GetVehicleOrder(v, sel_ord);

   445

   446

	DoCommandP(v->tile, v->index + (sel_ord << 16), MOF_UNLOAD | (order->GetUnloadType() ^ OUFB_TRANSFER) << 2, NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   447

}

   448

   449

/**

   450

 * Handle the click on the skip button.

   451

 * If ctrl is pressed skip to selected order.

   452

 *  Else skip to current order + 1

   453

 *

   454

 * @param w current window

   455

 * @param v current vehicle

   456

 */

   457

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

   458

{

   459

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

   460

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

   461

   462

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

   463

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

   464

}

   465

   466

/**

   467

 * Handle the click on the unload button.

   468

 *

   469

 * @param w current window

   470

 * @param v current vehicle

   471

 */

   472

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

   473

{

   474

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

   475

}

   476

   477

/**

   478

 * Handle the click on the refit button.

   479

 * If ctrl is pressed cancel refitting.

   480

 *  Else show the refit window.

   481

 *

   482

 * @param w current window

   483

 * @param v current vehicle

   484

 */