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 byte _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

	byte b = _m[tile].m5;

    87

    88

	if (GB(b, 6, 2) != RAIL_TYPE_NORMAL >> 6) return;

    89

	if (!(b & (extra >> 8))) return;

    90

    91

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

    92

}

    93

    94

static const uint16 _place_depot_extra[12] = {

    95

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

    96

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

    97

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

    98

};

    99

   100

   101

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

   102

{

   103

	if (success) {

   104

		int dir = p2;

   105

   106

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   107

		ResetObjectToPlace();

   108

   109

		tile += TileOffsByDir(dir);

   110

   111

		if (IsTileType(tile, MP_RAILWAY)) {

   112

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   113

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

   114

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

   115

		}

   116

	}

   117

}

   118

   119

static void PlaceRail_Depot(TileIndex tile)

   120

{

   121

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   122

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

   123

}

   124

   125

static void PlaceRail_Waypoint(TileIndex tile)

   126

{

   127

	if (!_remove_button_clicked) {

   128

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

   129

	} else {

   130

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

   131

	}

   132

}

   133

   134

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

   135

{

   136

	if (success) {

   137

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   138

		ResetObjectToPlace();

   139

	}

   140

}

   141

   142

static void PlaceRail_Station(TileIndex tile)

   143

{

   144

	if(_remove_button_clicked)

   145

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

   146

	else if (_railstation.dragdrop) {

   147

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED);

   148

		VpSetPlaceSizingLimit(_patches.station_spread);

   149

	} else {

   150

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

   151

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

   152

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

   153

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

   154

	}

   155

}

   156

   157

static void GenericPlaceSignals(TileIndex tile)

   158

{

   159

	uint trackstat;

   160

	uint i;

   161

   162

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

   163

   164

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

   165

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

   166

   167

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

   168

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

   169

   170

	// Lookup the bit index

   171

	i = 0;

   172

	if (trackstat != 0) {

   173

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

   174

	}

   175

   176

	if (!_remove_button_clicked) {

   177

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

   178

			CMD_BUILD_SIGNALS | CMD_AUTO | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   179

	} else {

   180

		DoCommandP(tile, i, 0, CcPlaySound1E,

   181

			CMD_REMOVE_SIGNALS | CMD_AUTO | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   182

	}

   183

}

   184

   185

static void PlaceRail_Bridge(TileIndex tile)

   186

{

   187

	VpStartPlaceSizing(tile, VPM_X_OR_Y);

   188

}

   189

   190

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

   191

{

   192

	if (success) {

   193

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   194

		ResetObjectToPlace();

   195

	} else {

   196

		SetRedErrorSquare(_build_tunnel_endtile);

   197

	}

   198

}

   199

   200

static void PlaceRail_Tunnel(TileIndex tile)

   201

{

   202

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   203

		CMD_BUILD_TUNNEL | CMD_AUTO | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   204

}

   205

   206

void PlaceProc_BuyLand(TileIndex tile)

   207

{

   208

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

   209

}

   210

   211

static void PlaceRail_ConvertRail(TileIndex tile)

   212

{

   213

	VpStartPlaceSizing(tile, VPM_X_AND_Y | GUI_PlaceProc_ConvertRailArea);

   214

}

   215

   216

static void PlaceRail_AutoSignals(TileIndex tile)

   217

{

   218

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS);

   219

}

   220

   221

static void BuildRailClick_N(Window *w)

   222

{

   223

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

   224

}

   225

   226

static void BuildRailClick_NE(Window *w)

   227

{

   228

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

   229

}

   230

   231

static void BuildRailClick_E(Window *w)

   232

{

   233

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

   234

}

   235

   236

static void BuildRailClick_NW(Window *w)

   237

{

   238

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

   239

}

   240

   241

static void BuildRailClick_AutoRail(Window *w)

   242

{

   243

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

   244

}

   245

   246

static void BuildRailClick_Demolish(Window *w)

   247

{

   248

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

   249

}

   250

   251

static void BuildRailClick_Depot(Window *w)

   252

{

   253

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

   254

		ShowBuildTrainDepotPicker();

   255

	}

   256

}

   257

   258

static void BuildRailClick_Waypoint(Window *w)

   259

{

   260

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   261

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

   262

			_waypoint_count > 1) {

   263

		ShowBuildWaypointPicker();

   264

	}

   265

}

   266

   267

static void BuildRailClick_Station(Window *w)

   268

{

   269

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

   270

}

   271

   272

static void BuildRailClick_AutoSignals(Window *w)

   273

{

   274

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

   275

}

   276

   277

static void BuildRailClick_Bridge(Window *w)

   278

{

   279

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

   280

}

   281

   282

static void BuildRailClick_Tunnel(Window *w)

   283

{

   284

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

   285

}

   286

   287

static void BuildRailClick_Remove(Window *w)

   288

{

   289

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

   290

	SetWindowDirty(w);

   291

	SndPlayFx(SND_15_BEEP);

   292

   293

	TOGGLEBIT(w->click_state, 16);

   294

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

   295

	SetSelectionRed(HASBIT(w->click_state, 16) != 0);

   296

   297

	// handle station builder

   298

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

   299

		if (_remove_button_clicked) {

   300

			SetTileSelectSize(1, 1);

   301

		} else {

   302

			BringWindowToFrontById(WC_BUILD_STATION, 0);

   303

		}

   304

	}

   305

}

   306

   307

static void BuildRailClick_Convert(Window *w)

   308

{

   309

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

   310

}

   311

   312

static void BuildRailClick_Landscaping(Window *w)

   313

{

   314

	ShowTerraformToolbar();

   315

}

   316

   317

static void DoRailroadTrack(int mode)

   318

{

   319

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

   320

		_remove_button_clicked ?

   321

		CMD_REMOVE_RAILROAD_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   322

		CMD_BUILD_RAILROAD_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   323

	);

   324

}

   325

   326

static void HandleAutodirPlacement(void)

   327

{

   328

	TileHighlightData *thd = &_thd;

   329

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

   330

   331

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

   332

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

   333

		return;

   334

	}

   335

   336

	DoRailroadTrack(trackstat);

   337

}

   338

   339

static void HandleAutoSignalPlacement(void)

   340

{

   341

	TileHighlightData *thd = &_thd;

   342

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

   343

   344

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

   345

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

   346

		return;

   347

	}

   348

   349

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

   350

	// game can specify his/her own signal density

   351

	DoCommandP(

   352

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

   353

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

   354

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

   355

		CcPlaySound1E,

   356

		_remove_button_clicked ?

   357

			CMD_REMOVE_SIGNAL_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   358

			CMD_BUILD_SIGNAL_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   359

	);

   360

}

   361

   362

   363

typedef void OnButtonClick(Window *w);

   364

   365

static OnButtonClick * const _build_railroad_button_proc[] = {

   366

	BuildRailClick_N,

   367

	BuildRailClick_NE,

   368

	BuildRailClick_E,

   369

	BuildRailClick_NW,

   370

	BuildRailClick_AutoRail,

   371

	BuildRailClick_Demolish,

   372

	BuildRailClick_Depot,

   373

	BuildRailClick_Waypoint,

   374

	BuildRailClick_Station,

   375

	BuildRailClick_AutoSignals,

   376

	BuildRailClick_Bridge,

   377

	BuildRailClick_Tunnel,

   378

	BuildRailClick_Remove,

   379

	BuildRailClick_Convert,

   380

	BuildRailClick_Landscaping,

   381

};

   382

   383

static const uint16 _rail_keycodes[] = {

   384

	'1',

   385

	'2',

   386

	'3',

   387

	'4',

   388

	'5',

   389

	'6',

   390

	'7', // depot

   391

	'8', // waypoint

   392

	'9', // station

   393

	'S', // signals

   394

	'B', // bridge

   395

	'T', // tunnel

   396

	'R', // remove

   397

	'C', // convert rail

   398

	'L', // landscaping

   399

};

   400

   401

   402

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

   403

{

   404

	switch (e->event) {

   405

	case WE_PAINT:

   406

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

   407

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

   408

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

   409

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

   410

		}

   411

		DrawWindowWidgets(w);

   412

		break;

   413

   414

	case WE_CLICK:

   415

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

   416

			_remove_button_clicked = false;

   417

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

   418

		}

   419

	break;

   420

   421

	case WE_KEYPRESS: {

   422

		uint i;

   423

   424

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

   425

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

   426

				e->keypress.cont = false;

   427

				_remove_button_clicked = false;

   428

				_build_railroad_button_proc[i](w);

   429

				break;

   430

			}

   431

		}

   432

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

   433

		break;

   434

	}

   435

   436

	case WE_PLACE_OBJ:

   437

		_place_proc(e->place.tile);

   438

		return;

   439

   440

	case WE_PLACE_DRAG: {

   441

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

   442

		return;

   443

	}

   444

   445

	case WE_PLACE_MOUSEUP:

   446

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

   447

			TileIndex start_tile = e->place.starttile;

   448

			TileIndex end_tile = e->place.tile;

   449

   450

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

   451

				ResetObjectToPlace();

   452

				ShowBuildBridgeWindow(start_tile, end_tile, _cur_railtype);

   453

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

   454

				bool old = _remove_button_clicked;

   455

				if (_ctrl_pressed) _remove_button_clicked = true;

   456

				HandleAutodirPlacement();

   457

				_remove_button_clicked = old;

   458

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

   459

				HandleAutoSignalPlacement();

   460

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

   461

				if (GUIPlaceProcDragXY(e)) break;

   462

   463

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

   464

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

   465

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

   466

				HandleStationPlacement(start_tile, end_tile);

   467

			} else

   468

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

   469

		}

   470

		break;

   471

   472

	case WE_ABORT_PLACE_OBJ:

   473

		UnclickWindowButtons(w);

   474

		SetWindowDirty(w);

   475

   476

		w = FindWindowById(WC_BUILD_STATION, 0);

   477

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

   478

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   479

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

   480

		break;

   481

   482

	case WE_PLACE_PRESIZE: {

   483

		TileIndex tile = e->place.tile;

   484

   485

		DoCommandByTile(tile, 0, 0, DC_AUTO, CMD_BUILD_TUNNEL);

   486

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

   487

	} break;

   488

   489

	case WE_DESTROY:

   490

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

   491

		break;

   492

	}

   493

}

   494

   495

   496

static const Widget _build_rail_widgets[] = {

   497

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

   498

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

   499

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

   500