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

#include "newgrf_callbacks.h"

    24

#include "newgrf_station.h"

    25

#include "train.h"

    26

    27

static RailType _cur_railtype;

    28

static bool _remove_button_clicked;

    29

static DiagDirection _build_depot_direction;

    30

static byte _waypoint_count = 1;

    31

static byte _cur_waypoint_type;

    32

    33

static struct {

    34

	byte orientation;

    35

	byte numtracks;

    36

	byte platlength;

    37

	bool dragdrop;

    38

    39

	bool newstations;

    40

	byte station_class;

    41

	byte station_type;

    42

	byte station_count;

    43

} _railstation;

    44

    45

    46

static void HandleStationPlacement(TileIndex start, TileIndex end);

    47

static void ShowBuildTrainDepotPicker(void);

    48

static void ShowBuildWaypointPicker(void);

    49

static void ShowStationBuilder(void);

    50

    51

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

    52

{

    53

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    54

}

    55

    56

static void GenericPlaceRail(TileIndex tile, int cmd)

    57

{

    58

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    59

		_remove_button_clicked ?

    60

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    61

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    62

	);

    63

}

    64

    65

static void PlaceRail_N(TileIndex tile)

    66

{

    67

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

    68

	GenericPlaceRail(tile, cmd);

    69

}

    70

    71

static void PlaceRail_NE(TileIndex tile)

    72

{

    73

	VpStartPlaceSizing(tile, VPM_FIX_Y);

    74

}

    75

    76

static void PlaceRail_E(TileIndex tile)

    77

{

    78

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

    79

	GenericPlaceRail(tile, cmd);

    80

}

    81

    82

static void PlaceRail_NW(TileIndex tile)

    83

{

    84

	VpStartPlaceSizing(tile, VPM_FIX_X);

    85

}

    86

    87

static void PlaceRail_AutoRail(TileIndex tile)

    88

{

    89

	VpStartPlaceSizing(tile, VPM_RAILDIRS);

    90

}

    91

    92

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

    93

{

    94

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

    95

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

    96

    97

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

    98

}

    99

   100

static const uint16 _place_depot_extra[12] = {

   101

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

   102

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

   103

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

   104

};

   105

   106

   107

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

   108

{

   109

	if (success) {

   110

		DiagDirection dir = p2;

   111

   112

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   113

		ResetObjectToPlace();

   114

   115

		tile += TileOffsByDiagDir(dir);

   116

   117

		if (IsTileType(tile, MP_RAILWAY)) {

   118

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   119

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

   120

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

   121

		}

   122

	}

   123

}

   124

   125

static void PlaceRail_Depot(TileIndex tile)

   126

{

   127

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   128

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   129

}

   130

   131

static void PlaceRail_Waypoint(TileIndex tile)

   132

{

   133

	if (!_remove_button_clicked) {

   134

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

   135

	} else {

   136

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

   137

	}

   138

}

   139

   140

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

   141

{

   142

	if (success) {

   143

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   144

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

   145

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

   146

	}

   147

}

   148

   149

static void PlaceRail_Station(TileIndex tile)

   150

{

   151

	if (_remove_button_clicked) {

   152

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

   153

	} else if (_railstation.dragdrop) {

   154

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED);

   155

		VpSetPlaceSizingLimit(_patches.station_spread);

   156

	} else {

   157

		DoCommandP(tile,

   158

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

   159

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

   160

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   161

	}

   162

}

   163

   164

static void GenericPlaceSignals(TileIndex tile)

   165

{

   166

	uint trackstat;

   167

	uint i;

   168

   169

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

   170

   171

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

   172

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

   173

   174

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

   175

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

   176

   177

	// Lookup the bit index

   178

	i = 0;

   179

	if (trackstat != 0) {

   180

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

   181

	}

   182

   183

	if (!_remove_button_clicked) {

   184

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

   185

			CMD_BUILD_SIGNALS | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   186

	} else {

   187

		DoCommandP(tile, i, 0, CcPlaySound1E,

   188

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   189

	}

   190

}

   191

   192

static void PlaceRail_Bridge(TileIndex tile)

   193

{

   194

	VpStartPlaceSizing(tile, VPM_X_OR_Y);

   195

}

   196

   197

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

   198

{

   199

	if (success) {

   200

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   201

		ResetObjectToPlace();

   202

	} else {

   203

		SetRedErrorSquare(_build_tunnel_endtile);

   204

	}

   205

}

   206

   207

static void PlaceRail_Tunnel(TileIndex tile)

   208

{

   209

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   210

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   211

}

   212

   213

void PlaceProc_BuyLand(TileIndex tile)

   214

{

   215

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

   216

}

   217

   218

static void PlaceRail_ConvertRail(TileIndex tile)

   219

{

   220

	VpStartPlaceSizing(tile, VPM_X_AND_Y | GUI_PlaceProc_ConvertRailArea);

   221

}

   222

   223

static void PlaceRail_AutoSignals(TileIndex tile)

   224

{

   225

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS);

   226

}

   227

   228

   229

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

   230

enum {

   231

	RTW_CAPTION        =  1,

   232

	RTW_BUILD_NS       =  4,

   233

	RTW_BUILD_X        =  5,

   234

	RTW_BUILD_EW       =  6,

   235

	RTW_BUILD_Y        =  7,

   236

	RTW_AUTORAIL       =  8,

   237

	RTW_DEMOLISH       =  9,

   238

	RTW_BUILD_DEPOT    = 10,

   239

	RTW_BUILD_WAYPOINT = 11,

   240

	RTW_BUILD_STATION  = 12,

   241

	RTW_BUILD_SIGNALS  = 13,

   242

	RTW_BUILD_BRIDGE   = 14,

   243

	RTW_BUILD_TUNNEL   = 15,

   244

	RTW_REMOVE         = 16,

   245

	RTW_CONVERT_RAIL   = 17

   246

};

   247

   248

   249

static void BuildRailClick_N(Window *w)

   250

{

   251

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

   252

}

   253

   254

static void BuildRailClick_NE(Window *w)

   255

{

   256

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

   257

}

   258

   259

static void BuildRailClick_E(Window *w)

   260

{

   261

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

   262

}

   263

   264

static void BuildRailClick_NW(Window *w)

   265

{

   266

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

   267

}

   268

   269

static void BuildRailClick_AutoRail(Window *w)

   270

{

   271

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

   272

}

   273

   274

static void BuildRailClick_Demolish(Window *w)

   275

{

   276

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

   277

}

   278

   279

static void BuildRailClick_Depot(Window *w)

   280

{

   281

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

   282

		ShowBuildTrainDepotPicker();

   283

	}

   284

}

   285

   286

static void BuildRailClick_Waypoint(Window *w)

   287

{

   288

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   289

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

   290

			_waypoint_count > 1) {

   291

		ShowBuildWaypointPicker();

   292

	}

   293

}

   294

   295

static void BuildRailClick_Station(Window *w)

   296

{

   297

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

   298

}

   299

   300

static void BuildRailClick_AutoSignals(Window *w)

   301

{

   302

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

   303

}

   304

   305

static void BuildRailClick_Bridge(Window *w)

   306

{

   307

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

   308

}

   309

   310

static void BuildRailClick_Tunnel(Window *w)

   311

{

   312

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

   313

}

   314

   315

static void BuildRailClick_Remove(Window *w)

   316

{

   317

	if (IsWindowWidgetDisabled(w, RTW_REMOVE)) return;

   318

	SetWindowDirty(w);

   319

	SndPlayFx(SND_15_BEEP);

   320

   321

	ToggleWidgetLoweredState(w, RTW_REMOVE);

   322

	_remove_button_clicked = IsWindowWidgetLowered(w, RTW_REMOVE);

   323

	SetSelectionRed(_remove_button_clicked);

   324

   325

	// handle station builder

   326

	if (_remove_button_clicked) {

   327

		SetTileSelectSize(1, 1);

   328

	}

   329

}

   330

   331

static void BuildRailClick_Convert(Window *w)

   332

{

   333

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

   334

}

   335

   336

static void BuildRailClick_Landscaping(Window *w)

   337

{

   338

	ShowTerraformToolbar();

   339

}

   340

   341

static void DoRailroadTrack(int mode)

   342

{

   343

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

   344

		_remove_button_clicked ?

   345

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   346

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   347

	);

   348

}

   349

   350

static void HandleAutodirPlacement(void)

   351

{

   352

	TileHighlightData *thd = &_thd;

   353

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

   354

   355

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

   356

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

   357

		return;

   358

	}

   359

   360

	DoRailroadTrack(trackstat);

   361

}

   362

   363

static void HandleAutoSignalPlacement(void)

   364

{

   365

	TileHighlightData *thd = &_thd;

   366

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

   367

   368

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

   369

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

   370

		return;

   371

	}

   372

   373

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

   374

	// game can specify his/her own signal density

   375

	DoCommandP(

   376

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

   377

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

   378

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

   379

		CcPlaySound1E,

   380

		_remove_button_clicked ?

   381

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   382

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   383

	);

   384

}

   385

   386

   387

typedef void OnButtonClick(Window *w);

   388

   389

static OnButtonClick * const _build_railroad_button_proc[] = {

   390

	BuildRailClick_N,

   391

	BuildRailClick_NE,

   392

	BuildRailClick_E,

   393

	BuildRailClick_NW,

   394

	BuildRailClick_AutoRail,

   395

	BuildRailClick_Demolish,

   396

	BuildRailClick_Depot,

   397

	BuildRailClick_Waypoint,

   398

	BuildRailClick_Station,

   399

	BuildRailClick_AutoSignals,

   400

	BuildRailClick_Bridge,

   401

	BuildRailClick_Tunnel,

   402

	BuildRailClick_Remove,

   403

	BuildRailClick_Convert,

   404

	BuildRailClick_Landscaping,

   405

};

   406

   407

static const uint16 _rail_keycodes[] = {

   408

	'1',

   409

	'2',

   410

	'3',

   411

	'4',

   412

	'5',

   413

	'6',

   414

	'7', // depot

   415

	'8', // waypoint

   416

	'9', // station

   417

	'S', // signals

   418

	'B', // bridge

   419

	'T', // tunnel

   420

	'R', // remove

   421

	'C', // convert rail

   422

	'L', // landscaping

   423

};

   424

   425

   426

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   427

{

   428

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

   429

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

   430

	if (clicked_widget == RTW_REMOVE) return;

   431

   432

	switch (clicked_widget) {

   433

		case RTW_BUILD_NS:

   434

		case RTW_BUILD_X:

   435

		case RTW_BUILD_EW:

   436

		case RTW_BUILD_Y:

   437

		case RTW_AUTORAIL:

   438

		case RTW_BUILD_WAYPOINT:

   439

		case RTW_BUILD_STATION:

   440

		case RTW_BUILD_SIGNALS:

   441

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

   442

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

   443

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

   444

			break;

   445

   446

		default:

   447

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

   448

			 * disable the removal button*/

   449

			DisableWindowWidget(w, RTW_REMOVE);

   450

			RaiseWindowWidget(w, RTW_REMOVE);

   451

			break;

   452

	}

   453

}

   454

   455

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

   456

{

   457

	switch (e->event) {

   458

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

   459

   460

	case WE_PAINT: DrawWindowWidgets(w); break;

   461

   462

	case WE_CLICK:

   463

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

   464

			_remove_button_clicked = false;

   465

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

   466

		}

   467

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

   468

		break;

   469

   470

	case WE_KEYPRESS: {

   471

		uint i;

   472

   473

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

   474

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

   475

				e->we.keypress.cont = false;

   476

				_remove_button_clicked = false;

   477

				_build_railroad_button_proc[i](w);

   478

				UpdateRemoveWidgetStatus(w, i + 4);

   479

				break;

   480

			}

   481

		}

   482

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

   483

		break;

   484

	}

   485

   486

	case WE_PLACE_OBJ:

   487

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

   488

		return;

   489

   490

	case WE_PLACE_DRAG: {

   491

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

   492

		return;

   493

	}

   494

   495