1

/* $Id$ */

     2

     3

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

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "tile_cmd.h"

     8

#include "landscape.h"

     9

#include "gui.h"

    10

#include "window_gui.h"

    11

#include "station_gui.h"

    12

#include "terraform_gui.h"

    13

#include "viewport_func.h"

    14

#include "gfx_func.h"

    15

#include "command_func.h"

    16

#include "town_type.h"

    17

#include "waypoint.h"

    18

#include "debug.h"

    19

#include "variables.h"

    20

#include "newgrf_callbacks.h"

    21

#include "newgrf_station.h"

    22

#include "train.h"

    23

#include "strings_func.h"

    24

#include "functions.h"

    25

#include "window_func.h"

    26

#include "date_func.h"

    27

#include "sound_func.h"

    28

#include "player_func.h"

    29

#include "settings_type.h"

    30

#include "widgets/dropdown_type.h"

    31

#include "widgets/dropdown_func.h"

    32

#include "tunnelbridge.h"

    33

#include "tilehighlight_func.h"

    34

    35

#include "bridge_map.h"

    36

#include "rail_map.h"

    37

#include "road_map.h"

    38

#include "station_map.h"

    39

#include "tunnel_map.h"

    40

#include "tunnelbridge_map.h"

    41

    42

#include "table/sprites.h"

    43

#include "table/strings.h"

    44

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

    54

static struct {

    55

	byte orientation;                 ///< Currently selected rail station orientation

    56

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

    57

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

    58

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

    59

    60

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

    61

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

    62

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

    63

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

    64

} _railstation;

    65

    66

    67

static void HandleStationPlacement(TileIndex start, TileIndex end);

    68

static void ShowBuildTrainDepotPicker(Window *parent);

    69

static void ShowBuildWaypointPicker(Window *parent);

    70

static void ShowStationBuilder(Window *parent);

    71

static void ShowSignalBuilder(Window *parent);

    72

    73

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

    74

{

    75

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    76

}

    77

    78

static void GenericPlaceRail(TileIndex tile, int cmd)

    79

{

    80

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    81

		_remove_button_clicked ?

    82

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    83

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    84

	);

    85

}

    86

    87

static void PlaceRail_N(TileIndex tile)

    88

{

    89

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

    90

	GenericPlaceRail(tile, cmd);

    91

}

    92

    93

static void PlaceRail_NE(TileIndex tile)

    94

{

    95

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    96

}

    97

    98

static void PlaceRail_E(TileIndex tile)

    99

{

   100

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

   101

	GenericPlaceRail(tile, cmd);

   102

}

   103

   104

static void PlaceRail_NW(TileIndex tile)

   105

{

   106

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   107

}

   108

   109

static void PlaceRail_AutoRail(TileIndex tile)

   110

{

   111

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   112

}

   113

   114

/**

   115

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

   116

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

   117

 * @param extra Track to add

   118

 * @see CcRailDepot()

   119

 */

   120

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   121

{

   122

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

   123

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

   124

   125

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

   126

}

   127

   128

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

   129

static const uint16 _place_depot_extra[12] = {

   130

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

   131

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

   132

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

   133

};

   134

   135

   136

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

   137

{

   138

	if (success) {

   139

		DiagDirection dir = (DiagDirection)p2;

   140

   141

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   142

		ResetObjectToPlace();

   143

   144

		tile += TileOffsByDiagDir(dir);

   145

   146

		if (IsTileType(tile, MP_RAILWAY)) {

   147

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   148

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

   149

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

   150

		}

   151

	}

   152

}

   153

   154

static void PlaceRail_Depot(TileIndex tile)

   155

{

   156

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   157

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   158

}

   159

   160

static void PlaceRail_Waypoint(TileIndex tile)

   161

{

   162

	if (_remove_button_clicked) {

   163

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

   164

	} else {

   165

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

   166

	}

   167

}

   168

   169

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

   170

{

   171

	if (success) {

   172

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   173

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

   174

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

   175

	}

   176

}

   177

   178

static void PlaceRail_Station(TileIndex tile)

   179

{

   180

	if (_remove_button_clicked) {

   181

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_REMOVE_STATION);

   182

		VpSetPlaceSizingLimit(-1);

   183

	} else if (_railstation.dragdrop) {

   184

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   185

		VpSetPlaceSizingLimit(_settings_game.station.station_spread);

   186

	} else {

   187

		DoCommandP(tile,

   188

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

   189

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

   190

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   191

	}

   192

}

   193

   194

/**

   195

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

   196

 *

   197

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

   198

 */

   199

static void GenericPlaceSignals(TileIndex tile)

   200

{

   201

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

   202

   203

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

   204

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

   205

	}

   206

   207

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

   208

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

   209

	}

   210

   211

	Track track = FindFirstTrack(trackbits);

   212

   213

	if (_remove_button_clicked) {

   214

		DoCommandP(tile, track, 0, CcPlaySound1E,

   215

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   216

	} else {

   217

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

   218

   219

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   220

		uint32 p1 = track;

   221

   222

		if (w != NULL) {

   223

			/* signal GUI is used */

   224

			SB(p1, 3, 1, _ctrl_pressed);

   225

			SB(p1, 4, 1, _cur_signal_variant);

   226

			SB(p1, 5, 2, _cur_signal_type);

   227

			SB(p1, 7, 1, _convert_signal_button);

   228

		} else {

   229

			SB(p1, 3, 1, _ctrl_pressed);

   230

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

   231

			SB(p1, 5, 2, SIGTYPE_NORMAL);

   232

			SB(p1, 7, 1, 0);

   233

		}

   234

   235

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

   236

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

   237

	}

   238

}

   239

   240

static void PlaceRail_Bridge(TileIndex tile)

   241

{

   242

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   243

}

   244

   245

/** Command callback for building a tunnel */

   246

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

   247

{

   248

	if (success) {

   249

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   250

		ResetObjectToPlace();

   251

	} else {

   252

		SetRedErrorSquare(_build_tunnel_endtile);

   253

	}

   254

}

   255

   256

static void PlaceRail_Tunnel(TileIndex tile)

   257

{

   258

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   259

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   260

}

   261

   262

static void PlaceRail_ConvertRail(TileIndex tile)

   263

{

   264

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   265

}

   266

   267

static void PlaceRail_AutoSignals(TileIndex tile)

   268

{

   269

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   270

}

   271

   272

   273

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

   274

enum RailToolbarWidgets {

   275

	RTW_CLOSEBOX = 0,

   276

	RTW_CAPTION,

   277

	RTW_STICKY,

   278

	RTW_SPACER,

   279

	RTW_BUILD_NS,

   280

	RTW_BUILD_X,

   281

	RTW_BUILD_EW,

   282

	RTW_BUILD_Y,

   283

	RTW_AUTORAIL,

   284

	RTW_DEMOLISH,

   285

	RTW_BUILD_DEPOT,

   286

	RTW_BUILD_WAYPOINT,

   287

	RTW_BUILD_STATION,

   288

	RTW_BUILD_SIGNALS,

   289

	RTW_BUILD_BRIDGE,

   290

	RTW_BUILD_TUNNEL,

   291

	RTW_REMOVE,

   292

	RTW_CONVERT_RAIL,

   293

};

   294

   295

   296

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

   297

 * @param w window the button belongs to

   298

 */

   299

static void ToggleRailButton_Remove(Window *w)

   300

{

   301

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   302

	w->InvalidateWidget(RTW_REMOVE);

   303

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   304

	SetSelectionRed(_remove_button_clicked);

   305

}

   306

   307

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

   308

 * @param w window the button belongs to

   309

 * @return true iff the remove buton was changed

   310

 */

   311

static bool RailToolbar_CtrlChanged(Window *w)

   312

{

   313

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

   314

   315

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

   316

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

   317

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

   318

			ToggleRailButton_Remove(w);

   319

			return true;

   320

		}

   321

	}

   322

   323

	return false;

   324

}

   325

   326

   327

/**

   328

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

   329

 * @param w Build-rail toolbar window

   330

 * @see BuildRailToolbWndProc()

   331

 */

   332

static void BuildRailClick_N(Window *w)

   333

{

   334

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

   335

}

   336

   337

/**

   338

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

   339

 * @param w Build-rail toolbar window

   340

 * @see BuildRailToolbWndProc()

   341

 */

   342

static void BuildRailClick_NE(Window *w)

   343

{

   344

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

   345

}

   346

   347

/**

   348

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

   349

 * @param w Build-rail toolbar window

   350

 * @see BuildRailToolbWndProc()

   351

 */

   352

static void BuildRailClick_E(Window *w)

   353

{

   354

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

   355

}

   356

   357

/**

   358

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

   359

 * @param w Build-rail toolbar window

   360

 * @see BuildRailToolbWndProc()

   361

 */

   362

static void BuildRailClick_NW(Window *w)

   363

{

   364

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

   365

}

   366

   367

/**

   368

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

   369

 * @param w Build-rail toolbar window

   370

 * @see BuildRailToolbWndProc()

   371

 */

   372

static void BuildRailClick_AutoRail(Window *w)

   373

{

   374

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

   375

}

   376

   377

/**

   378

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

   379

 * @param w Build-rail toolbar window

   380

 * @see BuildRailToolbWndProc()

   381

 */

   382

static void BuildRailClick_Demolish(Window *w)

   383

{

   384

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

   385

}

   386

   387

/**

   388

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

   389

 * @param w Build-rail toolbar window

   390

 * @see BuildRailToolbWndProc()

   391

 */

   392

static void BuildRailClick_Depot(Window *w)

   393

{

   394

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

   395

		ShowBuildTrainDepotPicker(w);

   396

	}

   397

}

   398

   399

/**

   400

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

   401

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

   402

 * @param w Build-rail toolbar window

   403

 * @see BuildRailToolbWndProc()

   404

 */

   405

static void BuildRailClick_Waypoint(Window *w)

   406

{

   407

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   408

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

   409

			_waypoint_count > 1) {

   410

		ShowBuildWaypointPicker(w);

   411

	}

   412

}

   413

   414

/**

   415

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

   416

 * @param w Build-rail toolbar window

   417

 * @see BuildRailToolbWndProc()

   418

 */

   419

static void BuildRailClick_Station(Window *w)

   420

{

   421

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

   422

}

   423

   424

/**

   425

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

   426

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

   427

 * @param w Build-rail toolbar window

   428

 * @see BuildRailToolbWndProc()

   429

 */

   430

static void BuildRailClick_AutoSignals(Window *w)

   431

{

   432

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

   433

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

   434

	} else {

   435

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

   436

	}

   437

}

   438

   439

/**

   440

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

   441

 * @param w Build-rail toolbar window

   442

 * @see BuildRailToolbWndProc()

   443

 */

   444

static void BuildRailClick_Bridge(Window *w)

   445

{

   446

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

   447

}

   448

   449

/**

   450

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

   451

 * @param w Build-rail toolbar window

   452

 * @see BuildRailToolbWndProc()

   453

 */

   454

static void BuildRailClick_Tunnel(Window *w)

   455

{

   456

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

   457

}

   458

   459

/**

   460

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

   461

 * @param w Build-rail toolbar window

   462

 * @see BuildRailToolbWndProc()

   463

 */

   464

static void BuildRailClick_Remove(Window *w)

   465

{

   466

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

   467

	ToggleRailButton_Remove(w);

   468

	SndPlayFx(SND_15_BEEP);

   469

   470

	/* handle station builder */

   471

	if (w->IsWidgetLowered(RTW_BUILD_STATION)) {

   472

		if (_remove_button_clicked) {

   473

			/* starting drag & drop remove */

   474

			if (!_railstation.dragdrop) {

   475

				SetTileSelectSize(1, 1);

   476

			} else {

   477

				VpSetPlaceSizingLimit(-1);

   478

			}

   479

		} else {

   480

			/* starting station build mode */

   481

			if (!_railstation.dragdrop) {

   482

				int x = _railstation.numtracks;

   483

				int y = _railstation.platlength;

   484

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

   485

				SetTileSelectSize(x, y);

   486

			} else {

   487

				VpSetPlaceSizingLimit(_settings_game.station.station_spread);

   488

			}

   489

		}

   490

	}