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_SERVICE,

    48

	ORDER_WIDGET_RESIZE_BAR,

    49

	ORDER_WIDGET_SHARED_ORDER_LIST,

    50

	ORDER_WIDGET_RESIZE,

    51

};

    52

    53

/**

    54

 * Return the memorised selected order.

    55

 *

    56

 * @param w current window

    57

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

    58

 *  else return the number of orders

    59

 */

    60

static int OrderGetSel(const Window *w)

    61

{

    62

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

    63

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

    64

    65

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

    66

}

    67

    68

/**

    69

 * Calculate the selected order.

    70

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

    71

 *  the position of the scrollbar.

    72

 *

    73

 * @param w current window

    74

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

    75

 * @param v current vehicle

    76

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

    77

 *  an invalid one has been selected.

    78

 */

    79

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

    80

{

    81

	/*

    82

	 * Calculation description:

    83

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

    84

	 * 10 = order text hight

    85

	 */

    86

	int sel = (y - 15) / 10;

    87

    88

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

    89

    90

	sel += w->vscroll.pos;

    91

    92

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

    93

}

    94

    97

	{

   103

	}, {

   109

	}

   110

};

   111

   112

static void DrawOrdersWindow(Window *w)

   113

{

   114

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

   115

	bool shared_orders = v->IsOrderListShared();

   116

   117

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

   118

   119

	int sel = OrderGetSel(w);

   120

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

   121

   122

	if (v->owner == _local_player) {

   123

		/* skip */

   124

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

   125

   126

		/* delete */

   127

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   128

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

   129

   130

		/* non-stop only for trains */

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   140

		w->HideWidget(ORDER_WIDGET_SERVICE); // Service

   141

	} else {

   142

		w->DisableWidget(ORDER_WIDGET_TRANSFER);

   143

		w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   144

	}

   145

   146

	w->ShowWidget(ORDER_WIDGET_UNLOAD);

   147

	w->ShowWidget(ORDER_WIDGET_TRANSFER);

   148

   149

	if (order != NULL) {

   150

		switch (order->GetType()) {

   151

			case OT_GOTO_STATION:

   152

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

   153

				/* Fall-through */

   154

   155

			case OT_GOTO_WAYPOINT:

   156

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   157

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   158

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   159

				break;

   160

   161

			case OT_GOTO_DEPOT:

   162

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   163

   164

				/* Remove unload and replace it with refit */

   165

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   166

				w->ShowWidget(ORDER_WIDGET_REFIT);

   167

				w->HideWidget(ORDER_WIDGET_TRANSFER);

   168

				w->ShowWidget(ORDER_WIDGET_SERVICE);

   169

				break;

   170

   171

			default: // every other orders

   172

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   173

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   174

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   175

		}

   176

	}

   177

   178

	SetDParam(0, v->index);

   179

	DrawWindowWidgets(w);

   180

   181

	int y = 15;

   182

   183

	int i = w->vscroll.pos;

   184

	order = GetVehicleOrder(v, i);

   185

	StringID str;

   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->GetType()) {

   194

				case OT_DUMMY:

   195

					SetDParam(1, STR_INVALID_ORDER);

   196

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

   197

					break;

   198

   209

   210

				case OT_GOTO_DEPOT: {

   211

					StringID s = STR_NULL;

   212

   213

					if (v->type == VEH_AIRCRAFT) {

   214

						s = STR_GO_TO_AIRPORT_HANGAR;

   215

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

   216

					} else {

   217

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

   218

   219

						switch (v->type) {

   220

							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;

   221

							case VEH_ROAD:  s = STR_GO_TO_ROADVEH_DEPOT; break;

   222

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   223

							default: break;

   224

						}

   225

					}

   226

   227

					if (order->GetDepotOrderType() & ODTFB_SERVICE) s++; // service at

   228

   229

					SetDParam(1, s);

   230

					if (order->IsRefit()) {

   231

						SetDParam(3, STR_REFIT_ORDER);

   232

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

   233

					} else {

   234

						SetDParam(3, STR_EMPTY);

   235

					}

   236

					break;

   237

				}

   238

   239

				case OT_GOTO_WAYPOINT:

   240

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

   241

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

   242

					break;

   243

   244

				default: break;

   245

			}

   246

   247

			SetDParam(0, i + 1);

   248

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

   249

   250

			y += 10;

   251

		}

   252

   253

		i++;

   254

		order = order->next;

   255

	}

   256

   257

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

   258

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   259

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

   260

	}

   261

}

   262

   263

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

   264

{

   265

	Order order;

   266

	order.next  = NULL;

   267

	order.index = 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.MakeGoToDepot(GetDepotByTile(tile)->index, ODTFB_PART_OF_ORDERS);

   276

						return order;

   277

					}

   278

				}

   279

				break;

   280

   281

			case MP_ROAD:

   282

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

   283

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

   284

					return order;

   285

				}

   286

				break;

   287

   288

			case MP_STATION:

   289

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

   290

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

   291

					order.MakeGoToDepot(GetStationIndex(tile), ODTFB_PART_OF_ORDERS);

   292

					return order;

   293

				}

   294

				break;

   295

   296

			case MP_WATER:

   297

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

   298

				if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   299

						IsTileOwner(tile, _local_player)) {

   300

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   301

   302

					order.MakeGoToDepot(GetDepotByTile(tile < tile2 ? tile : tile2)->index, ODTFB_PART_OF_ORDERS);

   303

					return order;

   304

				}

   305

   306

			default:

   307

				break;

   308

		}

   309

	}

   310

   311

	/* check waypoint */

   312

	if (IsTileType(tile, MP_RAILWAY) &&

   313

			v->type == VEH_TRAIN &&

   314

			IsTileOwner(tile, _local_player) &&

   315

			IsRailWaypoint(tile)) {

   316

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

   317

		return order;

   318

	}

   319

   320

	if (IsTileType(tile, MP_STATION)) {

   321

		StationID st_index = GetStationIndex(tile);

   322

		const Station *st = GetStation(st_index);

   323

   324

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

   325

			byte facil;

   326

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

   327

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

   328

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

   329

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

   330

			(facil = FACIL_TRUCK_STOP, 1);

   331

			if (st->facilities & facil) {

   332

				order.MakeGoToStation(st_index);

   333

				return order;

   334

			}

   335

		}

   336

	}

   337

   338

	/* not found */

   339

	order.Free();

   340

	return order;

   341

}

   342

   343

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

   344

{

   345

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

   346

   347

	if (!u->IsPrimaryVehicle()) {

   348

		u = u->First();

   349

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

   350

	}

   351

   352

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

   353

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

   354

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

   355

   356

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

   357

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

   358

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

   359

		ResetObjectToPlace();

   360

	}

   361

   362

	return true;

   363

}

   364

   365

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

   366

{

   367

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

   368

	const Vehicle *u = CheckMouseOverVehicle();

   369

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

   370

   371

	const Order cmd = GetOrderCmdFromTile(v, tile);

   372

	if (!cmd.IsValid()) return;

   373

   374

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

   375

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

   376

		ResetObjectToPlace();

   377

	}

   378

}

   379

   380

/**

   381

 * Handle the click on the goto button.

   382

 *

   383

 * @param w current window

   384

 * @param v current vehicle

   385

 */

   386

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

   387

{

   388

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   389

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   390

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   391

		_place_clicked_vehicle = NULL;

   392

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   393

	} else {

   394

		ResetObjectToPlace();

   395

	}

   396

}

   397

   398

/**

   399

 * Handle the click on the full load button.

   400

 *

   401

 * @param w current window

   402

 * @param v current vehicle

   403

 */

   404

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

   405

{

   406

	VehicleOrderID sel_ord = OrderGetSel(w);

   407

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

   408

   409

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

   410

}

   411

   412

/**

   413

 * Handle the click on the service.

   414

 *

   415

 * @param w current window

   416

 * @param v current vehicle

   417

 */

   418

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

   419

{

   420

	DoCommandP(v->tile, v->index + (OrderGetSel(w) << 16), MOF_DEPOT_ACTION, 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

	VehicleOrderID sel_ord = OrderGetSel(w);

   432

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

   433

   434

	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));

   435

}

   436

   437

/**

   438

 * Handle the click on the nonstop button.

   439

 *

   440

 * @param w current window

   441

 * @param v current vehicle

   442

 */

   443

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

   444

{

   445

	VehicleOrderID sel_ord = OrderGetSel(w);

   446

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

   447

   448

	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));

   449

}

   450

   451

/**

   452

 * Handle the click on the transfer button.

   453

 *

   454

 * @param w current window

   455

 * @param v current vehicle

   456

 */

   457

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

   458

{

   459

	VehicleOrderID sel_ord = OrderGetSel(w);

   460

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

   461

   462

	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));

   463

}

   464

   465

/**

   466

 * Handle the click on the skip button.

   467

 * If ctrl is pressed skip to selected order.

   468

 *  Else skip to current order + 1

   469

 *

   470

 * @param w current window

   471

 * @param v current vehicle

   472

 */

   473

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

   474

{

   475

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

   476

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

   477

   478

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

   479

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

   480

}

   481

   482

/**

   483

 * Handle the click on the unload button.

   484

 *