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 uint _cur_railtype;

    25

static bool _remove_button_clicked;

    26

static byte _build_depot_direction;

    27

static byte _waypoint_count=1;

    28

static byte _cur_waypoint_type;

    29

    30

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

typedef void OnButtonClick(Window *w);

    44

    45

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

    46

{

    47

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    48

}

    49

    50

static void GenericPlaceRail(TileIndex tile, int cmd)

    51

{

    52

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    53

		_remove_button_clicked ?

    54

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_AUTO | CMD_NO_WATER :

    55

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_AUTO | CMD_NO_WATER

    56

		);

    57

}

    58

    59

static void PlaceRail_N(TileIndex tile)

    60

{

    61

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

    62

	GenericPlaceRail(tile, cmd);

    63

}

    64

    65

static void PlaceRail_NE(TileIndex tile)

    66

{

    67

	VpStartPlaceSizing(tile, VPM_FIX_Y);

    68

}

    69

    70

static void PlaceRail_E(TileIndex tile)

    71

{

    72

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

    73

	GenericPlaceRail(tile, cmd);

    74

}

    75

    76

static void PlaceRail_NW(TileIndex tile)

    77

{

    78

	VpStartPlaceSizing(tile, VPM_FIX_X);

    79

}

    80

    81

static void PlaceRail_AutoRail(TileIndex tile)

    82

{

    83

	VpStartPlaceSizing(tile, VPM_RAILDIRS);

    84

}

    85

    86

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

    87

{

    88

	byte b = _m[tile].m5;

    89

    90

	if (b & 0xC0 || !(b & (extra >> 8)))

    91

		return;

    92

    93

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

    94

}

    95

    96

static const uint16 _place_depot_extra[12] = {

    97

	0x604,		0x2102,		0x1202,		0x505,

    98

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

    99

	0x2203,		0x904,		0x0A05,		0x1103,

   100

};

   101

   102

   103

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

   104

{

   105

	if (success) {

   106

		int dir = p2;

   107

   108

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   109

		ResetObjectToPlace();

   110

   111

		tile += TileOffsByDir(dir);

   112

   113

		if (IsTileType(tile, MP_RAILWAY)) {

   114

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   115

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

   116

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

   117

		}

   118

	}

   119

}

   120

   121

static void PlaceRail_Depot(TileIndex tile)

   122

{

   123

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   124

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

   125

}

   126

   127

static void PlaceRail_Waypoint(TileIndex tile)

   128

{

   129

	if (!_remove_button_clicked) {

   130

		DoCommandP(tile, (_waypoint_count > 0) ? (0x100 + _cur_waypoint_type) : 0, 0, CcPlaySound1E, CMD_BUILD_TRAIN_WAYPOINT | CMD_MSG(STR_CANT_BUILD_TRAIN_WAYPOINT));

   131

	} else {

   132

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

   133

	}

   134

}

   135

   136

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

   137

{

   138

	if (success) {

   139

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   140

		ResetObjectToPlace();

   141

	}

   142

}

   143

   144

static void PlaceRail_Station(TileIndex tile)

   145

{

   146

	if(_remove_button_clicked)

   147

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

   148

	else if (_railstation.dragdrop) {

   149

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED);

   150

		VpSetPlaceSizingLimit(_patches.station_spread);

   151

	} else {

   152

		// TODO: Custom station selector GUI. Now we just try using first custom station

   153

		// (and fall back to normal stations if it isn't available).

   154

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

   155

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

   156

	}

   157

}

   158

   159

static void GenericPlaceSignals(TileIndex tile)

   160

{

   161

	uint trackstat;

   162

	int i;

   163

   164

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

   165

   166

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

   167

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

   168

   169

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

   170

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

   171

   172

	// Lookup the bit index

   173

	i = 0;

   174

	if (trackstat != 0) {	while (!(trackstat & 1)) { i++; trackstat >>= 1; }}

   175

   176

	if (!_remove_button_clicked) {

   177

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

   178

			CMD_BUILD_SIGNALS | CMD_AUTO | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   179

	} else {

   180

		DoCommandP(tile, i, 0, CcPlaySound1E,

   181

			CMD_REMOVE_SIGNALS | CMD_AUTO | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   182

	}

   183

}

   184

   185

static void PlaceRail_Bridge(TileIndex tile)

   186

{

   187

	VpStartPlaceSizing(tile, VPM_X_OR_Y);

   188

}

   189

   190

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

   191

{

   192

	if (success) {

   193

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   194

		ResetObjectToPlace();

   195

	} else {

   196

		SetRedErrorSquare(_build_tunnel_endtile);

   197

	}

   198

}

   199

   200

static void PlaceRail_Tunnel(TileIndex tile)

   201

{

   202

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   203

		CMD_BUILD_TUNNEL | CMD_AUTO | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   204

}

   205

   206

void PlaceProc_BuyLand(TileIndex tile)

   207

{

   208

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

   209

}

   210

   211

static void PlaceRail_ConvertRail(TileIndex tile)

   212

{

   213

	VpStartPlaceSizing(tile, VPM_X_AND_Y | GUI_PlaceProc_ConvertRailArea);

   214

}

   215

   216

static void PlaceRail_AutoSignals(TileIndex tile)

   217

{

   218

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS);

   219

}

   220

   221

static void BuildRailClick_N(Window *w)

   222

{

   223

	HandlePlacePushButton(w, 4, _cur_railtype*4 + SPR_CURSOR_NS_TRACK, 1, PlaceRail_N);

   224

}

   225

   226

static void BuildRailClick_NE(Window *w)

   227

{

   228

	HandlePlacePushButton(w, 5, _cur_railtype*4 + SPR_CURSOR_SWNE_TRACK, 1, PlaceRail_NE);

   229

}

   230

   231

static void BuildRailClick_E(Window *w)

   232

{

   233

	HandlePlacePushButton(w, 6, _cur_railtype*4 + SPR_CURSOR_EW_TRACK, 1, PlaceRail_E);

   234

}

   235

   236

static void BuildRailClick_NW(Window *w)

   237

{

   238

	HandlePlacePushButton(w, 7, _cur_railtype*4 + SPR_CURSOR_NWSE_TRACK, 1, PlaceRail_NW);

   239

}

   240

   241

static void BuildRailClick_AutoRail(Window *w)

   242

{

   243

	HandlePlacePushButton(w, 8, SPR_CURSOR_AUTORAIL + _cur_railtype, VHM_RAIL, PlaceRail_AutoRail);

   244

}

   245

   246

static void BuildRailClick_Demolish(Window *w)

   247

{

   248

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

   249

}

   250

   251

static const CursorID _depot_cursors[] = {

   252

	SPR_CURSOR_RAIL_DEPOT,

   253

	SPR_CURSOR_MONO_DEPOT,

   254

	SPR_CURSOR_MAGLEV_DEPOT,

   255

};

   256

   257

static void BuildRailClick_Depot(Window *w)

   258

{

   259

	if (HandlePlacePushButton(w, 10, _depot_cursors[_cur_railtype], 1, PlaceRail_Depot)) ShowBuildTrainDepotPicker();

   260

}

   261

   262

static void BuildRailClick_Waypoint(Window *w)

   263

{

   264

	_waypoint_count = GetCustomStationsCount(STAT_CLASS_WAYP);

   265

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

   266

	    && _waypoint_count > 0)

   267

		ShowBuildWaypointPicker();

   268

}

   269

   270

static void BuildRailClick_Station(Window *w)

   271

{

   272

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

   273

}

   274

   275

static void BuildRailClick_AutoSignals(Window *w)

   276

{

   277

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

   278

}

   279

   280

static void BuildRailClick_Bridge(Window *w)

   281

{

   282

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

   283

}

   284

   285

static void BuildRailClick_Tunnel(Window *w)

   286

{

   287

	HandlePlacePushButton(w, 15, SPR_CURSOR_TUNNEL_RAIL + _cur_railtype, 3, PlaceRail_Tunnel);

   288

}

   289

   290

static void BuildRailClick_Remove(Window *w)

   291

{

   292

	if (w->disabled_state & (1<<16))

   293

		return;

   294

	SetWindowDirty(w);

   295

	SndPlayFx(SND_15_BEEP);

   296

   297

	w->click_state ^= (1 << 16);

   298

	_remove_button_clicked = (w->click_state & (1 << 16)) != 0;

   299

	SetSelectionRed((w->click_state & (1 << 16)) != 0);

   300

   301

	// handle station builder

   302

	if( w->click_state & (1 << 16) )

   303

	{

   304

		if(_remove_button_clicked)

   305

			SetTileSelectSize(1, 1);

   306

		else

   307

			BringWindowToFrontById(WC_BUILD_STATION, 0);

   308

	}

   309

}

   310

   311

static void BuildRailClick_Convert(Window *w)

   312

{

   313

	HandlePlacePushButton(w, 17, SPR_CURSOR_CONVERT_RAIL + _cur_railtype * 2, 1, PlaceRail_ConvertRail);

   314

}

   315

   316

static void BuildRailClick_Landscaping(Window *w)

   317

{

   318

	ShowTerraformToolbar();

   319

}

   320

   321

static void DoRailroadTrack(int mode)

   322

{

   323

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

   324

		_remove_button_clicked ?

   325

		CMD_REMOVE_RAILROAD_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   326

		CMD_BUILD_RAILROAD_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   327

	);

   328

}

   329

   330

static void HandleAutodirPlacement(void)

   331

{

   332

	TileHighlightData *thd = &_thd;

   333

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

   334

   335

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

   336

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

   337

		return;

   338

	}

   339

   340

	DoRailroadTrack(trackstat);

   341

}

   342

   343

static void HandleAutoSignalPlacement(void)

   344

{

   345

	TileHighlightData *thd = &_thd;

   346

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

   347

   348

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

   349

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

   350

		return;

   351

	}

   352

   353

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

   354

	// game can specify his/her own signal density

   355

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

   356

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

   357

	CcPlaySound1E,

   358

	(_remove_button_clicked ?	CMD_REMOVE_SIGNAL_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   359

	                          CMD_BUILD_SIGNAL_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE) ) );

   360

}

   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

   400

   401

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

   402

{

   403

	switch(e->event) {

   404

	case WE_PAINT:

   405

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

   406

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

   407

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

   408

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

   409

		}

   410

		DrawWindowWidgets(w);

   411

		break;

   412

   413

	case WE_CLICK:

   414

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

   415

			_remove_button_clicked = false;

   416

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

   417

		}

   418

	break;

   419

   420

	case WE_KEYPRESS: {

   421

		int i;

   422

   423

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

   424

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

   425

				e->keypress.cont = false;

   426

				_remove_button_clicked = false;

   427

				_build_railroad_button_proc[i](w);

   428

				break;

   429

			}

   430

		}

   431

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

   432

		break;

   433

	}

   434

   435

	case WE_PLACE_OBJ:

   436

		_place_proc(e->place.tile);

   437

		return;

   438

   439

	case WE_PLACE_DRAG: {

   440

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

   441

		return;

   442

	}

   443

   444

	case WE_PLACE_MOUSEUP:

   445

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

   446

			TileIndex start_tile = e->place.starttile;

   447

			TileIndex end_tile = e->place.tile;

   448

   449

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

   450

				ResetObjectToPlace();

   451

				ShowBuildBridgeWindow(start_tile, end_tile, _cur_railtype);

   452

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

   453

				bool old = _remove_button_clicked;

   454

				if (_ctrl_pressed) _remove_button_clicked = true;

   455

				HandleAutodirPlacement();

   456

				_remove_button_clicked = old;

   457

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

   458

				HandleAutoSignalPlacement();

   459

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

   460

				if (GUIPlaceProcDragXY(e)) break;

   461

   462

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

   463

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

   464

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

   465

				HandleStationPlacement(start_tile, end_tile);

   466

			} else

   467

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

   468

		}

   469

		break;

   470

   471

	case WE_ABORT_PLACE_OBJ:

   472

		UnclickWindowButtons(w);

   473

		SetWindowDirty(w);

   474

   475

		w = FindWindowById(WC_BUILD_STATION, 0);

   476

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

   477

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   478

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

   479

		break;

   480

   481

	case WE_PLACE_PRESIZE: {

   482

		TileIndex tile = e->place.tile;

   483

   484

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

   485

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

   486

	} break;

   487

	}

   488

}

   489

   490

   491

static const Widget _build_rail_widgets[] = {

   492

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

   493

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

   494

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

   495

   496

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

   497

   498

{      WWT_PANEL,   RESIZE_NONE,     7,    0,     21,    14,    35, 0x4E3,		STR_1018_BUILD_RAILROAD_TRACK},

   499

{      WWT_PANEL,   RESIZE_NONE,     7,    22,    43,    14,    35, 0x4E4,		STR_1018_BUILD_RAILROAD_TRACK},

   500

{      WWT_PANEL,   RESIZE_NONE,     7,    44,    65,    14,    35, 0x4E5,		STR_1018_BUILD_RAILROAD_TRACK},

   501

{      WWT_PANEL,   RESIZE_NONE,     7,    66,    87,    14,    35, 0x4E6,		STR_1018_BUILD_RAILROAD_TRACK},

   502

{      WWT_PANEL,   RESIZE_NONE,     7,    88,   109,    14,    35, SPR_OPENTTD_BASE + 0, STR_BUILD_AUTORAIL_TIP},