1

/* $Id$ */

     2

     3

/** @file road_gui.cpp GUI for building roads. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gui.h"

     8

#include "window_gui.h"

     9

#include "station_gui.h"

    10

#include "terraform_gui.h"

    11

#include "viewport_func.h"

    12

#include "gfx_func.h"

    13

#include "command_func.h"

    14

#include "variables.h"

    15

#include "road_type.h"

    16

#include "road_cmd.h"

    17

#include "road_map.h"

    18

#include "station_map.h"

    19

#include "functions.h"

    20

#include "window_func.h"

    21

#include "vehicle_func.h"

    22

#include "sound_func.h"

    23

#include "player_func.h"

    24

#include "settings_type.h"

    25

#include "tunnelbridge.h"

    26

    27

#include "table/sprites.h"

    28

#include "table/strings.h"

    29

    30

static void ShowRVStationPicker(RoadStopType rs);

    31

static void ShowRoadDepotPicker();

    32

    33

static bool _remove_button_clicked;

    34

static bool _one_way_button_clicked;

    35

    36

/**

    37

 * Define the values of the RoadFlags

    38

 * @see CmdBuildLongRoad

    39

 */

    40

enum RoadFlags {

    41

	RF_NONE             = 0x00,

    42

	RF_START_HALFROAD_Y = 0x01,    // The start tile in Y-dir should have only a half road

    43

	RF_END_HALFROAD_Y   = 0x02,    // The end tile in Y-dir should have only a half road

    44

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

    45

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

    46

	RF_START_HALFROAD_X = 0x08,    // The start tile in X-dir should have only a half road

    47

	RF_END_HALFROAD_X   = 0x10,    // The end tile in X-dir should have only a half road

    48

};

    49

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    50

    51

static RoadFlags _place_road_flag;

    52

    53

static RoadType _cur_roadtype;

    54

    55

static DiagDirection _road_depot_orientation;

    56

static DiagDirection _road_station_picker_orientation;

    57

    58

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

    59

{

    60

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    61

}

    62

    63

/**

    64

 * Set the initial flags for the road constuction.

    65

 * The flags are:

    66

 * @li The direction is the X-dir

    67

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

    68

 *

    69

 * @param tile The start tile

    70

 */

    71

static void PlaceRoad_X_Dir(TileIndex tile)

    72

{

    73

	_place_road_flag = RF_DIR_X;

    74

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

    75

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_X_DIR);

    76

}

    77

    78

/**

    79

 * Set the initial flags for the road constuction.

    80

 * The flags are:

    81

 * @li The direction is the Y-dir

    82

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

    83

 *

    84

 * @param tile The start tile

    85

 */

    86

static void PlaceRoad_Y_Dir(TileIndex tile)

    87

{

    88

	_place_road_flag = RF_DIR_Y;

    89

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

    90

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_Y_DIR);

    91

}

    92

    93

/**

    94

 * Set the initial flags for the road constuction.

    95

 * The flags are:

    96

 * @li The direction is not set.

    97

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

    98

 *

    99

 * @param tile The start tile

   100

 */

   101

static void PlaceRoad_AutoRoad(TileIndex tile)

   102

{

   103

	_place_road_flag = RF_NONE;

   104

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

   105

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

   106

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   107

}

   108

   109

static void PlaceRoad_Bridge(TileIndex tile)

   110

{

   111

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   112

}

   113

   114

   115

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

   116

{

   117

	if (success) {

   118

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   119

		ResetObjectToPlace();

   120

	} else {

   121

		SetRedErrorSquare(_build_tunnel_endtile);

   122

	}

   123

}

   124

   125

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

   126

struct RoadTypeInfo {

   127

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

   128

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

   129

	StringID err_depot;             ///< Building a depot

   130

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

   131

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

   132

   133

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

   134

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

   135

   136

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

   137

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

   138

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   139

};

   140

   141

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

   142

static const RoadTypeInfo _road_type_infos[] = {

   143

	{

   144

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   145

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   146

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   147

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   148

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   149

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   150

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   151

   152

		SPR_CURSOR_ROAD_NESW,

   153

		SPR_CURSOR_ROAD_NWSE,

   154

		SPR_CURSOR_AUTOROAD,

   155

	},

   156

	{

   157

		STR_CAN_T_BUILD_TRAMWAY_HERE,

   158

		STR_CAN_T_REMOVE_TRAMWAY_FROM,

   159

		STR_CAN_T_BUILD_TRAM_VEHICLE,

   160

		{ STR_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_CAN_T_BUILD_CARGO_TRAM_STATION        },

   161

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,       STR_CAN_T_REMOVE_CARGO_TRAM_STATION       },

   162

		{ STR_PASSENGER_TRAM_STATION_ORIENTATION,        STR_CARGO_TRAM_STATION_ORIENT             },

   163

		{ STR_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   164

   165

		SPR_CURSOR_TRAMWAY_NESW,

   166

		SPR_CURSOR_TRAMWAY_NWSE,

   167

		SPR_CURSOR_AUTOTRAM,

   168

	},

   169

};

   170

   171

static void PlaceRoad_Tunnel(TileIndex tile)

   172

{

   173

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

   174

}

   175

   176

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   177

{

   178

	tile += TileOffsByDiagDir(direction);

   179

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

   180

	if (IsNormalRoadTile(tile)) {

   181

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

   182

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

   183

		}

   184

	}

   185

}

   186

   187

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

   188

{

   189

	if (success) {

   190

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

   191

		SndPlayTileFx(SND_1F_SPLAT, tile);

   192

		ResetObjectToPlace();

   193

		BuildRoadOutsideStation(tile, dir);

   194

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

   195

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

   196

	}

   197

}

   198

   199

static void PlaceRoad_Depot(TileIndex tile)

   200

{

   201

	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));

   202

}

   203

   204

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

   205

{

   206

	uint32 p1 = _road_station_picker_orientation;

   207

   208

	if (p1 >= DIAGDIR_END) {

   209

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

   210

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

   211

	}

   212

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

   213

}

   214

   215

static void PlaceRoad_BusStation(TileIndex tile)

   216

{

   217

	if (_remove_button_clicked) {

   218

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

   219

	} else {

   220

		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]));

   221

	}

   222

}

   223

   224

static void PlaceRoad_TruckStation(TileIndex tile)

   225

{

   226

	if (_remove_button_clicked) {

   227

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

   228

	} else {

   229

		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]));

   230

	}

   231

}

   232

   233

static void PlaceRoad_DemolishArea(TileIndex tile)

   234

{

   235

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_DEMOLISH_AREA);

   236

}

   237

   238

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

   239

enum RoadToolbarWidgets {

   240

	RTW_CLOSEBOX = 0,

   241

	RTW_CAPTION,

   242

	RTW_STICKY,

   243

	RTW_ROAD_X,

   244

	RTW_ROAD_Y,

   245

	RTW_AUTOROAD,

   246

	RTW_DEMOLISH,

   247

	RTW_DEPOT,

   248

	RTW_BUS_STATION,

   249

	RTW_TRUCK_STATION,

   250

	RTW_ONE_WAY,

   251

	RTW_BUILD_BRIDGE,

   252

	RTW_BUILD_TUNNEL,

   253

	RTW_REMOVE,

   254

};

   255

   256

typedef void OnButtonClick(Window *w);

   257

   258

   259

/** Toogles state of the Remove button of Build road toolbar

   260

 * @param w window the button belongs to

   261

 */

   262

static void ToggleRoadButton_Remove(Window *w)

   263

{

   264

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   265

	w->InvalidateWidget(RTW_REMOVE);

   266

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   267

	SetSelectionRed(_remove_button_clicked);

   268

}

   269

   270

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

   271

 * @param w window the button belongs to

   272

 * @return true iff the remove buton was changed

   273

 */

   274

static bool RoadToolbar_CtrlChanged(Window *w)

   275

{

   276

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

   277

   278

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

   279

	for (uint i = RTW_ROAD_X; i <= RTW_AUTOROAD; i++) {

   280

		if (w->IsWidgetLowered(i)) {

   281

			ToggleRoadButton_Remove(w);

   282

			return true;

   283

		}

   284

	}

   285

   286

	return false;

   287

}

   288

   289

   290

/**

   291

 * Function that handles the click on the

   292

 *  X road placement button.

   293

 *

   294

 * @param w The current window

   295

 */

   296

static void BuildRoadClick_X_Dir(Window *w)

   297

{

   298

	HandlePlacePushButton(w, RTW_ROAD_X, _road_type_infos[_cur_roadtype].cursor_nwse, VHM_RECT, PlaceRoad_X_Dir);

   299

}

   300

   301

/**

   302

 * Function that handles the click on the

   303

 *  Y road placement button.

   304

 *

   305

 * @param w The current window

   306

 */

   307

static void BuildRoadClick_Y_Dir(Window *w)

   308

{

   309

	HandlePlacePushButton(w, RTW_ROAD_Y, _road_type_infos[_cur_roadtype].cursor_nesw, VHM_RECT, PlaceRoad_Y_Dir);

   310

}

   311

   312

/**

   313

 * Function that handles the click on the

   314

 *  autoroad placement button.

   315

 *

   316

 * @param w The current window

   317

 */

   318

static void BuildRoadClick_AutoRoad(Window *w)

   319

{

   320

	HandlePlacePushButton(w, RTW_AUTOROAD, _road_type_infos[_cur_roadtype].cursor_autoroad, VHM_RECT, PlaceRoad_AutoRoad);

   321

}

   322

   323

static void BuildRoadClick_Demolish(Window *w)

   324

{

   325

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

   326

}

   327

   328

static void BuildRoadClick_Depot(Window *w)

   329

{

   330

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

   331

	if (HandlePlacePushButton(w, RTW_DEPOT, SPR_CURSOR_ROAD_DEPOT, VHM_RECT, PlaceRoad_Depot)) ShowRoadDepotPicker();

   332

}

   333

   334

static void BuildRoadClick_BusStation(Window *w)

   335

{

   336

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

   337

	if (HandlePlacePushButton(w, RTW_BUS_STATION, SPR_CURSOR_BUS_STATION, VHM_RECT, PlaceRoad_BusStation)) ShowRVStationPicker(ROADSTOP_BUS);

   338

}

   339

   340

static void BuildRoadClick_TruckStation(Window *w)

   341

{

   342

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

   343

	if (HandlePlacePushButton(w, RTW_TRUCK_STATION, SPR_CURSOR_TRUCK_STATION, VHM_RECT, PlaceRoad_TruckStation)) ShowRVStationPicker(ROADSTOP_TRUCK);

   344

}

   345

   346

/**

   347

 * Function that handles the click on the

   348

 *  one way road button.

   349

 *

   350

 * @param w The current window

   351

 */

   352

static void BuildRoadClick_OneWay(Window *w)

   353

{

   354

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

   355

	SetWindowDirty(w);

   356

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   357

	SetSelectionRed(false);

   358

}

   359

   360

static void BuildRoadClick_Bridge(Window *w)

   361

{

   362

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

   363

}

   364

   365

static void BuildRoadClick_Tunnel(Window *w)

   366

{

   367

	HandlePlacePushButton(w, RTW_BUILD_TUNNEL, SPR_CURSOR_ROAD_TUNNEL, VHM_SPECIAL, PlaceRoad_Tunnel);

   368

}

   369

   370

static void BuildRoadClick_Remove(Window *w)

   371

{

   372

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

   373

	ToggleRoadButton_Remove(w);

   374

	SndPlayFx(SND_15_BEEP);

   375

}

   376

   377

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

   378

static OnButtonClick* const _build_road_button_proc[] = {

   379

	BuildRoadClick_X_Dir,

   380

	BuildRoadClick_Y_Dir,

   381

	BuildRoadClick_AutoRoad,

   382

	BuildRoadClick_Demolish,

   383

	BuildRoadClick_Depot,

   384

	BuildRoadClick_BusStation,

   385

	BuildRoadClick_TruckStation,

   386

	BuildRoadClick_OneWay,

   387

	BuildRoadClick_Bridge,

   388

	BuildRoadClick_Tunnel,

   389

	BuildRoadClick_Remove

   390

};

   391

   392

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

   393

static const uint16 _road_keycodes[] = {

   394

	'1',

   395

	'2',

   396

	'3',

   397

	'4',

   398

	'5',

   399

	'6',

   400

	'7',

   401

	'8',

   402

	'B',

   403

	'T',

   404

	'R',

   405

};

   406

   407

/**

   408

 * Update the remove button lowered state of the road toolbar

   409

 *

   410

 * @param w The toolbar window

   411

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

   412

 */

   413

static void UpdateOptionWidgetStatus(Window *w, RoadToolbarWidgets clicked_widget)

   414

{

   415

	/* The remove and the one way button state is driven

   416

	 * by the other buttons so they don't act on themselfs.

   417

	 * Both are only valid if they are able to apply as options. */

   418

	switch (clicked_widget) {

   419

		case RTW_REMOVE:

   420

			w->RaiseWidget(RTW_ONE_WAY);

   421

			w->InvalidateWidget(RTW_ONE_WAY);

   422

			break;

   423

   424

		case RTW_ONE_WAY:

   425

			w->RaiseWidget(RTW_REMOVE);

   426

			w->InvalidateWidget(RTW_REMOVE);

   427

			break;

   428

   429

		case RTW_BUS_STATION:

   430

		case RTW_TRUCK_STATION:

   431

			w->DisableWidget(RTW_ONE_WAY);

   432

			w->SetWidgetDisabledState(RTW_REMOVE, !w->IsWidgetLowered(clicked_widget));

   433

			break;

   434

   435

		case RTW_ROAD_X:

   436

		case RTW_ROAD_Y:

   437

		case RTW_AUTOROAD:

   438

			w->SetWidgetsDisabledState(!w->IsWidgetLowered(clicked_widget),

   439

				RTW_REMOVE,

   440

				RTW_ONE_WAY,

   441

				WIDGET_LIST_END);

   442

			break;

   443

   444

		default:

   445

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

   446

			 * disable the removal button */

   447

			w->SetWidgetsDisabledState(true,

   448

				RTW_REMOVE,

   449

				RTW_ONE_WAY,

   450

				WIDGET_LIST_END);

   451

			w->SetWidgetsLoweredState (false,

   452

				RTW_REMOVE,

   453

				RTW_ONE_WAY,

   454

				WIDGET_LIST_END);

   455

			break;

   456

	}

   457

}

   458

   459

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

   460

{

   461

	switch (e->event) {

   462

		case WE_CREATE:

   463

			w->SetWidgetsDisabledState(true,

   464

				RTW_REMOVE,

   465

				RTW_ONE_WAY,

   466

				WIDGET_LIST_END);

   467

			break;

   468

   469

		case WE_PAINT:

   470

			w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   471

				RTW_DEPOT,

   472

				RTW_BUS_STATION,

   473

				RTW_TRUCK_STATION,

   474

				WIDGET_LIST_END);

   475

			DrawWindowWidgets(w);

   476

			break;

   477

   478

		case WE_CLICK:

   479

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

   480

				_remove_button_clicked = false;

   481

				_one_way_button_clicked = false;

   482

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

   483

			}

   484

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

   485

			if (_ctrl_pressed) RoadToolbar_CtrlChanged(w);

   486

			break;

   487

   488

		case WE_KEYPRESS:

   489