1

/* $Id$ */

     2

     3

/** @file train_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "window.h"

    12

#include "gui.h"

    13

#include "vehicle.h"

    14

#include "viewport.h"

    15

#include "command.h"

    16

#include "vehicle_gui.h"

    17

#include "depot.h"

    18

#include "train.h"

    19

#include "newgrf_engine.h"

    20

    21

void CcBuildWagon(bool success, TileIndex tile, uint32 p1, uint32 p2)

    22

{

    23

	Vehicle *v, *found;

    24

    25

	if (!success) return;

    26

    27

	/* find a locomotive in the depot. */

    28

	found = NULL;

    29

	FOR_ALL_VEHICLES(v) {

    30

		if (v->type == VEH_TRAIN && IsFrontEngine(v) &&

    31

				v->tile == tile &&

    32

				v->u.rail.track == TRACK_BIT_DEPOT) {

    33

			if (found != NULL) return; // must be exactly one.

    34

			found = v;

    35

		}

    36

	}

    37

    38

	/* if we found a loco, */

    39

	if (found != NULL) {

    40

		found = GetLastVehicleInChain(found);

    41

		/* put the new wagon at the end of the loco. */

    42

		DoCommandP(0, _new_vehicle_id | (found->index << 16), 0, NULL, CMD_MOVE_RAIL_VEHICLE);

    43

		RebuildVehicleLists();

    44

	}

    45

}

    46

    47

void CcBuildLoco(bool success, TileIndex tile, uint32 p1, uint32 p2)

    48

{

    49

	const Vehicle *v;

    50

    51

	if (!success) return;

    52

    53

	v = GetVehicle(_new_vehicle_id);

    54

	if (tile == _backup_orders_tile) {

    55

		_backup_orders_tile = 0;

    56

		RestoreVehicleOrders(v, _backup_orders_data);

    57

	}

    58

	ShowTrainViewWindow(v);

    59

}

    60

    61

void CcCloneTrain(bool success, TileIndex tile, uint32 p1, uint32 p2)

    62

{

    63

	if (success) ShowTrainViewWindow(GetVehicle(_new_vehicle_id));

    64

}

    65

    66

/**

    67

 * Get the number of pixels for the given wagon length.

    68

 * @param len Length measured in 1/8ths of a standard wagon.

    69

 * @return Number of pixels across.

    70

 */

    71

int WagonLengthToPixels(int len) {

    72

	return (len * _traininfo_vehicle_width) / 8;

    73

}

    74

    75

void DrawTrainImage(const Vehicle *v, int x, int y, int count, int skip, VehicleID selection)

    76

{

    77

	DrawPixelInfo tmp_dpi, *old_dpi;

    78

	int dx = -(skip * 8) / _traininfo_vehicle_width;

    79

	/* Position of highlight box */

    80

	int highlight_l = 0;

    81

	int highlight_r = 0;

    82

    83

	if (!FillDrawPixelInfo(&tmp_dpi, x - 2, y - 1, count + 1, 14)) return;

    84

    85

	count = (count * 8) / _traininfo_vehicle_width;

    86

    87

	old_dpi = _cur_dpi;

    88

	_cur_dpi = &tmp_dpi;

    89

    90

	do {

    91

		int width = v->u.rail.cached_veh_length;

    92

    93

		if (dx + width > 0) {

    94

			if (dx <= count) {

    95

				SpriteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);

    96

				DrawSprite(GetTrainImage(v, DIR_W), pal, 16 + WagonLengthToPixels(dx), 7 + (is_custom_sprite(RailVehInfo(v->engine_type)->image_index) ? _traininfo_vehicle_pitch : 0));

    97

				if (v->index == selection) {

    98

					/* Set the highlight position */

    99

					highlight_l = WagonLengthToPixels(dx) + 1;

   100

					highlight_r = WagonLengthToPixels(dx + width) + 1;

   101

				}

   102

			}

   103

		}

   104

		dx += width;

   105

   106

		v = v->next;

   107

	} while (dx < count && v != NULL);

   108

   109

	if (highlight_l != highlight_r) {

   110

		/* Draw the highlight. Now done after drawing all the engines, as

   111

		 * the next engine after the highlight could overlap it. */

   112

		DrawFrameRect(highlight_l, 0, highlight_r, 13, 15, FR_BORDERONLY);

   113

	}

   114

   115

	_cur_dpi = old_dpi;

   116

}

   117

   118

static const OldWidget _train_view_widgets[] = {

   119

{   WWT_CLOSEBOX,  RESIZE_NONE, 14,   0,  10,   0,  13, STR_00C5,                STR_018B_CLOSE_WINDOW },

   120

{    WWT_CAPTION, RESIZE_RIGHT, 14,  11, 237,   0,  13, STR_882E,                STR_018C_WINDOW_TITLE_DRAG_THIS },

   121

{  WWT_STICKYBOX,    RESIZE_LR, 14, 238, 249,   0,  13, 0x0,                     STR_STICKY_BUTTON },

   122

{      WWT_PANEL,    RESIZE_RB, 14,   0, 231,  14, 121, 0x0,                     STR_NULL },

   123

{      WWT_INSET,    RESIZE_RB, 14,   2, 229,  16, 119, 0x0,                     STR_NULL },

   124

{    WWT_PUSHBTN,   RESIZE_RTB, 14,   0, 237, 122, 133, 0x0,                     STR_8846_CURRENT_TRAIN_ACTION_CLICK },

   125

{ WWT_PUSHIMGBTN,    RESIZE_LR, 14, 232, 249,  14,  31, SPR_CENTRE_VIEW_VEHICLE, STR_8848_CENTER_MAIN_VIEW_ON_TRAIN },

   126

{ WWT_PUSHIMGBTN,    RESIZE_LR, 14, 232, 249,  32,  49, SPR_SEND_TRAIN_TODEPOT,  STR_8849_SEND_TRAIN_TO_DEPOT },

   127

{ WWT_PUSHIMGBTN,    RESIZE_LR, 14, 232, 249,  50,  67, SPR_IGNORE_SIGNALS,      STR_884A_FORCE_TRAIN_TO_PROCEED },

   128

{ WWT_PUSHIMGBTN,    RESIZE_LR, 14, 232, 249,  68,  85, SPR_FORCE_VEHICLE_TURN,  STR_884B_REVERSE_DIRECTION_OF_TRAIN },

   129

{ WWT_PUSHIMGBTN,    RESIZE_LR, 14, 232, 249,  86, 103, SPR_SHOW_ORDERS,         STR_8847_SHOW_TRAIN_S_ORDERS },

   130

{ WWT_PUSHIMGBTN,    RESIZE_LR, 14, 232, 249, 104, 121, SPR_SHOW_VEHICLE_DETAILS,STR_884C_SHOW_TRAIN_DETAILS },

   131

{ WWT_PUSHIMGBTN,    RESIZE_LR, 14, 232, 249,  68,  85, SPR_REFIT_VEHICLE,       STR_RAIL_REFIT_VEHICLE_TO_CARRY },

   132

{ WWT_PUSHIMGBTN,    RESIZE_LR, 14, 232, 249,  32,  49, SPR_CLONE_TRAIN,         STR_CLONE_TRAIN_INFO },

   133

{      WWT_PANEL,   RESIZE_LRB, 14, 232, 249, 122, 121, 0x0,                     STR_NULL },

   134

{  WWT_RESIZEBOX,  RESIZE_LRTB, 14, 238, 249, 122, 133, 0x0,                     STR_NULL },

   135

{ WIDGETS_END }

   136

};

   137

   138

static void ShowTrainDetailsWindow(const Vehicle *v);

   139

   140

static void TrainViewWndProc(BaseWindow *w, WindowEvent *e)

   141

{

   142

	switch (e->event) {

   143

	case WE_PAINT: {

   144

		const Vehicle *v, *u;

   145

		StringID str;

   146

		bool is_localplayer;

   147

   148

		v = GetVehicle(w->window_number);

   149

   150

		is_localplayer = v->owner == _local_player;

   151

		w->SetWidgetDisabledState( 7, !is_localplayer);

   152

		w->SetWidgetDisabledState( 8, !is_localplayer);

   153

		w->SetWidgetDisabledState( 9, !is_localplayer);

   154

		w->SetWidgetDisabledState(13, !is_localplayer);

   155

   156

		/* Disable cargo refit button, until we know we can enable it below. */

   157

		w->DisableWidget(12);

   158

   159

		if (is_localplayer) {

   160

			/* See if any vehicle can be refitted */

   161

			for (u = v; u != NULL; u = u->next) {

   162

				if (EngInfo(u->engine_type)->refit_mask != 0 ||

   163

						(RailVehInfo(v->engine_type)->railveh_type != RAILVEH_WAGON && v->cargo_cap != 0)) {

   164

					w->EnableWidget(12);

   165

					/* We have a refittable carriage, bail out */

   166

					break;

   167

				}

   168

			}

   169

		}

   170

   171

		/* draw widgets & caption */

   172

		SetDParam(0, v->string_id);

   173

		SetDParam(1, v->unitnumber);

   174

		w->DrawWidgets();

   175

   176

		if (v->u.rail.crash_anim_pos != 0) {

   177

			str = STR_8863_CRASHED;

   178

		} else if (v->breakdown_ctr == 1) {

   179

			str = STR_885C_BROKEN_DOWN;

   180

		} else if (v->vehstatus & VS_STOPPED) {

   181

			if (v->u.rail.last_speed == 0) {

   182

				if (v->u.rail.cached_power == 0) {

   183

					str = STR_TRAIN_NO_POWER;

   184

				} else {

   185

					str = STR_8861_STOPPED;

   186

				}

   187

			} else {

   188

				SetDParam(0, v->u.rail.last_speed * 10 / 16);

   189

				str = STR_TRAIN_STOPPING + _patches.vehicle_speed;

   190

			}

   191

		} else {

   192

			switch (v->current_order.type) {

   193

			case OT_GOTO_STATION: {

   194

				str = STR_HEADING_FOR_STATION + _patches.vehicle_speed;

   195

				SetDParam(0, v->current_order.dest);

   196

				SetDParam(1, v->u.rail.last_speed * 10 / 16);

   197

			} break;

   198

   199

			case OT_GOTO_DEPOT: {

   200

				Depot *dep = GetDepot(v->current_order.dest);

   201

				SetDParam(0, dep->town_index);

   202

				if (HASBIT(v->current_order.flags, OFB_HALT_IN_DEPOT) && !HASBIT(v->current_order.flags, OFB_PART_OF_ORDERS)) {

   203

					str = STR_HEADING_FOR_TRAIN_DEPOT + _patches.vehicle_speed;

   204

				} else {

   205

					str = STR_HEADING_FOR_TRAIN_DEPOT_SERVICE + _patches.vehicle_speed;

   206

				}

   207

				SetDParam(1, v->u.rail.last_speed * 10 / 16);

   208

			} break;

   209

   210

			case OT_LOADING:

   211

			case OT_LEAVESTATION:

   212

				str = STR_882F_LOADING_UNLOADING;

   213

				break;

   214

   215

			case OT_GOTO_WAYPOINT: {

   216

				SetDParam(0, v->current_order.dest);

   217

				str = STR_HEADING_FOR_WAYPOINT + _patches.vehicle_speed;

   218

				SetDParam(1, v->u.rail.last_speed * 10 / 16);

   219

				break;

   220

			}

   221

   222

			default:

   223

				if (v->num_orders == 0) {

   224

					str = STR_NO_ORDERS + _patches.vehicle_speed;

   225

					SetDParam(0, v->u.rail.last_speed * 10 / 16);

   226

				} else {

   227

					str = STR_EMPTY;

   228

				}

   229

				break;

   230

			}

   231

		}

   232

   233

		/* draw the flag plus orders */

   234

		DrawSprite(v->vehstatus & VS_STOPPED ? SPR_FLAG_VEH_STOPPED : SPR_FLAG_VEH_RUNNING, PAL_NONE, 2, w->widget[5].top + 1);

   235

		DrawStringCenteredTruncated(w->widget[5].left + 8, w->widget[5].right, w->widget[5].top + 1, str, 0);

   236

		w->DrawViewport();

   238

   239

	case WE_CLICK: {

   240

		int wid = e->we.click.widget;

   241

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

   242

   243

		switch (wid) {

   244

		case 5: /* start/stop train */

   245

			DoCommandP(v->tile, v->index, 0, NULL, CMD_START_STOP_TRAIN | CMD_MSG(STR_883B_CAN_T_STOP_START_TRAIN));

   246

			break;

   247

		case 6: /* center main view */

   248

			ScrollMainWindowTo(v->x_pos, v->y_pos);

   249

			break;

   250

		case 7: /* goto depot */

   251

			/* TrainGotoDepot has a nice randomizer in the pathfinder, which causes desyncs... */

   252

			DoCommandP(v->tile, v->index, _ctrl_pressed ? DEPOT_SERVICE : 0, NULL, CMD_SEND_TRAIN_TO_DEPOT | CMD_NO_TEST_IF_IN_NETWORK | CMD_MSG(STR_8830_CAN_T_SEND_TRAIN_TO_DEPOT));

   253

			break;

   254

		case 8: /* force proceed */

   255

			DoCommandP(v->tile, v->index, 0, NULL, CMD_FORCE_TRAIN_PROCEED | CMD_MSG(STR_8862_CAN_T_MAKE_TRAIN_PASS_SIGNAL));

   256

			break;

   257

		case 9: /* reverse direction */

   258

			DoCommandP(v->tile, v->index, 0, NULL, CMD_REVERSE_TRAIN_DIRECTION | CMD_MSG(STR_8869_CAN_T_REVERSE_DIRECTION));

   259

			break;

   260

		case 10: /* show train orders */

   261

			ShowOrdersWindow(v);

   262

			break;

   263

		case 11: /* show train details */

   264

			ShowTrainDetailsWindow(v);

   265

			break;

   266

		case 12:

   267

			ShowVehicleRefitWindow(v, INVALID_VEH_ORDER_ID);

   268

			break;

   269

		case 13:

   270

			DoCommandP(v->tile, v->index, _ctrl_pressed ? 1 : 0, NULL, CMD_CLONE_VEHICLE | CMD_MSG(STR_882B_CAN_T_BUILD_RAILROAD_VEHICLE));

   271

			break;

   272

		}

   273

	} break;

   274

   275

	case WE_RESIZE:

   276

		w->viewport->width          += e->we.sizing.diff.x;

   277

		w->viewport->height         += e->we.sizing.diff.y;

   278

		w->viewport->virtual_width  += e->we.sizing.diff.x;

   279

		w->viewport->virtual_height += e->we.sizing.diff.y;

   280

		break;

   281

   282

	case WE_DESTROY:

   283

		DeleteWindowById(WC_VEHICLE_REFIT, w->window_number);

   284

		DeleteWindowById(WC_VEHICLE_ORDERS, w->window_number);

   285

		DeleteWindowById(WC_VEHICLE_DETAILS, w->window_number);

   286

		break;

   287

   288

	case WE_MOUSELOOP: {

   289

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

   290

		bool train_stopped = CheckTrainStoppedInDepot(v)  >= 0;

   291

   292

		/* OldWidget 7 (send to depot) must be hidden if the train is already stopped in hangar.

   293

		 * OldWidget 13 (clone) should then be shown, since cloning is allowed only while in depot and stopped.

   294

		 * This sytem allows to have two buttons, on top of each other.

   295

		 * The same system applies to widget 9 and 12, reverse direction and refit*/

   296

		if (train_stopped != w->IsWidgetHidden(7) || train_stopped == w->IsWidgetHidden(13)) {

   297

			w->SetWidgetHiddenState( 7, train_stopped);  // send to depot

   298

			w->SetWidgetHiddenState( 9, train_stopped);  // reverse direction

   299

			w->SetWidgetHiddenState(12, !train_stopped); // refit

   300

			w->SetWidgetHiddenState(13, !train_stopped); // clone

   301

			w->SetDirty();

   302

		}

   303

		break;

   304

	}

   305

   306

	}

   307

}

   308

   309

static const WindowDesc _train_view_desc = {

   310

	WDP_AUTO, WDP_AUTO, 250, 134,

   311

	WC_VEHICLE_VIEW, WC_NONE,

   312

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON | WDF_RESIZABLE,

   313

	_train_view_widgets,

   314

	TrainViewWndProc

   315

};

   316

   317

void ShowTrainViewWindow(const Vehicle *v)

   318

{

   319

	BaseWindow *w = BaseWindow::AllocateFront(&_train_view_desc,v->index);

   320

   321

	if (w != NULL) {

   322

		w->caption_color = v->owner;

   323

		AssignWindowViewport(w, 3, 17, 0xE2, 0x66, w->window_number | (1 << 31), 0);

   324

	}

   325

}

   326

   327

static void TrainDetailsCargoTab(const Vehicle *v, int x, int y)

   328

{

   329

	if (v->cargo_cap != 0) {

   330

		uint num = v->cargo_count;

   331

		StringID str = STR_8812_EMPTY;

   332

   333

		if (num != 0) {

   334

			SetDParam(0, v->cargo_type);

   335

			SetDParam(1, num);

   336

			SetDParam(2, v->cargo_source);

   337

			SetDParam(3, _patches.freight_trains);

   338

			str = FreightWagonMult(v->cargo_type) > 1 ? STR_FROM_MULT : STR_8813_FROM;

   339

		}

   340

		DrawString(x, y, str, 0);

   341

	}

   342

}

   343

   344

static void TrainDetailsInfoTab(const Vehicle *v, int x, int y)

   345

{

   346

	if (RailVehInfo(v->engine_type)->railveh_type == RAILVEH_WAGON) {

   347

		SetDParam(0, GetCustomEngineName(v->engine_type));

   348

		SetDParam(1, v->value);

   349

		DrawString(x, y, STR_882D_VALUE, 0x10);

   350

	} else {

   351

		SetDParam(0, GetCustomEngineName(v->engine_type));

   352

		SetDParam(1, v->build_year);

   353

		SetDParam(2, v->value);

   354

		DrawString(x, y, STR_882C_BUILT_VALUE, 0x10);

   355

	}

   356

}

   357

   358

static void TrainDetailsCapacityTab(const Vehicle *v, int x, int y)

   359

{

   360

	if (v->cargo_cap != 0) {

   361

		SetDParam(0, v->cargo_type);

   362

		SetDParam(1, v->cargo_cap);

   363

		SetDParam(2, _patches.freight_trains);

   364

		DrawString(x, y, FreightWagonMult(v->cargo_type) > 1 ? STR_CAPACITY_MULT : STR_013F_CAPACITY, 0);

   365

	}

   366

}

   367

   368

   369

static void DrawTrainDetailsWindow(BaseWindow *w)

   370

{

   371

	byte det_tab = WP(w, traindetails_d).tab;

   372

	const Vehicle *v;

   373

	const Vehicle *u;

   374

	AcceptedCargo act_cargo;

   375

	AcceptedCargo max_cargo;

   376

	int num;

   377

	int x;

   378

	int y;

   379

	int sel;

   380

   381

	num = 0;

   382

	u = v = GetVehicle(w->window_number);

   383

	if (det_tab == 3) { // Total cargo tab

   384

		for (CargoID i = 0; i < lengthof(act_cargo); i++) {

   385

			act_cargo[i] = 0;

   386

			max_cargo[i] = 0;

   387

		}

   388

   389

		do {

   390

			act_cargo[u->cargo_type] += u->cargo_count;

   391

			max_cargo[u->cargo_type] += u->cargo_cap;

   392

		} while ((u = u->next) != NULL);

   393

   394

		/* Set scroll-amount seperately from counting, as to not compute num double

   395

		 * for more carriages of the same type

   396

		 */

   397

		for (CargoID i = 0; i < NUM_CARGO; i++) {

   398

			if (max_cargo[i] > 0) num++; // only count carriages that the train has

   399

		}

   400

		num++; // needs one more because first line is description string

   401

	} else {

   402

		do {

   403

			if (!IsArticulatedPart(u) || u->cargo_cap != 0) num++;

   404

		} while ((u = u->next) != NULL);

   405

	}

   406

   407

	SetVScrollCount(w, num);

   408

   409

	w->DisableWidget(det_tab + 9);

   410

	w->SetWidgetDisabledState(2, v->owner != _local_player);

   411

   412

	/* disable service-scroller when interval is set to disabled */

   413

	w->SetWidgetDisabledState(6, !_patches.servint_trains);

   414

	w->SetWidgetDisabledState(7, !_patches.servint_trains);

   415

   416

	SetDParam(0, v->string_id);

   417

	SetDParam(1, v->unitnumber);

   418

	w->DrawWidgets();

   419

   420

	SetDParam(1, v->age / 366);

   421

   422

	x = 2;

   423

   424

	SetDParam(0, (v->age + 365 < v->max_age) ? STR_AGE : STR_AGE_RED);

   425

	SetDParam(2, v->max_age / 366);

   426

	SetDParam(3, GetTrainRunningCost(v) >> 8);

   427

	DrawString(x, 15, STR_885D_AGE_RUNNING_COST_YR, 0);

   428

   429

	SetDParam(2, v->u.rail.cached_max_speed * 10 / 16);

   430

	SetDParam(1, v->u.rail.cached_power);

   431

	SetDParam(0, v->u.rail.cached_weight);

   432

	SetDParam(3, v->u.rail.cached_max_te / 1000);

   433

	DrawString(x, 25, (_patches.realistic_acceleration && v->u.rail.railtype != RAILTYPE_MAGLEV) ?

   434

		STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE :

   435

		STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED, 0);

   436

   437

	SetDParam(0, v->profit_this_year);

   438

	SetDParam(1, v->profit_last_year);

   439

	DrawString(x, 35, STR_885F_PROFIT_THIS_YEAR_LAST_YEAR, 0);

   440

   441

	SetDParam(0, 100 * (v->reliability>>8) >> 8);

   442

	SetDParam(1, v->breakdowns_since_last_service);

   443

	DrawString(x, 45, STR_8860_RELIABILITY_BREAKDOWNS, 0);

   444

   445

	SetDParam(0, v->service_interval);

   446

	SetDParam(1, v->date_of_last_service);

   447

	DrawString(x + 11, 57 + (w->vscroll.cap * 14), _patches.servint_ispercent ? STR_SERVICING_INTERVAL_PERCENT : STR_883C_SERVICING_INTERVAL_DAYS, 0);

   448

   449

	y = 57;

   450

	sel = w->vscroll.pos;

   451

   452

	/* draw the first 3 details tabs */

   453

	if (det_tab != 3) {

   454

		x = 1;

   455

		for (;;) {

   456

			if (--sel < 0 && sel >= -w->vscroll.cap) {

   457

				int dx = 0;

   458

				int px;

   459

				int py;

   460

   461

				u = v;

   462

				do {

   463

					SpriteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);

   464

					DrawSprite(GetTrainImage(u, DIR_W), pal, x + WagonLengthToPixels(4 + dx), y + 6 + (is_custom_sprite(RailVehInfo(u->engine_type)->image_index) ? _traininfo_vehicle_pitch : 0));

   465

					dx += u->u.rail.cached_veh_length;

   466

					u = u->next;

   467

				} while (u != NULL && IsArticulatedPart(u) && u->cargo_cap == 0);

   468

   469

				px = x + WagonLengthToPixels(dx) + 2;

   470

				py = y + 2;

   471

				switch (det_tab) {

   472

					default: NOT_REACHED();

   473

					case 0: TrainDetailsCargoTab(   v, px, py); break;

   474

					case 1:

   475

						/* Only show name and value for the 'real' part */

   476

						if (!IsArticulatedPart(v)) {

   477

							TrainDetailsInfoTab(v, px, py);

   478

						}

   479

						break;

   480

					case 2: TrainDetailsCapacityTab(v, px, py); break;

   481

				}

   482

				y += 14;

   483

   484

				v = u;

   485

			} else {

   486

				/* Move to the next line */

   487

				do {

   488

					v = v->next;

   489

				} while (v != NULL && IsArticulatedPart(v) && v->cargo_cap == 0);