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 "table/sprites.h"

     8

#include "table/strings.h"

     9

#include "functions.h"

    10

#include "landscape.h"

    11

#include "date.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "window.h"

    15

#include "gui.h"

    16

#include "viewport.h"

    17

#include "gfx.h"

    18

#include "sound.h"

    19

#include "command.h"

    20

#include "vehicle.h"

    21

#include "station.h"

    22

#include "waypoint.h"

    23

#include "debug.h"

    24

#include "variables.h"

    25

#include "newgrf_callbacks.h"

    26

#include "newgrf_station.h"

    27

#include "train.h"

    28

    29

static RailType _cur_railtype;

    30

static bool _remove_button_clicked;

    31

static DiagDirection _build_depot_direction;

    32

static byte _waypoint_count = 1;

    33

static byte _cur_waypoint_type;

    34

    35

static struct {

    36

	byte orientation;

    37

	byte numtracks;

    38

	byte platlength;

    39

	bool dragdrop;

    40

    41

	bool newstations;

    42

	StationClassIDByte station_class;

    43

	byte station_type;

    44

	byte station_count;

    45

} _railstation;

    46

    47

    48

static void HandleStationPlacement(TileIndex start, TileIndex end);

    49

static void ShowBuildTrainDepotPicker();

    50

static void ShowBuildWaypointPicker();

    51

static void ShowStationBuilder();

    52

    53

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

    54

{

    55

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    56

}

    57

    58

static void GenericPlaceRail(TileIndex tile, int cmd)

    59

{

    60

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    61

		_remove_button_clicked ?

    62

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_AUTO | CMD_NO_WATER :

    63

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_AUTO | CMD_NO_WATER

    64

	);

    65

}

    66

    67

static void PlaceRail_N(TileIndex tile)

    68

{

    69

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

    70

	GenericPlaceRail(tile, cmd);

    71

}

    72

    73

static void PlaceRail_NE(TileIndex tile)

    74

{

    76

}

    77

    78

static void PlaceRail_E(TileIndex tile)

    79

{

    80

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

    81

	GenericPlaceRail(tile, cmd);

    82

}

    83

    84

static void PlaceRail_NW(TileIndex tile)

    85

{

    87

}

    88

    89

static void PlaceRail_AutoRail(TileIndex tile)

    90

{

    92

}

    93

    94

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

    95

{

    96

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

    97

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

    98

    99

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

   100

}

   101

   102

static const uint16 _place_depot_extra[12] = {

   103

	0x0604, 0x2102, 0x1202, 0x0505,

   104

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

   105

	0x2203, 0x0904, 0x0A05, 0x1103,

   106

};

   107

   108

   109

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

   110

{

   111

	if (success) {

   112

		DiagDirection dir = (DiagDirection)p2;

   113

   114

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   115

		ResetObjectToPlace();

   116

   117

		tile += TileOffsByDiagDir(dir);

   118

   119

		if (IsTileType(tile, MP_RAILWAY)) {

   120

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   121

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

   122

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

   123

		}

   124

	}

   125

}

   126

   127

static void PlaceRail_Depot(TileIndex tile)

   128

{

   129

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   130

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

   131

}

   132

   133

static void PlaceRail_Waypoint(TileIndex tile)

   134

{

   135

	if (!_remove_button_clicked) {

   136

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

   137

	} else {

   138

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

   139

	}

   140

}

   141

   142

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

   143

{

   144

	if (success) {

   145

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   146

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

   147

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

   148

	}

   149

}

   150

   151

static void PlaceRail_Station(TileIndex tile)

   152

{

   153

	if (_remove_button_clicked) {

   155

	} else if (_railstation.dragdrop) {

   157

		VpSetPlaceSizingLimit(_patches.station_spread);

   158

	} else {

   159

		DoCommandP(tile,

   160

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

   161

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

   162

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

   163

	}

   164

}

   165

   166

static void GenericPlaceSignals(TileIndex tile)

   167

{

   168

	byte trackstat;

   169

	uint i;

   170

   171

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

   172

   173

	if (trackstat & TRACK_BIT_VERT) // N-S direction

   174

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

   175

   176

	if (trackstat & TRACK_BIT_HORZ) // E-W direction

   177

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

   178

   179

	// Lookup the bit index

   180

	i = 0;

   181

	if (trackstat != 0) {

   182

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

   183

	}

   184

   185

	if (!_remove_button_clicked) {

   186

		uint32 p1 = GB(i, 0, 3);

   187

		SB(p1, 3, 1, _ctrl_pressed);

   188

		SB(p1, 4, 1, _cur_year < _patches.semaphore_build_before);

   189

   190

		DoCommandP(tile, p1, 0, CcPlaySound1E,

   191

			CMD_BUILD_SIGNALS | CMD_AUTO | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   192

	} else {

   193

		DoCommandP(tile, i, 0, CcPlaySound1E,

   194

			CMD_REMOVE_SIGNALS | CMD_AUTO | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   195

	}

   196

}

   197

   198

static void PlaceRail_Bridge(TileIndex tile)

   199

{

   201

}

   202

   203

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

   204

{

   205

	if (success) {

   206

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   207

		ResetObjectToPlace();

   208

	} else {

   209

		SetRedErrorSquare(_build_tunnel_endtile);

   210

	}

   211

}

   212

   213

static void PlaceRail_Tunnel(TileIndex tile)

   214

{

   215

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   216

		CMD_BUILD_TUNNEL | CMD_AUTO | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   217

}

   218

   219

void PlaceProc_BuyLand(TileIndex tile)

   220

{

   221

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

   222

}

   223

   224

static void PlaceRail_ConvertRail(TileIndex tile)

   225

{

   227

}

   228

   229

static void PlaceRail_AutoSignals(TileIndex tile)

   230

{

   232

}

   233

   234

   235

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

   236

enum {

   237

	RTW_CAPTION        =  1,

   238

	RTW_BUILD_NS       =  4,

   239

	RTW_BUILD_X        =  5,

   240

	RTW_BUILD_EW       =  6,

   241

	RTW_BUILD_Y        =  7,

   242

	RTW_AUTORAIL       =  8,

   243

	RTW_DEMOLISH       =  9,

   244

	RTW_BUILD_DEPOT    = 10,

   245

	RTW_BUILD_WAYPOINT = 11,

   246

	RTW_BUILD_STATION  = 12,

   247

	RTW_BUILD_SIGNALS  = 13,

   248

	RTW_BUILD_BRIDGE   = 14,

   249

	RTW_BUILD_TUNNEL   = 15,

   250

	RTW_REMOVE         = 16,

   251

	RTW_CONVERT_RAIL   = 17

   252

};

   253

   254

   255

static void BuildRailClick_N(Window *w)

   256

{

   257

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

   258

}

   259

   260

static void BuildRailClick_NE(Window *w)

   261

{

   262

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

   263

}

   264

   265

static void BuildRailClick_E(Window *w)

   266

{

   267

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

   268

}

   269

   270

static void BuildRailClick_NW(Window *w)

   271

{

   272

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

   273

}

   274

   275

static void BuildRailClick_AutoRail(Window *w)

   276

{

   277

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

   278

}

   279

   280

static void BuildRailClick_Demolish(Window *w)

   281

{

   282

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

   283

}

   284

   285

static void BuildRailClick_Depot(Window *w)

   286

{

   287

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

   288

		ShowBuildTrainDepotPicker();

   289

	}

   290

}

   291

   292

static void BuildRailClick_Waypoint(Window *w)

   293

{

   294

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   295

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

   296

			_waypoint_count > 1) {

   297

		ShowBuildWaypointPicker();

   298

	}

   299

}

   300

   301

static void BuildRailClick_Station(Window *w)

   302

{

   303

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

   304

}

   305

   306

static void BuildRailClick_AutoSignals(Window *w)

   307

{

   308

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

   309

}

   310

   311

static void BuildRailClick_Bridge(Window *w)

   312

{

   313

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

   314

}

   315

   316

static void BuildRailClick_Tunnel(Window *w)

   317

{

   318

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

   319

}

   320

   321

static void BuildRailClick_Remove(Window *w)

   322

{

   323

	if (IsWindowWidgetDisabled(w, RTW_REMOVE)) return;

   324

	SetWindowDirty(w);

   325

	SndPlayFx(SND_15_BEEP);

   326

   327

	ToggleWidgetLoweredState(w, RTW_REMOVE);

   328

	_remove_button_clicked = IsWindowWidgetLowered(w, RTW_REMOVE);

   329

	SetSelectionRed(_remove_button_clicked);

   330

   331

	// handle station builder

   332

	if (_remove_button_clicked) {

   333

		SetTileSelectSize(1, 1);

   334

	}

   335

}

   336

   337

static void BuildRailClick_Convert(Window *w)

   338

{

   339

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

   340

}

   341

   342

   343

static void DoRailroadTrack(int mode)

   344

{

   345

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

   346

		_remove_button_clicked ?

   347

		CMD_REMOVE_RAILROAD_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   348

		CMD_BUILD_RAILROAD_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   349

	);

   350

}

   351

   352

static void HandleAutodirPlacement()

   353

{

   354

	TileHighlightData *thd = &_thd;

   355

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

   356

   357

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

   358

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

   359

		return;

   360

	}

   361

   362

	DoRailroadTrack(trackstat);

   363

}

   364

   365

static void HandleAutoSignalPlacement()

   366

{

   367

	TileHighlightData *thd = &_thd;

   368

	uint32 p2 = GB(thd->drawstyle, 0, 3); // 0..5

   369

   370

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

   371

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

   372

		return;

   373

	}

   374

   375

	SB(p2,  3, 1, _ctrl_pressed);

   376

	SB(p2,  4, 1, _cur_year < _patches.semaphore_build_before);

   377

	SB(p2, 24, 8, _patches.drag_signals_density);

   378

   379

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

   380

	 * in a network game can specify his/her own signal density */

   381

	DoCommandP(

   382

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

   383

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

   384

		p2,

   385

		CcPlaySound1E,

   386

		_remove_button_clicked ?

   387

			CMD_REMOVE_SIGNAL_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   388

			CMD_BUILD_SIGNAL_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   389

	);

   390

}

   391

   392

   393

typedef void OnButtonClick(Window *w);

   394

   395

static OnButtonClick * const _build_railroad_button_proc[] = {

   396

	BuildRailClick_N,

   397

	BuildRailClick_NE,

   398

	BuildRailClick_E,

   399

	BuildRailClick_NW,

   400

	BuildRailClick_AutoRail,

   401

	BuildRailClick_Demolish,

   402

	BuildRailClick_Depot,

   403

	BuildRailClick_Waypoint,

   404

	BuildRailClick_Station,

   405

	BuildRailClick_AutoSignals,

   406

	BuildRailClick_Bridge,

   407

	BuildRailClick_Tunnel,

   408

	BuildRailClick_Remove,

   409

	BuildRailClick_Convert

   410

};

   411

   412

static const uint16 _rail_keycodes[] = {

   413

	'1',

   414

	'2',

   415

	'3',

   416

	'4',

   417

	'5',

   418

	'6',

   419

	'7', // depot

   420

	'8', // waypoint

   421

	'9', // station

   422

	'S', // signals

   423

	'B', // bridge

   424

	'T', // tunnel

   425

	'R', // remove

   426

	'C', // convert rail

   427

};

   428

   429

   430

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   431

{

   432

	/* If it is the removal button that has been clicked, do nothing,

   433

	 * as it is up to the other buttons to drive removal status */

   434

	if (clicked_widget == RTW_REMOVE) return;

   435

   436

	switch (clicked_widget) {

   437

		case RTW_BUILD_NS:

   438

		case RTW_BUILD_X:

   439

		case RTW_BUILD_EW:

   440

		case RTW_BUILD_Y:

   441

		case RTW_AUTORAIL:

   442

		case RTW_BUILD_WAYPOINT:

   443

		case RTW_BUILD_STATION:

   444

		case RTW_BUILD_SIGNALS:

   445

			/* Removal button is enabled only if the rail/signal/waypoint/station

   446

			 * button is still lowered.  Once raised, it has to be disabled */

   447

			SetWindowWidgetDisabledState(w, RTW_REMOVE, !IsWindowWidgetLowered(w, clicked_widget));

   448

			break;

   449

   450

		default:

   451

			/* When any other buttons than rail/signal/waypoint/station, raise and

   452

			 * disable the removal button*/

   453

			DisableWindowWidget(w, RTW_REMOVE);

   454

			RaiseWindowWidget(w, RTW_REMOVE);

   455

			break;

   456

	}

   457

}

   458

   459

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

   460

{

   461

	switch (e->event) {

   462

	case WE_CREATE: DisableWindowWidget(w, RTW_REMOVE); break;

   463

   464

	case WE_PAINT: DrawWindowWidgets(w); break;

   465

   466

	case WE_CLICK:

   467

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

   468

			_remove_button_clicked = false;

   469

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

   470

		}

   471

		UpdateRemoveWidgetStatus(w, e->we.click.widget);

   472

		break;

   473

   474

	case WE_KEYPRESS: {

   475

		uint i;

   476

   477

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

   478

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

   479

				e->we.keypress.cont = false;

   480

				_remove_button_clicked = false;

   481

				_build_railroad_button_proc[i](w);

   482

				UpdateRemoveWidgetStatus(w, i + 4);

   483

				break;

   484

			}

   485

		}

   486

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

   487

		break;

   488

	}

   489

   490

	case WE_PLACE_OBJ:

   491

		_place_proc(e->we.place.tile);

   492

		return;

   493