1

/* $Id$ */

     2

     3

/** @file road_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/sprites.h"

     8

#include "table/strings.h"

     9

#include "strings.h"

    10

#include "functions.h"

    11

#include "map.h"

    12

#include "tile.h"

    13

#include "window.h"

    14

#include "gui.h"

    15

#include "viewport.h"

    16

#include "gfx.h"

    17

#include "sound.h"

    18

#include "command.h"

    19

#include "variables.h"

    20

#include "road.h"

    21

#include "road_cmd.h"

    22

#include "road_map.h"

    23

#include "station_map.h"

    24

//needed for catchments

    25

#include "station.h"

    26

    27

    28

static void ShowRVStationPicker(RoadStop::Type rs);

    29

static void ShowRoadDepotPicker();

    30

    31

static bool _remove_button_clicked;

    32

    33

/**

    34

 * Define the values of the RoadFlags

    35

 * @see CmdBuildLongRoad

    36

 */

    37

enum RoadFlags {

    38

	RF_NONE             = 0x00,

    41

	RF_DIR_Y            = 0x04,    // The direction is Y-dir

    42

	RF_DIR_X            = RF_NONE, // Dummy; Dir X is set when RF_DIR_Y is not set

    45

};

    46

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    47

    48

static RoadFlags _place_road_flag;

    49

    50

static RoadType _cur_roadtype;

    51

    52

static DiagDirection _road_depot_orientation;

    53

static DiagDirection _road_station_picker_orientation;

    54

    55

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

    56

{

    57

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    58

}

    59

    60

/**

    61

 * Set the initial flags for the road constuction.

    62

 * The flags are:

    63

 * @li The direction is the Y-dir

    64

 * @li The first tile has a partitial RoadBit (true or false)

    65

 *

    66

 * @param tile The start tile

    67

 */

    68

static void PlaceRoad_NE(TileIndex tile)

    69

{

    70

	_place_road_flag = RF_DIR_Y;

    71

	if (_tile_fract_coords.y >= 8) _place_road_flag |= RF_START_HALFROAD_Y;

    72

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_NE);

    73

}

    74

    75

/**

    76

 * Set the initial flags for the road constuction.

    77

 * The flags are:

    78

 * @li The direction is the X-dir

    79

 * @li The first tile has a partitial RoadBit (true or false)

    80

 *

    81

 * @param tile The start tile

    82

 */

    83

static void PlaceRoad_NW(TileIndex tile)

    84

{

    85

	_place_road_flag = RF_DIR_X;

    86

	if (_tile_fract_coords.x >= 8) _place_road_flag |= RF_START_HALFROAD_X;

    87

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_NW);

    88

}

    89

    90

/**

    91

 * Set the initial flags for the road constuction.

    92

 * The flags are:

    93

 * @li The direction is not set.

    94

 * @li The first tile has a partitial RoadBit (true or false)

    95

 *

    96

 * @param tile The start tile

    97

 */

    98

static void PlaceRoad_AutoRoad(TileIndex tile)

    99

{

   100

	_place_road_flag = RF_NONE;

   101

	if (_tile_fract_coords.x >= 8) _place_road_flag |= RF_START_HALFROAD_X;

   102

	if (_tile_fract_coords.y >= 8) _place_road_flag |= RF_START_HALFROAD_Y;

   103

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   104

}

   105

   106

static void PlaceRoad_Bridge(TileIndex tile)

   107

{

   108

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   109

}

   110

   111

   112

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

   113

{

   114

	if (success) {

   115

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   116

		ResetObjectToPlace();

   117

	} else {

   118

		SetRedErrorSquare(_build_tunnel_endtile);

   119

	}

   120

}

   121

   122

/** Structure holding information per roadtype for several functions */

   123

struct RoadTypeInfo {

   124

	StringID err_build_road;        ///< Building a normal piece of road

   125

	StringID err_remove_road;       ///< Removing a normal piece of road

   126

	StringID err_depot;             ///< Building a depot

   127

	StringID err_build_station[2];  ///< Building a bus or truck station

   128

	StringID err_remove_station[2]; ///< Removing of a bus or truck station

   129

   130

	StringID picker_title[2];       ///< Title for the station picker for bus or truck stations

   131

	StringID picker_tooltip[2];     ///< Tooltip for the station picker for bus or truck stations

   132

   133

	SpriteID cursor_nesw;           ///< Cursor for building NE and SW bits

   134

	SpriteID cursor_nwse;           ///< Cursor for building NW and SE bits

   135

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   136

};

   137

   138

/** What errors/cursors must be shown for several types of roads */

   139

static const RoadTypeInfo _road_type_infos[] = {

   140

	{

   141

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   142

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   143

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   144

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   145

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   146

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   147

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   148

   149

		SPR_CURSOR_ROAD_NESW,

   150

		SPR_CURSOR_ROAD_NWSE,

   151

		SPR_CURSOR_AUTOROAD,

   152

	},

   153

	{

   154

		STR_1804_CAN_T_BUILD_TRAMWAY_HERE,

   155

		STR_1805_CAN_T_REMOVE_TRAMWAY_FROM,

   156

		STR_1807_CAN_T_BUILD_TRAM_VEHICLE,

   157

		{ STR_1808_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_1809_CAN_T_BUILD_CARGO_TRAM_STATION        },

   158

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,            STR_CAN_T_REMOVE_CARGO_TRAM_STATION            },

   159

		{ STR_3042_PASSENGER_TRAM_STATION_ORIENTATION,        STR_3043_CARGO_TRAM_STATION_ORIENT             },

   160

		{ STR_3051_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_3052_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   161

   162

		SPR_CURSOR_TRAMWAY_NESW,

   163

		SPR_CURSOR_TRAMWAY_NWSE,

   164

		SPR_CURSOR_AUTOTRAM,

   165

	},

   166

};

   167

   168

static void PlaceRoad_Tunnel(TileIndex tile)

   169

{

   170

	DoCommandP(tile, 0x200 | RoadTypeToRoadTypes(_cur_roadtype), 0, CcBuildRoadTunnel, CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   171

}

   172

   173

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   174

{

   175

	tile += TileOffsByDiagDir(direction);

   176

	// if there is a roadpiece just outside of the station entrance, build a connecting route

   177

	if (IsTileType(tile, MP_ROAD) && GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   178

		if (GetRoadBits(tile, _cur_roadtype) != ROAD_NONE) {

   179

			DoCommandP(tile, _cur_roadtype << 4 | DiagDirToRoadBits(ReverseDiagDir(direction)), 0, NULL, CMD_BUILD_ROAD);

   180

		}

   181

	}

   182

}

   183

   184

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

   185

{

   186

	if (success) {

   187

		DiagDirection dir = (DiagDirection)GB(p1, 0, 2);

   188

		SndPlayTileFx(SND_1F_SPLAT, tile);

   189

		ResetObjectToPlace();

   190

		BuildRoadOutsideStation(tile, dir);

   191

		/* For a drive-through road stop build connecting road for other entrance */

   192

		if (HASBIT(p2, 1)) BuildRoadOutsideStation(tile, ReverseDiagDir(dir));

   193

	}

   194

}

   195

   196

static void PlaceRoad_Depot(TileIndex tile)

   197

{

   198

	DoCommandP(tile, _cur_roadtype << 2 | _road_depot_orientation, 0, CcRoadDepot, CMD_BUILD_ROAD_DEPOT | CMD_NO_WATER | CMD_MSG(_road_type_infos[_cur_roadtype].err_depot));

   199

}

   200

   201

static void PlaceRoadStop(TileIndex tile, uint32 p2, uint32 cmd)

   202

{

   203

	uint32 p1 = _road_station_picker_orientation;

   204

   205

	if (p1 >= DIAGDIR_END) {

   206

		SETBIT(p2, 1); // It's a drive-through stop

   207

		p1 -= DIAGDIR_END; // Adjust picker result to actual direction

   208

	}

   209

	DoCommandP(tile, p1, p2, CcRoadDepot, cmd);

   210

}

   211

   212

static void PlaceRoad_BusStation(TileIndex tile)

   213

{

   214

	if (_remove_button_clicked) {

   215

		DoCommandP(tile, 0, RoadStop::BUS, CcPlaySound1D, CMD_REMOVE_ROAD_STOP | CMD_MSG(_road_type_infos[_cur_roadtype].err_remove_station[RoadStop::BUS]));

   216

	} else {

   217

		PlaceRoadStop(tile, (_ctrl_pressed << 5) | RoadTypeToRoadTypes(_cur_roadtype) << 2 | RoadStop::BUS, CMD_BUILD_ROAD_STOP | CMD_NO_WATER | CMD_MSG(_road_type_infos[_cur_roadtype].err_build_station[RoadStop::BUS]));

   218

	}

   219

}

   220

   221

static void PlaceRoad_TruckStation(TileIndex tile)

   222

{

   223

	if (_remove_button_clicked) {

   224

		DoCommandP(tile, 0, RoadStop::TRUCK, CcPlaySound1D, CMD_REMOVE_ROAD_STOP | CMD_MSG(_road_type_infos[_cur_roadtype].err_remove_station[RoadStop::TRUCK]));

   225

	} else {

   226

		PlaceRoadStop(tile, (_ctrl_pressed << 5) | RoadTypeToRoadTypes(_cur_roadtype) << 2 | RoadStop::TRUCK, CMD_BUILD_ROAD_STOP | CMD_NO_WATER | CMD_MSG(_road_type_infos[_cur_roadtype].err_build_station[RoadStop::TRUCK]));

   227

	}

   228

}

   229

   230

static void PlaceRoad_DemolishArea(TileIndex tile)

   231

{

   232

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_DEMOLISH_AREA);

   233

}

   234

   235

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

   236

enum RoadToolbarWidgets {

   237

	RTW_CLOSEBOX = 0,

   238

	RTW_CAPTION,

   239

	RTW_STICKY,

   240

	RTW_ROAD_X,

   241

	RTW_ROAD_Y,

   242

	RTW_AUTOROAD,

   243

	RTW_DEMOLISH,

   244

	RTW_DEPOT,

   245

	RTW_BUS_STATION,

   246

	RTW_TRUCK_STATION,

   247

	RTW_BUILD_BRIDGE,

   248

	RTW_BUILD_TUNNEL,

   249

	RTW_REMOVE,

   250

};

   251

   252

typedef void OnButtonClick(Window *w);

   253

   254

/**

   255

 * Function that handles the click on the

   256

 *  X road placement button.

   257

 *

   258

 * @param w The current window

   259

 */

   260

static void BuildRoadClick_NE(Window *w)

   261

{

   263

}

   264

   265

/**

   266

 * Function that handles the click on the

   267

 *  Y road placement button.

   268

 *

   269

 * @param w The current window

   270

 */

   271

static void BuildRoadClick_NW(Window *w)

   272

{

   274

}

   275

   276

/**

   277

 * Function that handles the click on the

   278

 *  autoroad placement button.

   279

 *

   280

 * @param w The current window

   281

 */

   282

static void BuildRoadClick_AutoRoad(Window *w)

   283

{

   285

}

   286

   287

static void BuildRoadClick_Demolish(Window *w)

   288

{

   290

}

   291

   292

static void BuildRoadClick_Depot(Window *w)

   293

{

   294

	if (_game_mode == GM_EDITOR || !CanBuildVehicleInfrastructure(VEH_ROAD)) return;

   296

}

   297

   298

static void BuildRoadClick_BusStation(Window *w)

   299

{

   300

	if (_game_mode == GM_EDITOR || !CanBuildVehicleInfrastructure(VEH_ROAD)) return;

   302

}

   303

   304

static void BuildRoadClick_TruckStation(Window *w)

   305

{

   306

	if (_game_mode == GM_EDITOR || !CanBuildVehicleInfrastructure(VEH_ROAD)) return;

   308

}

   309

   310

static void BuildRoadClick_Bridge(Window *w)

   311

{

   313

}

   314

   315

static void BuildRoadClick_Tunnel(Window *w)

   316

{

   318

}

   319

   320

static void BuildRoadClick_Remove(Window *w)

   321

{

   322

	if (IsWindowWidgetDisabled(w, RTW_REMOVE)) return;

   323

	SetWindowDirty(w);

   324

	SndPlayFx(SND_15_BEEP);

   325

	ToggleWidgetLoweredState(w, RTW_REMOVE);

   326

	SetSelectionRed(IsWindowWidgetLowered(w, RTW_REMOVE));

   327

}

   328

   329

/** Array with the handlers of the button-clicks for the road-toolbar */

   330

static OnButtonClick* const _build_road_button_proc[] = {

   331

	BuildRoadClick_NE,

   332

	BuildRoadClick_NW,

   333

	BuildRoadClick_AutoRoad,

   334

	BuildRoadClick_Demolish,

   335

	BuildRoadClick_Depot,

   336

	BuildRoadClick_BusStation,

   337

	BuildRoadClick_TruckStation,

   338

	BuildRoadClick_Bridge,

   339

	BuildRoadClick_Tunnel,

   340

	BuildRoadClick_Remove

   341

};

   342

   343

/** Array with the keycode of the button-clicks for the road-toolbar */

   344

static const uint16 _road_keycodes[] = {

   345

	'1',

   346

	'2',

   347

	'3',

   348

	'4',

   349

	'5',

   350

	'6',

   351

	'7',

   352

	'B',

   353

	'T',

   354

	'R',

   355

};

   356

   357

/**

   358

 * Update the remove button lowered state of the road toolbar

   359

 *

   360

 * @param w The toolbar window

   361

 * @param clicked_widget The widget which the player clicked just now

   362

 */

   363

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   364

{

   365

	switch (clicked_widget) {

   366

		case RTW_REMOVE:

   367

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

   368

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

   369

			return;

   370

			break;

   371

		case RTW_ROAD_X:

   372

		case RTW_ROAD_Y:

   373

		case RTW_AUTOROAD:

   374

		case RTW_BUS_STATION:

   375

		case RTW_TRUCK_STATION:

   376

			/* Removal button is enabled only if the road/station

   377

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

   378

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

   379

			break;

   380

   381

		default:

   382

			/* When any other buttons than road/station, raise and

   383

			 * disable the removal button */

   384

			DisableWindowWidget(w, RTW_REMOVE);

   385

			RaiseWindowWidget(w, RTW_REMOVE);

   386

			break;

   387

	}

   388

}

   389

   390

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

   391

{

   392

	switch (e->event) {

   393

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

   394

   395

	case WE_PAINT:

   396

		SetWindowWidgetsDisabledState(w, !CanBuildVehicleInfrastructure(VEH_ROAD),

   397

			RTW_DEPOT,

   398

			RTW_BUS_STATION,

   399

			RTW_TRUCK_STATION,

   400

			WIDGET_LIST_END);

   401

		DrawWindowWidgets(w);

   402

		break;

   403

   404

	case WE_CLICK:

   405

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

   406

			_remove_button_clicked = false;

   407

			_build_road_button_proc[e->we.click.widget - RTW_ROAD_X](w);

   408

		}

   409

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

   410

		break;

   411

   412

	case WE_KEYPRESS:

   413

		for (uint8 i = 0; i != lengthof(_road_keycodes); i++) {

   414

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

   415

				e->we.keypress.cont = false;

   416

				_remove_button_clicked = false;

   417

				_build_road_button_proc[i](w);

   418

				UpdateRemoveWidgetStatus(w, i + RTW_ROAD_X);

   419

				break;

   420

			}

   421

		}

   422

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

   423

		break;

   424

   425

	case WE_PLACE_OBJ:

   426

		_remove_button_clicked = IsWindowWidgetLowered(w, RTW_REMOVE);

   427

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

   428

		break;

   429

   430

	case WE_ABORT_PLACE_OBJ:

   431

		RaiseWindowButtons(w);

   432

		DisableWindowWidget(w, RTW_REMOVE);

   433

		InvalidateWidget(w, RTW_REMOVE);

   434

   435

		w = FindWindowById(WC_BUS_STATION, 0);

   436

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

   437

		w = FindWindowById(WC_TRUCK_STATION, 0);

   438

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

   439

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   440

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

   441

		break;

   442

   443

	case WE_PLACE_DRAG:

   444

		/* Here we update the end tile flags

   445

		 * of the road placement actions.

   446

		 * At first we reset the end halfroad

   447

		 * bits and if needed we set them again. */

   448

		switch (e->we.place.select_proc) {

   449

			case DDSP_PLACE_ROAD_NE:

   450

				_place_road_flag &= ~RF_END_HALFROAD_Y;

   451

				if (e->we.place.pt.y & 8) _place_road_flag |= RF_END_HALFROAD_Y;

   452

				break;

   453

   454

			case DDSP_PLACE_ROAD_NW:

   455

				_place_road_flag &= ~RF_END_HALFROAD_X;

   456

				if (e->we.place.pt.x & 8) _place_road_flag |= RF_END_HALFROAD_X;

   457

				break;

   458

   459

			case DDSP_PLACE_AUTOROAD:

   460

				_place_road_flag &= ~(RF_END_HALFROAD_Y | RF_END_HALFROAD_X);

   461

				if (e->we.place.pt.y & 8) _place_road_flag |= RF_END_HALFROAD_Y;

   462

				if (e->we.place.pt.x & 8) _place_road_flag |= RF_END_HALFROAD_X;

   463

   464

				/* For autoroad we need to update the

   465

				 * direction of the road */

   466

				if (_thd.size.x > _thd.size.y || (_thd.size.x == _thd.size.y &&

   467

						(_tile_fract_coords.x < _tile_fract_coords.y && (_tile_fract_coords.x + _tile_fract_coords.y) < 16) ||

   468

						(_tile_fract_coords.x > _tile_fract_coords.y && (_tile_fract_coords.x + _tile_fract_coords.y) > 16) )) {

   469

					/* Set dir = X */

   470

					_place_road_flag &= ~RF_DIR_Y;

   471

				} else {

   472

					/* Set dir = Y */

   473

					_place_road_flag |= RF_DIR_Y;

   474

				}

   475

   476

				break;

   477

		}

   478

   479

		VpSelectTilesWithMethod(e->we.place.pt.x, e->we.place.pt.y, e->we.place.select_method);

   480

		return;

   481

   482

	case WE_PLACE_MOUSEUP:

   483

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

   484

			TileIndex start_tile = e->we.place.starttile;

   485

			TileIndex end_tile = e->we.place.tile;

   486

   487

			switch (e->we.place.select_proc) {

   488

				case DDSP_BUILD_BRIDGE:

   489

					ResetObjectToPlace();

   490

					ShowBuildBridgeWindow(start_tile, end_tile, 0x80 | RoadTypeToRoadTypes(_cur_roadtype));

   491

					break;

   492