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.

   149

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

   150

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

   151

	}

   152

}

   153

   154

static void GenericPlaceSignals(TileIndex tile)

   155

{

   156

	uint trackstat;

   157

	uint i;

   158

   159

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

   160

   161

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

   162

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

   163

   164

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

   165

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

   166

   167

	// Lookup the bit index

   168

	i = 0;

   169

	if (trackstat != 0) {

   170

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

   171

	}

   172

   173

	if (!_remove_button_clicked) {

   174

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

   175

			CMD_BUILD_SIGNALS | CMD_AUTO | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   176

	} else {

   177

		DoCommandP(tile, i, 0, CcPlaySound1E,

   178

			CMD_REMOVE_SIGNALS | CMD_AUTO | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   179

	}

   180

}

   181

   182

static void PlaceRail_Bridge(TileIndex tile)

   183

{

   184

	VpStartPlaceSizing(tile, VPM_X_OR_Y);

   185

}

   186

   187

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

   188

{

   189

	if (success) {

   190

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   191

		ResetObjectToPlace();

   192

	} else {

   193

		SetRedErrorSquare(_build_tunnel_endtile);

   194

	}

   195

}

   196

   197

static void PlaceRail_Tunnel(TileIndex tile)

   198

{

   199

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   200

		CMD_BUILD_TUNNEL | CMD_AUTO | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   201

}

   202

   203

void PlaceProc_BuyLand(TileIndex tile)

   204

{

   205

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

   206

}

   207

   208

static void PlaceRail_ConvertRail(TileIndex tile)

   209

{

   210

	VpStartPlaceSizing(tile, VPM_X_AND_Y | GUI_PlaceProc_ConvertRailArea);

   211

}

   212

   213

static void PlaceRail_AutoSignals(TileIndex tile)

   214

{

   215

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS);

   216

}

   217

   218

static void BuildRailClick_N(Window *w)

   219

{

   220

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

   221

}

   222

   223

static void BuildRailClick_NE(Window *w)

   224

{

   225

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

   226

}

   227

   228

static void BuildRailClick_E(Window *w)

   229

{

   230

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

   231

}

   232

   233

static void BuildRailClick_NW(Window *w)

   234

{

   235

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

   236

}

   237

   238

static void BuildRailClick_AutoRail(Window *w)

   239

{

   240

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

   241

}

   242

   243

static void BuildRailClick_Demolish(Window *w)

   244

{

   245

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

   246

}

   247

   248

static void BuildRailClick_Depot(Window *w)

   249

{

   250

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

   251

		ShowBuildTrainDepotPicker();

   252

	}

   253

}

   254

   255

static void BuildRailClick_Waypoint(Window *w)

   256

{

   257

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   258

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

   259

			_waypoint_count > 1) {

   260

		ShowBuildWaypointPicker();

   261

	}

   262

}

   263

   264

static void BuildRailClick_Station(Window *w)

   265

{

   266

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

   267

}

   268

   269

static void BuildRailClick_AutoSignals(Window *w)

   270

{

   271

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

   272

}

   273

   274

static void BuildRailClick_Bridge(Window *w)

   275

{

   276

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

   277

}

   278

   279

static void BuildRailClick_Tunnel(Window *w)

   280

{

   281

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

   282

}

   283

   284

static void BuildRailClick_Remove(Window *w)

   285

{

   286

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

   287

	SetWindowDirty(w);

   288

	SndPlayFx(SND_15_BEEP);

   289

   290

	TOGGLEBIT(w->click_state, 16);

   291

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

   292

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

   293

   294

	// handle station builder

   295

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

   296

		if (_remove_button_clicked) {

   297

			SetTileSelectSize(1, 1);

   298

		} else {

   299

			BringWindowToFrontById(WC_BUILD_STATION, 0);

   300

		}

   301

	}

   302

}

   303

   304

static void BuildRailClick_Convert(Window *w)

   305

{

   306

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

   307

}

   308

   309

static void BuildRailClick_Landscaping(Window *w)

   310

{

   311

	ShowTerraformToolbar();

   312

}

   313

   314

static void DoRailroadTrack(int mode)

   315

{

   316

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

   317

		_remove_button_clicked ?

   318

		CMD_REMOVE_RAILROAD_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   319

		CMD_BUILD_RAILROAD_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   320

	);

   321

}

   322

   323

static void HandleAutodirPlacement(void)

   324

{

   325

	TileHighlightData *thd = &_thd;

   326

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

   327

   328

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

   329

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

   330

		return;

   331

	}

   332

   333

	DoRailroadTrack(trackstat);

   334

}

   335

   336

static void HandleAutoSignalPlacement(void)

   337

{

   338

	TileHighlightData *thd = &_thd;

   339

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

   340

   341

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

   342

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

   343

		return;

   344

	}

   345

   346

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

   347

	// game can specify his/her own signal density

   348

	DoCommandP(

   349

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

   350

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

   351

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

   352

		CcPlaySound1E,

   353

		_remove_button_clicked ?

   354

			CMD_REMOVE_SIGNAL_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   355

			CMD_BUILD_SIGNAL_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   356

	);

   357

}

   358

   359

   360

typedef void OnButtonClick(Window *w);

   361

   362

static OnButtonClick * const _build_railroad_button_proc[] = {

   363

	BuildRailClick_N,

   364

	BuildRailClick_NE,

   365

	BuildRailClick_E,

   366

	BuildRailClick_NW,

   367

	BuildRailClick_AutoRail,

   368

	BuildRailClick_Demolish,

   369

	BuildRailClick_Depot,

   370

	BuildRailClick_Waypoint,

   371

	BuildRailClick_Station,

   372

	BuildRailClick_AutoSignals,

   373

	BuildRailClick_Bridge,

   374

	BuildRailClick_Tunnel,

   375

	BuildRailClick_Remove,

   376

	BuildRailClick_Convert,

   377

	BuildRailClick_Landscaping,

   378

};

   379

   380

static const uint16 _rail_keycodes[] = {

   381

	'1',

   382

	'2',

   383

	'3',

   384

	'4',

   385

	'5',

   386

	'6',

   387

	'7', // depot

   388

	'8', // waypoint

   389

	'9', // station

   390

	'S', // signals

   391

	'B', // bridge

   392

	'T', // tunnel

   393

	'R', // remove

   394

	'C', // convert rail

   395

	'L', // landscaping

   396

};

   397

   398

   399

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

   400

{

   401

	switch (e->event) {

   402

	case WE_PAINT:

   403

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

   404

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

   405

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

   406

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

   407

		}

   408

		DrawWindowWidgets(w);

   409

		break;

   410

   411

	case WE_CLICK:

   412

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

   413

			_remove_button_clicked = false;

   414

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

   415

		}

   416

	break;

   417

   418

	case WE_KEYPRESS: {

   419

		uint i;

   420

   421

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

   422

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

   423

				e->keypress.cont = false;

   424

				_remove_button_clicked = false;

   425

				_build_railroad_button_proc[i](w);

   426

				break;

   427

			}

   428

		}

   429

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

   430

		break;

   431

	}

   432

   433

	case WE_PLACE_OBJ:

   434

		_place_proc(e->place.tile);

   435

		return;

   436

   437

	case WE_PLACE_DRAG: {

   438

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

   439

		return;

   440

	}

   441

   442

	case WE_PLACE_MOUSEUP:

   443

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

   444

			TileIndex start_tile = e->place.starttile;

   445

			TileIndex end_tile = e->place.tile;

   446

   447

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

   448

				ResetObjectToPlace();

   449

				ShowBuildBridgeWindow(start_tile, end_tile, _cur_railtype);

   450

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

   451

				bool old = _remove_button_clicked;

   452

				if (_ctrl_pressed) _remove_button_clicked = true;

   453

				HandleAutodirPlacement();

   454

				_remove_button_clicked = old;

   455

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

   456

				HandleAutoSignalPlacement();

   457

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

   458

				if (GUIPlaceProcDragXY(e)) break;

   459

   460

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

   461

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

   462

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

   463

				HandleStationPlacement(start_tile, end_tile);

   464

			} else

   465

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

   466

		}

   467

		break;

   468

   469

	case WE_ABORT_PLACE_OBJ:

   470

		UnclickWindowButtons(w);

   471

		SetWindowDirty(w);

   472

   473

		w = FindWindowById(WC_BUILD_STATION, 0);

   474

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

   475

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   476

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

   477

		break;

   478

   479

	case WE_PLACE_PRESIZE: {

   480

		TileIndex tile = e->place.tile;

   481

   482

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

   483

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

   484

	} break;

   485

   486

	case WE_DESTROY:

   487

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

   488

		break;

   489

	}

   490

}

   491

   492

   493

static const Widget _build_rail_widgets[] = {

   494

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

   495

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

   496

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

   497

   498

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

   499