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

#include "widgets/dropdown_func.h"

    30

    31

#include "table/sprites.h"

    32

#include "table/strings.h"

    33

    34

enum OrderWindowWidgets {

    35

	ORDER_WIDGET_CLOSEBOX = 0,

    36

	ORDER_WIDGET_CAPTION,

    37

	ORDER_WIDGET_TIMETABLE_VIEW,

    38

	ORDER_WIDGET_ORDER_LIST,

    39

	ORDER_WIDGET_SCROLLBAR,

    40

	ORDER_WIDGET_SKIP,

    41

	ORDER_WIDGET_DELETE,

    42

	ORDER_WIDGET_NON_STOP,

    43

	ORDER_WIDGET_GOTO,

    44

	ORDER_WIDGET_FULL_LOAD,

    45

	ORDER_WIDGET_UNLOAD,

    46

	ORDER_WIDGET_REFIT,

    47

	ORDER_WIDGET_TRANSFER,

    48

	ORDER_WIDGET_SERVICE,

    49

	ORDER_WIDGET_RESIZE_BAR,

    50

	ORDER_WIDGET_SHARED_ORDER_LIST,

    51

	ORDER_WIDGET_RESIZE,

    52

};

    53

    54

/**

    55

 * Return the memorised selected order.

    56

 *

    57

 * @param w current window

    58

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

    59

 *  else return the number of orders

    60

 */

    61

static int OrderGetSel(const Window *w)

    62

{

    63

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

    64

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

    65

    66

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

    67

}

    68

    69

/**

    70

 * Calculate the selected order.

    71

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

    72

 *  the position of the scrollbar.

    73

 *

    74

 * @param w current window

    75

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

    76

 * @param v current vehicle

    77

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

    78

 *  an invalid one has been selected.

    79

 */

    80

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

    81

{

    82

	/*

    83

	 * Calculation description:

    84

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

    85

	 * 10 = order text hight

    86

	 */

    87

	int sel = (y - 15) / 10;

    88

    89

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

    90

    91

	sel += w->vscroll.pos;

    92

    93

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

    94

}

    95

    96

/** Order load types that could be given to station orders. */

    97

static const StringID _station_load_types[][5] = {

    98

	{

    99

		STR_EMPTY,

   100

		STR_ORDER_UNLOAD,

   101

		STR_ORDER_FULL_LOAD,

   102

		STR_ORDER_FULL_LOAD_ANY,

   103

		STR_ORDER_NO_LOAD,

   104

	}, {

   105

		STR_ORDER_TRANSFER,

   106

		STR_ORDER_TRANSFER_UNLOAD,

   107

		STR_ORDER_TRANSFER_FULL_LOAD,

   108

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

   109

		INVALID_STRING_ID,

   110

	}

   111

};

   112

   113

static void DrawOrdersWindow(Window *w)

   114

{

   115

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

   116

	bool shared_orders = v->IsOrderListShared();

   117

   118

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

   119

   120

	int sel = OrderGetSel(w);

   121

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

   122

   123

	if (v->owner == _local_player) {

   124

		/* skip */

   125

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

   126

   127

		/* delete */

   128

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   129

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

   130

   131

		/* non-stop only for trains */

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

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

   140

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   141

		w->HideWidget(ORDER_WIDGET_SERVICE); // Service

   142

	} else {

   143

		w->DisableWidget(ORDER_WIDGET_TRANSFER);

   144

		w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   145

	}

   146

   147

	w->ShowWidget(ORDER_WIDGET_UNLOAD);

   148

	w->ShowWidget(ORDER_WIDGET_TRANSFER);

   149

   150

	if (order != NULL) {

   151

		switch (order->GetType()) {

   152

			case OT_GOTO_STATION:

   153

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

   154

				/* Fall-through */

   155

   156

			case OT_GOTO_WAYPOINT:

   157

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   158

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   159

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   160

				break;

   161

   162

			case OT_GOTO_DEPOT:

   163

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   164

   165

				/* Remove unload and replace it with refit */

   166

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   167

				w->ShowWidget(ORDER_WIDGET_REFIT);

   168

				w->HideWidget(ORDER_WIDGET_TRANSFER);

   169

				w->ShowWidget(ORDER_WIDGET_SERVICE);

   170

				break;

   171

   172

			default: // every other orders

   173

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   174

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   175

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   176

		}

   177

	}

   178

   179

	SetDParam(0, v->index);

   180

	DrawWindowWidgets(w);

   181

   182

	int y = 15;

   183

   184

	int i = w->vscroll.pos;

   185

	order = GetVehicleOrder(v, i);

   186

	StringID str;

   187

	while (order != NULL) {

   188

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

   189

		SetDParam(3, STR_EMPTY);

   190

   191

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

   192

			SetDParam(1, 6);

   193

   194

			switch (order->GetType()) {

   195

				case OT_DUMMY:

   196

					SetDParam(1, STR_INVALID_ORDER);

   197

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

   198

					break;

   199

   200

				case OT_GOTO_STATION: {

   201

					OrderLoadFlags load = order->GetLoadType();

   202

					OrderUnloadFlags unload = order->GetUnloadType();

   203

   204

					SetDParam(1, STR_GO_TO_STATION);

   205

					SetDParam(2, STR_ORDER_GO_TO + (v->type == VEH_TRAIN ? order->GetNonStopType() : 0));

   206

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

   208

				} break;

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

   334

				return order;

   335

			}

   336

		}

   337

	}

   338

   339

	/* not found */

   340

	order.Free();

   341

	return order;

   342

}

   343

   344

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

   345

{

   346

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

   347

   348

	if (!u->IsPrimaryVehicle()) {

   349

		u = u->First();

   350

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

   351

	}

   352

   353

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

   354

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

   355

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

   356

   357

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

   358

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

   359

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

   360

		ResetObjectToPlace();

   361

	}

   362

   363

	return true;

   364

}

   365

   366

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

   367

{

   368

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

   369

	const Vehicle *u = CheckMouseOverVehicle();

   370

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

   371

   372

	const Order cmd = GetOrderCmdFromTile(v, tile);

   373

	if (!cmd.IsValid()) return;

   374

   375

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

   376

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

   377

		ResetObjectToPlace();

   378

	}

   379

}

   380

   381

/**

   382

 * Handle the click on the goto button.

   383

 *

   384

 * @param w current window

   385

 * @param v current vehicle

   386

 */

   387

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

   388

{

   389

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   390

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   391

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   392

		_place_clicked_vehicle = NULL;

   393

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   394

	} else {

   395

		ResetObjectToPlace();

   396

	}

   397

}

   398

   399

/**

   400

 * Handle the click on the full load button.

   401

 *

   402

 * @param w current window

   403

 * @param v current vehicle

   404

 * @param load_type the way to load.

   405

 */

   406

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

   407

{

   408

	VehicleOrderID sel_ord = OrderGetSel(w);

   409

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

   410

   422

}

   423

   424

/**

   425

 * Handle the click on the service.

   426

 *

   427

 * @param w current window

   428

 * @param v current vehicle

   429

 */

   430

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

   431

{

   432

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

   433

}

   434

   435

/**

   436

 * Handle the click on the unload button.

   437

 *

   438

 * @param w current window

   439

 * @param v current vehicle

   440

 */

   441

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

   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_UNLOAD) << 2, NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   447

}

   448

   449

/**

   450

 * Handle the click on the nonstop button.

   451

 *

   452

 * @param w current window

   453

 * @param v current vehicle

   454

 * @param non_stop what non-stop type to use; -1 to use the 'next' one.

   455

 */

   456

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

   457

{

   458

	VehicleOrderID sel_ord = OrderGetSel(w);

   459

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

   460

   461

	if (order->GetNonStopType() == non_stop) return;

   462

   463

	/* Keypress if negative, so 'toggle' to the next */

   464

	if (non_stop < 0) {

   465

		non_stop = (order->GetNonStopType() + 1) % ONSF_END;

   466

	}

   467

   468

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

   469

}

   470

   471

/**

   472

 * Handle the click on the transfer button.

   473

 *

   474

 * @param w current window

   475

 * @param v current vehicle

   476

 */

   477

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

   478

{

   479

	VehicleOrderID sel_ord = OrderGetSel(w);

   480

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

   481

   482

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

   483

}

   484