1

/* $Id$ */

     2

     3

/** @file rail_gui.c File for dealing with rail construction user interface */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/sprites.h"

     8

#include "table/strings.h"

     9

#include "functions.h"

    10

#include "map.h"

    11

#include "tile.h"

    12

#include "window.h"

    13

#include "gui.h"

    14

#include "viewport.h"

    15

#include "gfx.h"

    16

#include "sound.h"

    17

#include "command.h"

    18

#include "vehicle.h"

    19

#include "station.h"

    20

#include "waypoint.h"

    21

#include "debug.h"

    22

#include "variables.h"

    23

    24

static RailType _cur_railtype;

    25

static bool _remove_button_clicked;

    26

static DiagDirection _build_depot_direction;

    27

static byte _waypoint_count = 1;

    28

static byte _cur_waypoint_type;

    29

    30

static struct {

    31

	byte orientation;

    32

	byte numtracks;

    33

	byte platlength;

    34

	bool dragdrop;

    35

} _railstation;

    36

    37

    38

static void HandleStationPlacement(TileIndex start, TileIndex end);

    39

static void ShowBuildTrainDepotPicker(void);

    40

static void ShowBuildWaypointPicker(void);

    41

static void ShowStationBuilder(void);

    42

    43

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

    44

{

    45

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    46

}

    47

    48

static void GenericPlaceRail(TileIndex tile, int cmd)

    49

{

    50

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    51

		_remove_button_clicked ?

    52

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_AUTO | CMD_NO_WATER :

    53

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_AUTO | CMD_NO_WATER

    54

	);

    55

}

    56

    57

static void PlaceRail_N(TileIndex tile)

    58

{

    59

	int cmd = _tile_fract_coords.x > _tile_fract_coords.y ? 4 : 5;

    60

	GenericPlaceRail(tile, cmd);

    61

}

    62

    63

static void PlaceRail_NE(TileIndex tile)

    64

{

    65

	VpStartPlaceSizing(tile, VPM_FIX_Y);

    66

}

    67

    68

static void PlaceRail_E(TileIndex tile)

    69

{

    70

	int cmd = _tile_fract_coords.x + _tile_fract_coords.y <= 15 ? 2 : 3;

    71

	GenericPlaceRail(tile, cmd);

    72

}

    73

    74

static void PlaceRail_NW(TileIndex tile)

    75

{

    76

	VpStartPlaceSizing(tile, VPM_FIX_X);

    77

}

    78

    79

static void PlaceRail_AutoRail(TileIndex tile)

    80

{

    81

	VpStartPlaceSizing(tile, VPM_RAILDIRS);

    82

}

    83

    84

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

    85

{

    86

	if (GetRailTileType(tile) != RAIL_TYPE_NORMAL) return;

    87

	if ((GetTrackBits(tile) & GB(extra, 8, 8)) == 0) return;

    88

    89

	DoCommandP(tile, _cur_railtype, extra & 0xFF, NULL, CMD_BUILD_SINGLE_RAIL | CMD_AUTO | CMD_NO_WATER);

    90

}

    91

    92

static const uint16 _place_depot_extra[12] = {

    93

	0x604,		0x2102,		0x1202,		0x505,

    94

	0x2400,		0x2801,		0x1800,		0x1401,

    95

	0x2203,		0x904,		0x0A05,		0x1103,

    96

};

    97

    98

    99

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

   100

{

   101

	if (success) {

   102

		DiagDirection dir = p2;

   103

   104

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   105

		ResetObjectToPlace();

   106

   107

		tile += TileOffsByDir(dir);

   108

   109

		if (IsTileType(tile, MP_RAILWAY)) {

   110

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   111

			PlaceExtraDepotRail(tile, _place_depot_extra[dir + 4]);

   112

			PlaceExtraDepotRail(tile, _place_depot_extra[dir + 8]);

   113

		}

   114

	}

   115

}

   116

   117

static void PlaceRail_Depot(TileIndex tile)

   118

{

   119

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   120

		CMD_BUILD_TRAIN_DEPOT | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   121

}

   122

   123

static void PlaceRail_Waypoint(TileIndex tile)

   124

{

   125

	if (!_remove_button_clicked) {

   126

		DoCommandP(tile, _cur_waypoint_type, 0, CcPlaySound1E, CMD_BUILD_TRAIN_WAYPOINT | CMD_MSG(STR_CANT_BUILD_TRAIN_WAYPOINT));

   127

	} else {

   128

		DoCommandP(tile, 0, 0, CcPlaySound1E, CMD_REMOVE_TRAIN_WAYPOINT | CMD_MSG(STR_CANT_REMOVE_TRAIN_WAYPOINT));

   129

	}

   130

}

   131

   132

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

   133

{

   134

	if (success) {

   135

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   136

		ResetObjectToPlace();

   137

	}

   138

}

   139

   140

static void PlaceRail_Station(TileIndex tile)

   141

{

   142

	if (_remove_button_clicked)

   143

		DoCommandP(tile, 0, 0, CcPlaySound1E, CMD_REMOVE_FROM_RAILROAD_STATION | CMD_MSG(STR_CANT_REMOVE_PART_OF_STATION));

   144

	else if (_railstation.dragdrop) {

   145

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED);

   146

		VpSetPlaceSizingLimit(_patches.station_spread);

   147

	} else {

   148

		// TODO: Custom station selector GUI. Now we just try using first custom station

   149

		// (and fall back to normal stations if it isn't available).

   150

		DoCommandP(tile, _railstation.orientation | (_railstation.numtracks<<8) | (_railstation.platlength<<16),_cur_railtype|1<<4, CcStation,

   151

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_AUTO | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   152

	}

   153

}

   154

   155

static void GenericPlaceSignals(TileIndex tile)

   156

{

   157

	uint trackstat;

   158

	uint i;

   159

   160

	trackstat = (byte)GetTileTrackStatus(tile, TRANSPORT_RAIL);

   161

   162

	if ((trackstat & 0x30)) // N-S direction

   163

		trackstat = (_tile_fract_coords.x <= _tile_fract_coords.y) ? 0x20 : 0x10;

   164

   165

	if ((trackstat & 0x0C)) // E-W direction

   166

		trackstat = (_tile_fract_coords.x + _tile_fract_coords.y <= 15) ? 4 : 8;

   167

   168

	// Lookup the bit index

   169

	i = 0;

   170

	if (trackstat != 0) {

   171

		for (; !(trackstat & 1); trackstat >>= 1) i++;

   172

	}

   173

   174

	if (!_remove_button_clicked) {

   175

		DoCommandP(tile, i + (_ctrl_pressed ? 8 : 0), 0, CcPlaySound1E,

   176

			CMD_BUILD_SIGNALS | CMD_AUTO | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   177

	} else {

   178

		DoCommandP(tile, i, 0, CcPlaySound1E,

   179

			CMD_REMOVE_SIGNALS | CMD_AUTO | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   180

	}

   181

}

   182

   183

static void PlaceRail_Bridge(TileIndex tile)

   184

{

   185

	VpStartPlaceSizing(tile, VPM_X_OR_Y);

   186

}

   187

   188

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

   189

{

   190

	if (success) {

   191

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   192

		ResetObjectToPlace();

   193

	} else {

   194

		SetRedErrorSquare(_build_tunnel_endtile);

   195

	}

   196

}

   197

   198

static void PlaceRail_Tunnel(TileIndex tile)

   199

{

   200

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   201

		CMD_BUILD_TUNNEL | CMD_AUTO | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   202

}

   203

   204

void PlaceProc_BuyLand(TileIndex tile)

   205

{

   206

	DoCommandP(tile, 0, 0, CcPlaySound1E, CMD_PURCHASE_LAND_AREA | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_5806_CAN_T_PURCHASE_THIS_LAND));

   207

}

   208

   209

static void PlaceRail_ConvertRail(TileIndex tile)

   210

{

   211

	VpStartPlaceSizing(tile, VPM_X_AND_Y | GUI_PlaceProc_ConvertRailArea);

   212

}

   213

   214

static void PlaceRail_AutoSignals(TileIndex tile)

   215

{

   216

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS);

   217

}

   218

   219

static void BuildRailClick_N(Window *w)

   220

{

   221

	HandlePlacePushButton(w, 4, GetRailTypeInfo(_cur_railtype)->cursor.rail_ns, 1, PlaceRail_N);

   222

}

   223

   224

static void BuildRailClick_NE(Window *w)

   225

{

   226

	HandlePlacePushButton(w, 5, GetRailTypeInfo(_cur_railtype)->cursor.rail_swne, 1, PlaceRail_NE);

   227

}

   228

   229

static void BuildRailClick_E(Window *w)

   230

{

   231

	HandlePlacePushButton(w, 6, GetRailTypeInfo(_cur_railtype)->cursor.rail_ew, 1, PlaceRail_E);

   232

}

   233

   234

static void BuildRailClick_NW(Window *w)

   235

{

   236

	HandlePlacePushButton(w, 7, GetRailTypeInfo(_cur_railtype)->cursor.rail_nwse, 1, PlaceRail_NW);

   237

}

   238

   239

static void BuildRailClick_AutoRail(Window *w)

   240

{

   241

	HandlePlacePushButton(w, 8, GetRailTypeInfo(_cur_railtype)->cursor.autorail, VHM_RAIL, PlaceRail_AutoRail);

   242

}

   243

   244

static void BuildRailClick_Demolish(Window *w)

   245

{

   246

	HandlePlacePushButton(w, 9, ANIMCURSOR_DEMOLISH, 1, PlaceProc_DemolishArea);

   247

}

   248

   249

static void BuildRailClick_Depot(Window *w)

   250

{

   251

	if (HandlePlacePushButton(w, 10, GetRailTypeInfo(_cur_railtype)->cursor.depot, 1, PlaceRail_Depot)) {

   252

		ShowBuildTrainDepotPicker();

   253

	}

   254

}

   255

   256

static void BuildRailClick_Waypoint(Window *w)

   257

{

   258

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   259

	if (HandlePlacePushButton(w, 11, SPR_CURSOR_WAYPOINT, 1, PlaceRail_Waypoint) &&

   260

			_waypoint_count > 1) {

   261

		ShowBuildWaypointPicker();

   262

	}

   263

}

   264

   265

static void BuildRailClick_Station(Window *w)

   266

{

   267

	if (HandlePlacePushButton(w, 12, SPR_CURSOR_RAIL_STATION, 1, PlaceRail_Station)) ShowStationBuilder();

   268

}

   269

   270

static void BuildRailClick_AutoSignals(Window *w)

   271

{

   272

	HandlePlacePushButton(w, 13, ANIMCURSOR_BUILDSIGNALS, VHM_RECT, PlaceRail_AutoSignals);

   273

}

   274

   275

static void BuildRailClick_Bridge(Window *w)

   276

{

   277

	HandlePlacePushButton(w, 14, SPR_CURSOR_BRIDGE, 1, PlaceRail_Bridge);

   278

}

   279

   280

static void BuildRailClick_Tunnel(Window *w)

   281

{

   282

	HandlePlacePushButton(w, 15, GetRailTypeInfo(_cur_railtype)->cursor.tunnel, 3, PlaceRail_Tunnel);

   283

}

   284

   285

static void BuildRailClick_Remove(Window *w)

   286

{

   287

	if (HASBIT(w->disabled_state, 16)) return;

   288

	SetWindowDirty(w);

   289

	SndPlayFx(SND_15_BEEP);

   290

   291

	TOGGLEBIT(w->click_state, 16);

   292

	_remove_button_clicked = HASBIT(w->click_state, 16);

   293

	SetSelectionRed(HASBIT(w->click_state, 16));

   294

   295

	// handle station builder

   296

	if (HASBIT(w->click_state, 16)) {

   297

		if (_remove_button_clicked) {

   298

			SetTileSelectSize(1, 1);

   299

		} else {

   300

			BringWindowToFrontById(WC_BUILD_STATION, 0);

   301

		}

   302

	}

   303

}

   304

   305

static void BuildRailClick_Convert(Window *w)

   306

{

   307

	HandlePlacePushButton(w, 17, GetRailTypeInfo(_cur_railtype)->cursor.convert, 1, PlaceRail_ConvertRail);

   308

}

   309

   310

static void BuildRailClick_Landscaping(Window *w)

   311

{

   312

	ShowTerraformToolbar();

   313

}

   314

   315

static void DoRailroadTrack(int mode)

   316

{

   317

	DoCommandP(TileVirtXY(_thd.selstart.x, _thd.selstart.y), TileVirtXY(_thd.selend.x, _thd.selend.y), _cur_railtype | (mode << 4), NULL,

   318

		_remove_button_clicked ?

   319

		CMD_REMOVE_RAILROAD_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   320

		CMD_BUILD_RAILROAD_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   321

	);

   322

}

   323

   324

static void HandleAutodirPlacement(void)

   325

{

   326

	TileHighlightData *thd = &_thd;

   327

	int trackstat = thd->drawstyle & 0xF; // 0..5

   328

   329

	if (thd->drawstyle & HT_RAIL) { // one tile case

   330

		GenericPlaceRail(TileVirtXY(thd->selend.x, thd->selend.y), trackstat);

   331

		return;

   332

	}

   333

   334

	DoRailroadTrack(trackstat);

   335

}

   336

   337

static void HandleAutoSignalPlacement(void)

   338

{

   339

	TileHighlightData *thd = &_thd;

   340

	byte trackstat = thd->drawstyle & 0xF; // 0..5

   341

   342

	if (thd->drawstyle == HT_RECT) { // one tile case

   343

		GenericPlaceSignals(TileVirtXY(thd->selend.x, thd->selend.y));

   344

		return;

   345

	}

   346

   347

	// _patches.drag_signals_density is given as a parameter such that each user in a network

   348

	// game can specify his/her own signal density

   349

	DoCommandP(

   350

		TileVirtXY(thd->selstart.x, thd->selstart.y),

   351

		TileVirtXY(thd->selend.x, thd->selend.y),

   352

		(_ctrl_pressed ? 1 << 3 : 0) | (trackstat << 4) | (_patches.drag_signals_density << 24),

   353

		CcPlaySound1E,

   354

		_remove_button_clicked ?

   355

			CMD_REMOVE_SIGNAL_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   356

			CMD_BUILD_SIGNAL_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   357

	);

   358

}

   359

   360

   361

typedef void OnButtonClick(Window *w);

   362

   363

static OnButtonClick * const _build_railroad_button_proc[] = {

   364

	BuildRailClick_N,

   365

	BuildRailClick_NE,

   366

	BuildRailClick_E,

   367

	BuildRailClick_NW,

   368

	BuildRailClick_AutoRail,

   369

	BuildRailClick_Demolish,

   370

	BuildRailClick_Depot,

   371

	BuildRailClick_Waypoint,

   372

	BuildRailClick_Station,

   373

	BuildRailClick_AutoSignals,

   374

	BuildRailClick_Bridge,

   375

	BuildRailClick_Tunnel,

   376

	BuildRailClick_Remove,

   377

	BuildRailClick_Convert,

   378

	BuildRailClick_Landscaping,

   379

};

   380

   381

static const uint16 _rail_keycodes[] = {

   382

	'1',

   383

	'2',

   384

	'3',

   385

	'4',

   386

	'5',

   387

	'6',

   388

	'7', // depot

   389

	'8', // waypoint

   390

	'9', // station

   391

	'S', // signals

   392

	'B', // bridge

   393

	'T', // tunnel

   394

	'R', // remove

   395

	'C', // convert rail

   396

	'L', // landscaping

   397

};

   398

   399

   400

static void BuildRailToolbWndProc(Window *w, WindowEvent *e)

   401

{

   402

	switch (e->event) {

   403

	case WE_PAINT:

   404

		w->disabled_state &= ~(1 << 16);

   405

		if (!(w->click_state & ((1<<4)|(1<<5)|(1<<6)|(1<<7)|(1<<8)|(1<<11)|(1<<12)|(1<<13)))) {

   406

			w->disabled_state |= (1 << 16);

   407

			w->click_state &= ~(1<<16);

   408

		}

   409

		DrawWindowWidgets(w);

   410

		break;

   411

   412

	case WE_CLICK:

   413

		if (e->click.widget >= 4) {

   414

			_remove_button_clicked = false;

   415

			_build_railroad_button_proc[e->click.widget - 4](w);

   416

		}

   417

	break;

   418

   419

	case WE_KEYPRESS: {

   420

		uint i;

   421

   422

		for (i = 0; i != lengthof(_rail_keycodes); i++) {

   423

			if (e->keypress.keycode == _rail_keycodes[i]) {

   424

				e->keypress.cont = false;

   425

				_remove_button_clicked = false;

   426

				_build_railroad_button_proc[i](w);

   427

				break;

   428

			}

   429

		}

   430

		MarkTileDirty(_thd.pos.x, _thd.pos.y); // redraw tile selection

   431

		break;

   432

	}

   433

   434

	case WE_PLACE_OBJ:

   435

		_place_proc(e->place.tile);

   436

		return;

   437

   438

	case WE_PLACE_DRAG: {

   439

		VpSelectTilesWithMethod(e->place.pt.x, e->place.pt.y, e->place.userdata & 0xF);

   440

		return;

   441

	}

   442

   443

	case WE_PLACE_MOUSEUP:

   444

		if (e->click.pt.x != -1) {

   445

			TileIndex start_tile = e->place.starttile;

   446

			TileIndex end_tile = e->place.tile;

   447

   448

			if (e->place.userdata == VPM_X_OR_Y) {

   449

				ResetObjectToPlace();

   450

				ShowBuildBridgeWindow(start_tile, end_tile, _cur_railtype);

   451

			} else if (e->place.userdata == VPM_RAILDIRS) {

   452

				bool old = _remove_button_clicked;

   453

				if (_ctrl_pressed) _remove_button_clicked = true;

   454

				HandleAutodirPlacement();

   455

				_remove_button_clicked = old;

   456

			} else if (e->place.userdata == VPM_SIGNALDIRS) {

   457

				HandleAutoSignalPlacement();

   458

			} else if ((e->place.userdata & 0xF) == VPM_X_AND_Y) {

   459

				if (GUIPlaceProcDragXY(e)) break;

   460

   461

				if ((e->place.userdata >> 4) == GUI_PlaceProc_ConvertRailArea >> 4)

   462

					DoCommandP(end_tile, start_tile, _cur_railtype, CcPlaySound10, CMD_CONVERT_RAIL | CMD_MSG(STR_CANT_CONVERT_RAIL));

   463

			} else if (e->place.userdata == VPM_X_AND_Y_LIMITED) {

   464

				HandleStationPlacement(start_tile, end_tile);

   465

			} else

   466

				DoRailroadTrack(e->place.userdata & 1);

   467

		}

   468

		break;

   469

   470

	case WE_ABORT_PLACE_OBJ:

   471

		UnclickWindowButtons(w);

   472

		SetWindowDirty(w);

   473

   474

		w = FindWindowById(WC_BUILD_STATION, 0);

   475

		if (w != NULL) WP(w,def_d).close = true;

   476

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   477

		if (w != NULL) WP(w,def_d).close = true;

   478

		break;

   479

   480

	case WE_PLACE_PRESIZE: {

   481

		TileIndex tile = e->place.tile;

   482

   484

		VpSetPresizeRange(tile, _build_tunnel_endtile == 0 ? tile : _build_tunnel_endtile);

   485

	} break;

   486

   487

	case WE_DESTROY:

   488

		if (_patches.link_terraform_toolbar) DeleteWindowById(WC_SCEN_LAND_GEN, 0);

   489

		break;

   490

	}

   491

}

   492

   493

   494

static const Widget _build_rail_widgets[] = {

   495

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

   496

{    WWT_CAPTION,   RESIZE_NONE,     7,    11,   359,     0,    13, STR_100A_RAILROAD_CONSTRUCTION, STR_018C_WINDOW_TITLE_DRAG_THIS},

   497

{  WWT_STICKYBOX,   RESIZE_NONE,     7,   360,   371,     0,    13, 0x0,     STR_STICKY_BUTTON},

   498

   499

{      WWT_PANEL,   RESIZE_NONE,     7,   110,   113,    14,    35, 0x0,			STR_NULL},