1

/* $Id$ */

     2

     3

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

     4

     5

#include "stdafx.h"

     7

#include "openttd.h"

     8

#include "tile_cmd.h"

     9

#include "landscape.h"

    10

#include "gui.h"

    11

#include "window_gui.h"

    12

#include "station_gui.h"

    13

#include "terraform_gui.h"

    14

#include "viewport_func.h"

    15

#include "gfx_func.h"

    16

#include "command_func.h"

    17

#include "town_type.h"

    18

#include "waypoint.h"

    19

#include "debug.h"

    20

#include "variables.h"

    21

#include "newgrf_callbacks.h"

    22

#include "newgrf_station.h"

    23

#include "train.h"

    24

#include "strings_func.h"

    25

#include "functions.h"

    26

#include "window_func.h"

    27

#include "date_func.h"

    28

#include "sound_func.h"

    29

#include "player_func.h"

    30

#include "settings_type.h"

    31

#include "widgets/dropdown_type.h"

    32

#include "widgets/dropdown_func.h"

    33

#include "tunnelbridge.h"

    34

#include "tilehighlight_func.h"

    35

    36

#include "bridge_map.h"

    37

#include "rail_map.h"

    38

#include "road_map.h"

    39

#include "station_map.h"

    40

#include "tunnel_map.h"

    41

#include "tunnelbridge_map.h"

    42

    43

#include "table/sprites.h"

    44

#include "table/strings.h"

    45

    46

static RailType _cur_railtype;               ///< Rail type of the current build-rail toolbar.

    47

static bool _remove_button_clicked;          ///< Flag whether 'remove' toggle-button is currently enabled

    48

static DiagDirection _build_depot_direction; ///< Currently selected depot direction

    49

static byte _waypoint_count = 1;             ///< Number of waypoint types

    50

static byte _cur_waypoint_type;              ///< Currently selected waypoint type

    51

static bool _convert_signal_button;          ///< convert signal button in the signal GUI pressed

    52

static SignalVariant _cur_signal_variant;    ///< set the signal variant (for signal GUI)

    53

static SignalType _cur_signal_type;          ///< set the signal type (for signal GUI)

    54

    57

	byte numtracks;                   ///< Currently selected number of tracks in station (if not \c dragdrop )

    58

	byte platlength;                  ///< Currently selected platform length of station (if not \c dragdrop )

    59

	bool dragdrop;                    ///< Use drag & drop to place a station

    60

    61

	bool newstations;                 ///< Are custom station definitions available?

    62

	StationClassIDByte station_class; ///< Currently selected custom station class (if newstations is \c true )

    63

	byte station_type;                ///< Station type within the currently selected custom station class (if newstations is \c true )

    64

	byte station_count;               ///< Number of custom stations (if newstations is \c true )

    67

    68

    69

static void HandleStationPlacement(TileIndex start, TileIndex end);

    70

static void ShowBuildTrainDepotPicker(Window *parent);

    71

static void ShowBuildWaypointPicker(Window *parent);

    72

static void ShowStationBuilder(Window *parent);

    73

static void ShowSignalBuilder(Window *parent);

    74

    75

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

    76

{

    77

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    78

}

    79

    80

static void GenericPlaceRail(TileIndex tile, int cmd)

    81

{

    82

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    83

		_remove_button_clicked ?

    84

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    85

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    86

	);

    87

}

    88

    89

static void PlaceRail_N(TileIndex tile)

    90

{

    91

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

    92

	GenericPlaceRail(tile, cmd);

    93

}

    94

    95

static void PlaceRail_NE(TileIndex tile)

    96

{

    97

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    98

}

    99

   100

static void PlaceRail_E(TileIndex tile)

   101

{

   102

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

   103

	GenericPlaceRail(tile, cmd);

   104

}

   105

   106

static void PlaceRail_NW(TileIndex tile)

   107

{

   108

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   109

}

   110

   111

static void PlaceRail_AutoRail(TileIndex tile)

   112

{

   113

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   114

}

   115

   116

/**

   117

 * Try to add an additional rail-track at the entrance of a depot

   118

 * @param tile  Tile to use for adding the rail-track

   119

 * @param extra Track to add

   120

 * @see CcRailDepot()

   121

 */

   122

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   123

{

   124

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

   125

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

   126

   127

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

   128

}

   129

   130

/** Additional pieces of track to add at the entrance of a depot. */

   131

static const uint16 _place_depot_extra[12] = {

   132

	0x0604, 0x2102, 0x1202, 0x0505,  // First additional track for directions 0..3

   133

	0x2400, 0x2801, 0x1800, 0x1401,  // Second additional track

   134

	0x2203, 0x0904, 0x0A05, 0x1103,  // Third additional track

   135

};

   136

   137

   138

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

   139

{

   140

	if (success) {

   141

		DiagDirection dir = (DiagDirection)p2;

   142

   143

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   144

		ResetObjectToPlace();

   145

   146

		tile += TileOffsByDiagDir(dir);

   147

   148

		if (IsTileType(tile, MP_RAILWAY)) {

   149

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   150

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

   151

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

   152

		}

   153

	}

   154

}

   155

   156

static void PlaceRail_Depot(TileIndex tile)

   157

{

   158

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   159

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   160

}

   161

   162

static void PlaceRail_Waypoint(TileIndex tile)

   163

{

   164

	if (_remove_button_clicked) {

   165

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

   166

	} else {

   167

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

   168

	}

   169

}

   170

   171

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

   172

{

   173

	if (success) {

   174

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   175

		/* Only close the station builder window if the default station is chosen. */

   176

		if (_railstation.station_class == STAT_CLASS_DFLT && _railstation.station_type == 0) ResetObjectToPlace();

   177

	}

   178

}

   179

   180

static void PlaceRail_Station(TileIndex tile)

   181

{

   182

	if (_remove_button_clicked) {

   183

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_REMOVE_STATION);

   184

		VpSetPlaceSizingLimit(-1);

   185

	} else if (_railstation.dragdrop) {

   186

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   187

		VpSetPlaceSizingLimit(_settings_game.station.station_spread);

   188

	} else {

   189

		DoCommandP(tile,

   190

				_railstation.orientation | (_railstation.numtracks << 8) | (_railstation.platlength << 16) | (_ctrl_pressed << 24),

   191

				_cur_railtype | (_railstation.station_class << 8) | (_railstation.station_type << 16), CcStation,

   192

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   193

	}

   194

}

   195

   196

/**

   197

 * Build a new signal or edit/remove a present signal, use CmdBuildSingleSignal() or CmdRemoveSingleSignal() in rail_cmd.cpp

   198

 *

   199

 * @param tile The tile where the signal will build or edit

   200

 */

   201

static void GenericPlaceSignals(TileIndex tile)

   202

{

   203

	TrackBits trackbits = TrackStatusToTrackBits(GetTileTrackStatus(tile, TRANSPORT_RAIL, 0));

   204

   205

	if (trackbits & TRACK_BIT_VERT) { // N-S direction

   206

		trackbits = (_tile_fract_coords.x <= _tile_fract_coords.y) ? TRACK_BIT_RIGHT : TRACK_BIT_LEFT;

   207

	}

   208

   209

	if (trackbits & TRACK_BIT_HORZ) { // E-W direction

   210

		trackbits = (_tile_fract_coords.x + _tile_fract_coords.y <= 15) ? TRACK_BIT_UPPER : TRACK_BIT_LOWER;

   211

	}

   212

   213

	Track track = FindFirstTrack(trackbits);

   214

   215

	if (_remove_button_clicked) {

   216

		DoCommandP(tile, track, 0, CcPlaySound1E,

   217

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   218

	} else {

   219

		const Window *w = FindWindowById(WC_BUILD_SIGNAL, 0);

   220

   221

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   222

		uint32 p1 = track;

   223

   224

		if (w != NULL) {

   225

			/* signal GUI is used */

   226

			SB(p1, 3, 1, _ctrl_pressed);

   227

			SB(p1, 4, 1, _cur_signal_variant);

   228

			SB(p1, 5, 2, _cur_signal_type);

   229

			SB(p1, 7, 1, _convert_signal_button);

   230

		} else {

   231

			SB(p1, 3, 1, _ctrl_pressed);

   232

			SB(p1, 4, 1, (_cur_year < _settings_client.gui.semaphore_build_before ? SIG_SEMAPHORE : SIG_ELECTRIC));

   233

			SB(p1, 5, 2, SIGTYPE_NORMAL);

   234

			SB(p1, 7, 1, 0);

   235

		}

   236

   237

		DoCommandP(tile, p1, 0, CcPlaySound1E, CMD_BUILD_SIGNALS |

   238

			CMD_MSG((w != NULL && _convert_signal_button) ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   239

	}

   240

}

   241

   242

static void PlaceRail_Bridge(TileIndex tile)

   243

{

   244

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   245

}

   246

   247

/** Command callback for building a tunnel */

   248

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

   249

{

   250

	if (success) {

   251

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   252

		ResetObjectToPlace();

   253

	} else {

   254

		SetRedErrorSquare(_build_tunnel_endtile);

   255

	}

   256

}

   257

   258

static void PlaceRail_Tunnel(TileIndex tile)

   259

{

   260

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   261

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   262

}

   263

   264

static void PlaceRail_ConvertRail(TileIndex tile)

   265

{

   266

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   267

}

   268

   269

static void PlaceRail_AutoSignals(TileIndex tile)

   270

{

   271

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   272

}

   273

   274

   275

/** Enum referring to the widgets of the build rail toolbar */

   276

enum RailToolbarWidgets {

   277

	RTW_CLOSEBOX = 0,

   278

	RTW_CAPTION,

   279

	RTW_STICKY,

   280

	RTW_SPACER,

   281

	RTW_BUILD_NS,

   282

	RTW_BUILD_X,

   283

	RTW_BUILD_EW,

   284

	RTW_BUILD_Y,

   285

	RTW_AUTORAIL,

   286

	RTW_DEMOLISH,

   287

	RTW_BUILD_DEPOT,

   288

	RTW_BUILD_WAYPOINT,

   289

	RTW_BUILD_STATION,

   290

	RTW_BUILD_SIGNALS,

   291

	RTW_BUILD_BRIDGE,

   292

	RTW_BUILD_TUNNEL,

   293

	RTW_REMOVE,

   294

	RTW_CONVERT_RAIL,

   295

};

   296

   297

   298

/** Toggles state of the Remove button of Build rail toolbar

   299

 * @param w window the button belongs to

   300

 */

   301

static void ToggleRailButton_Remove(Window *w)

   302

{

   303

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   304

	w->InvalidateWidget(RTW_REMOVE);

   305

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   306

	SetSelectionRed(_remove_button_clicked);

   307

}

   308

   309

/** Updates the Remove button because of Ctrl state change

   310

 * @param w window the button belongs to

   311

 * @return true iff the remove buton was changed

   312

 */

   313

static bool RailToolbar_CtrlChanged(Window *w)

   314

{

   315

	if (w->IsWidgetDisabled(RTW_REMOVE)) return false;

   316

   317

	/* allow ctrl to switch remove mode only for these widgets */

   318

	for (uint i = RTW_BUILD_NS; i <= RTW_BUILD_STATION; i++) {

   319

		if ((i <= RTW_AUTORAIL || i >= RTW_BUILD_WAYPOINT) && w->IsWidgetLowered(i)) {

   320

			ToggleRailButton_Remove(w);

   321

			return true;

   322

		}

   323

	}

   324

   325

	return false;

   326

}

   327

   328

   329

/**

   330

 * The "rail N"-button click proc of the build-rail toolbar.

   331

 * @param w Build-rail toolbar window

   332

 * @see BuildRailToolbWndProc()

   333

 */

   334

static void BuildRailClick_N(Window *w)

   335

{

   336

	HandlePlacePushButton(w, RTW_BUILD_NS, GetRailTypeInfo(_cur_railtype)->cursor.rail_ns, VHM_RECT, PlaceRail_N);

   337

}

   338

   339

/**

   340

 * The "rail NE"-button click proc of the build-rail toolbar.

   341

 * @param w Build-rail toolbar window

   342

 * @see BuildRailToolbWndProc()

   343

 */

   344

static void BuildRailClick_NE(Window *w)

   345

{

   346

	HandlePlacePushButton(w, RTW_BUILD_X, GetRailTypeInfo(_cur_railtype)->cursor.rail_swne, VHM_RECT, PlaceRail_NE);

   347

}

   348

   349

/**

   350

 * The "rail E"-button click proc of the build-rail toolbar.

   351

 * @param w Build-rail toolbar window

   352

 * @see BuildRailToolbWndProc()

   353

 */

   354

static void BuildRailClick_E(Window *w)

   355

{

   356

	HandlePlacePushButton(w, RTW_BUILD_EW, GetRailTypeInfo(_cur_railtype)->cursor.rail_ew, VHM_RECT, PlaceRail_E);

   357

}

   358

   359

/**

   360

 * The "rail NW"-button click proc of the build-rail toolbar.

   361

 * @param w Build-rail toolbar window

   362

 * @see BuildRailToolbWndProc()

   363

 */

   364

static void BuildRailClick_NW(Window *w)

   365

{

   366

	HandlePlacePushButton(w, RTW_BUILD_Y, GetRailTypeInfo(_cur_railtype)->cursor.rail_nwse, VHM_RECT, PlaceRail_NW);

   367

}

   368

   369

/**

   370

 * The "auto-rail"-button click proc of the build-rail toolbar.

   371

 * @param w Build-rail toolbar window

   372

 * @see BuildRailToolbWndProc()

   373

 */

   374

static void BuildRailClick_AutoRail(Window *w)

   375

{

   376

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

   377

}

   378

   379

/**

   380

 * The "demolish"-button click proc of the build-rail toolbar.

   381

 * @param w Build-rail toolbar window

   382

 * @see BuildRailToolbWndProc()

   383

 */

   384

static void BuildRailClick_Demolish(Window *w)

   385

{

   386

	HandlePlacePushButton(w, RTW_DEMOLISH, ANIMCURSOR_DEMOLISH, VHM_RECT, PlaceProc_DemolishArea);

   387

}

   388

   389

/**

   390

 * The "build depot"-button click proc of the build-rail toolbar.

   391

 * @param w Build-rail toolbar window

   392

 * @see BuildRailToolbWndProc()

   393

 */

   394

static void BuildRailClick_Depot(Window *w)

   395

{

   396

	if (HandlePlacePushButton(w, RTW_BUILD_DEPOT, GetRailTypeInfo(_cur_railtype)->cursor.depot, VHM_RECT, PlaceRail_Depot)) {

   397

		ShowBuildTrainDepotPicker(w);

   398

	}

   399

}

   400

   401

/**

   402

 * The "build waypoint"-button click proc of the build-rail toolbar.

   403

 * If there are newGRF waypoints, also open a window to pick the waypoint type.

   404

 * @param w Build-rail toolbar window

   405

 * @see BuildRailToolbWndProc()

   406

 */

   407

static void BuildRailClick_Waypoint(Window *w)

   408

{

   409

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   410

	if (HandlePlacePushButton(w, RTW_BUILD_WAYPOINT, SPR_CURSOR_WAYPOINT, VHM_RECT, PlaceRail_Waypoint) &&

   411

			_waypoint_count > 1) {

   412

		ShowBuildWaypointPicker(w);

   413

	}

   414

}

   415

   416

/**

   417

 * The "build station"-button click proc of the build-rail toolbar.

   418

 * @param w Build-rail toolbar window

   419

 * @see BuildRailToolbWndProc()

   420

 */

   421

static void BuildRailClick_Station(Window *w)

   422

{

   423

	if (HandlePlacePushButton(w, RTW_BUILD_STATION, SPR_CURSOR_RAIL_STATION, VHM_RECT, PlaceRail_Station)) ShowStationBuilder(w);

   424

}

   425

   426

/**

   427

 * The "build signal"-button click proc of the build-rail toolbar.

   428

 * Start ShowSignalBuilder() and/or HandleAutoSignalPlacement().

   429

 * @param w Build-rail toolbar window

   430

 * @see BuildRailToolbWndProc()

   431

 */

   432

static void BuildRailClick_AutoSignals(Window *w)

   433

{

   434

	if (_settings_client.gui.enable_signal_gui != _ctrl_pressed) {

   435

		if (HandlePlacePushButton(w, RTW_BUILD_SIGNALS, ANIMCURSOR_BUILDSIGNALS, VHM_RECT, PlaceRail_AutoSignals)) ShowSignalBuilder(w);

   436

	} else {

   437

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

   438

	}

   439

}

   440

   441

/**

   442

 * The "build bridge"-button click proc of the build-rail toolbar.

   443

 * @param w Build-rail toolbar window

   444

 * @see BuildRailToolbWndProc()

   445

 */

   446

static void BuildRailClick_Bridge(Window *w)

   447

{

   448

	HandlePlacePushButton(w, RTW_BUILD_BRIDGE, SPR_CURSOR_BRIDGE, VHM_RECT, PlaceRail_Bridge);

   449

}

   450

   451

/**

   452

 * The "build tunnel"-button click proc of the build-rail toolbar.

   453

 * @param w Build-rail toolbar window

   454

 * @see BuildRailToolbWndProc()

   455

 */

   456

static void BuildRailClick_Tunnel(Window *w)

   457

{

   458

	HandlePlacePushButton(w, RTW_BUILD_TUNNEL, GetRailTypeInfo(_cur_railtype)->cursor.tunnel, VHM_SPECIAL, PlaceRail_Tunnel);

   459

}

   460

   461

/**

   462

 * The "remove"-button click proc of the build-rail toolbar.

   463

 * @param w Build-rail toolbar window

   464

 * @see BuildRailToolbWndProc()

   465

 */

   466

static void BuildRailClick_Remove(Window *w)

   467

{

   468

	if (w->IsWidgetDisabled(RTW_REMOVE)) return;

   469

	ToggleRailButton_Remove(w);

   470

	SndPlayFx(SND_15_BEEP);

   471

   472

	/* handle station builder */

   473

	if (w->IsWidgetLowered(RTW_BUILD_STATION)) {

   474

		if (_remove_button_clicked) {

   475

			/* starting drag & drop remove */

   476

			if (!_railstation.dragdrop) {

   477

				SetTileSelectSize(1, 1);

   478

			} else {

   479

				VpSetPlaceSizingLimit(-1);

   480

			}

   481

		} else {

   482

			/* starting station build mode */

   483

			if (!_railstation.dragdrop) {

   484

				int x = _railstation.numtracks;

   485

				int y = _railstation.platlength;

   486

				if (_railstation.orientation == 0) Swap(x, y);

   487

				SetTileSelectSize(x, y);

   488

			} else {

   489

				VpSetPlaceSizingLimit(_settings_game.station.station_spread);

   490

			}