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

#include "tilehighlight_func.h"

    27

    28

#include "table/sprites.h"

    29

#include "table/strings.h"

    30

    31

static void ShowRVStationPicker(RoadStopType rs);

    32

static void ShowRoadDepotPicker();

    33

    34

static bool _remove_button_clicked;

    35

static bool _one_way_button_clicked;

    36

    37

/**

    38

 * Define the values of the RoadFlags

    39

 * @see CmdBuildLongRoad

    40

 */

    41

enum RoadFlags {

    42

	RF_NONE             = 0x00,

    43

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

    44

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

    45

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

    46

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

    47

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

    48

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

    49

};

    50

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    51

    52

static RoadFlags _place_road_flag;

    53

    54

static RoadType _cur_roadtype;

    55

    56

static DiagDirection _road_depot_orientation;

    57

static DiagDirection _road_station_picker_orientation;

    58

    59

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

    60

{

    61

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    62

}

    63

    64

/**

    65

 * Set the initial flags for the road constuction.

    66

 * The flags are:

    67

 * @li The direction is the X-dir

    68

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

    69

 *

    70

 * @param tile The start tile

    71

 */

    72

static void PlaceRoad_X_Dir(TileIndex tile)

    73

{

    74

	_place_road_flag = RF_DIR_X;

    75

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

    76

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_X_DIR);

    77

}

    78

    79

/**

    80

 * Set the initial flags for the road constuction.

    81

 * The flags are:

    82

 * @li The direction is the Y-dir

    83

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

    84

 *

    85

 * @param tile The start tile

    86

 */

    87

static void PlaceRoad_Y_Dir(TileIndex tile)

    88

{

    89

	_place_road_flag = RF_DIR_Y;

    90

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

    91

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_Y_DIR);

    92

}

    93

    94

/**

    95

 * Set the initial flags for the road constuction.

    96

 * The flags are:

    97

 * @li The direction is not set.

    98

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

    99

 *

   100

 * @param tile The start tile

   101

 */

   102

static void PlaceRoad_AutoRoad(TileIndex tile)

   103

{

   104

	_place_road_flag = RF_NONE;

   105

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

   106

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

   107

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   108

}

   109

   110

static void PlaceRoad_Bridge(TileIndex tile)

   111

{

   112

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   113

}

   114

   115

   116

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

   117

{

   118

	if (success) {

   119

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   120

		ResetObjectToPlace();

   121

	} else {

   122

		SetRedErrorSquare(_build_tunnel_endtile);

   123

	}

   124

}

   125

   126

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

   127

struct RoadTypeInfo {

   128

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

   129

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

   130

	StringID err_depot;             ///< Building a depot

   131

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

   132

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

   133

   134

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

   135

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

   136

   137

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

   138

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

   139

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   140

};

   141

   142

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

   143

static const RoadTypeInfo _road_type_infos[] = {

   144

	{

   145

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   146

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   147

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   148

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   149

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   150

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   151

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   152

   153

		SPR_CURSOR_ROAD_NESW,

   154

		SPR_CURSOR_ROAD_NWSE,

   155

		SPR_CURSOR_AUTOROAD,

   156

	},

   157

	{

   158

		STR_CAN_T_BUILD_TRAMWAY_HERE,

   159

		STR_CAN_T_REMOVE_TRAMWAY_FROM,

   160

		STR_CAN_T_BUILD_TRAM_VEHICLE,

   161

		{ STR_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_CAN_T_BUILD_CARGO_TRAM_STATION        },

   162

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,       STR_CAN_T_REMOVE_CARGO_TRAM_STATION       },

   163

		{ STR_PASSENGER_TRAM_STATION_ORIENTATION,        STR_CARGO_TRAM_STATION_ORIENT             },

   164

		{ STR_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   165

   166

		SPR_CURSOR_TRAMWAY_NESW,

   167

		SPR_CURSOR_TRAMWAY_NWSE,

   168

		SPR_CURSOR_AUTOTRAM,

   169

	},

   170

};

   171

   172

static void PlaceRoad_Tunnel(TileIndex tile)

   173

{

   174

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

   175

}

   176

   177

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   178

{

   179

	tile += TileOffsByDiagDir(direction);

   180

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

   181

	if (IsNormalRoadTile(tile)) {

   182

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

   183

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

   184

		}

   185

	}

   186

}

   187

   188

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

   189

{

   190

	if (success) {

   191

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

   192

		SndPlayTileFx(SND_1F_SPLAT, tile);

   193

		ResetObjectToPlace();

   194

		BuildRoadOutsideStation(tile, dir);

   195

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

   196

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

   197

	}

   198

}

   199

   200

static void PlaceRoad_Depot(TileIndex tile)

   201

{

   202

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

   203

}

   204

   205

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

   206

{

   207

	uint32 p1 = _road_station_picker_orientation;

   208

   209

	if (p1 >= DIAGDIR_END) {

   210

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

   211

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

   212

	}

   213

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

   214

}

   215

   216

static void PlaceRoad_BusStation(TileIndex tile)

   217

{

   218

	if (_remove_button_clicked) {

   219

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

   220

	} else {

   221

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

   222

	}

   223

}

   224

   225

static void PlaceRoad_TruckStation(TileIndex tile)

   226

{

   227

	if (_remove_button_clicked) {

   228

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

   229

	} else {

   230

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

   231

	}

   232

}

   233

   234

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

   235

enum RoadToolbarWidgets {

   236

	RTW_CLOSEBOX = 0,

   237

	RTW_CAPTION,

   238

	RTW_STICKY,

   239

	RTW_ROAD_X,

   240

	RTW_ROAD_Y,

   241

	RTW_AUTOROAD,

   242

	RTW_DEMOLISH,

   243

	RTW_DEPOT,

   244

	RTW_BUS_STATION,

   245

	RTW_TRUCK_STATION,

   246

	RTW_ONE_WAY,

   247

	RTW_BUILD_BRIDGE,

   248

	RTW_BUILD_TUNNEL,

   249

	RTW_REMOVE,

   250

};

   251

   252

typedef void OnButtonClick(Window *w);

   253

   254

   255

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

   256

 * @param w window the button belongs to

   257

 */

   258

static void ToggleRoadButton_Remove(Window *w)

   259

{

   260

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   261

	w->InvalidateWidget(RTW_REMOVE);

   262

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   263

	SetSelectionRed(_remove_button_clicked);

   264

}

   265

   266

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

   267

 * @param w window the button belongs to

   268

 * @return true iff the remove buton was changed

   269

 */

   270

static bool RoadToolbar_CtrlChanged(Window *w)

   271

{

   272

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

   273

   274

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

   275

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

   276

		if (w->IsWidgetLowered(i)) {

   277

			ToggleRoadButton_Remove(w);

   278

			return true;

   279

		}

   280

	}

   281

   282

	return false;

   283

}

   284

   285

   286

/**

   287

 * Function that handles the click on the

   288

 *  X road placement button.

   289

 *

   290

 * @param w The current window

   291

 */

   292

static void BuildRoadClick_X_Dir(Window *w)

   293

{

   294

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

   295

}

   296

   297

/**

   298

 * Function that handles the click on the

   299

 *  Y road placement button.

   300

 *

   301

 * @param w The current window

   302

 */

   303

static void BuildRoadClick_Y_Dir(Window *w)

   304

{

   305

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

   306

}

   307

   308

/**

   309

 * Function that handles the click on the

   310

 *  autoroad placement button.

   311

 *

   312

 * @param w The current window

   313

 */

   314

static void BuildRoadClick_AutoRoad(Window *w)

   315

{

   316

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

   317

}

   318

   319

static void BuildRoadClick_Demolish(Window *w)

   320

{

   321

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

   322

}

   323

   324

static void BuildRoadClick_Depot(Window *w)

   325

{

   326

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

   327

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

   328

}

   329

   330

static void BuildRoadClick_BusStation(Window *w)

   331

{

   332

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

   333

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

   334

}

   335

   336

static void BuildRoadClick_TruckStation(Window *w)

   337

{

   338

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

   339

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

   340

}

   341

   342

/**

   343

 * Function that handles the click on the

   344

 *  one way road button.

   345

 *

   346

 * @param w The current window

   347

 */

   348

static void BuildRoadClick_OneWay(Window *w)

   349

{

   350

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

   351

	w->SetDirty();

   352

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   353

	SetSelectionRed(false);

   354

}

   355

   356

static void BuildRoadClick_Bridge(Window *w)

   357

{

   358

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

   359

}

   360

   361

static void BuildRoadClick_Tunnel(Window *w)

   362

{

   363

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

   364

}

   365

   366

static void BuildRoadClick_Remove(Window *w)

   367

{

   368

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

   369

	ToggleRoadButton_Remove(w);

   370

	SndPlayFx(SND_15_BEEP);

   371

}

   372

   373

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

   374

static OnButtonClick* const _build_road_button_proc[] = {

   375

	BuildRoadClick_X_Dir,

   376

	BuildRoadClick_Y_Dir,

   377

	BuildRoadClick_AutoRoad,

   378

	BuildRoadClick_Demolish,

   379

	BuildRoadClick_Depot,

   380

	BuildRoadClick_BusStation,

   381

	BuildRoadClick_TruckStation,

   382

	BuildRoadClick_OneWay,

   383

	BuildRoadClick_Bridge,

   384

	BuildRoadClick_Tunnel,

   385

	BuildRoadClick_Remove

   386

};

   387

   388

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

   389

static const uint16 _road_keycodes[] = {

   390

	'1',

   391

	'2',

   392

	'3',

   393

	'4',

   394

	'5',

   395

	'6',

   396

	'7',

   397

	'8',

   398

	'B',

   399

	'T',

   400

	'R',

   401

};

   402

   403

/**

   404

 * Update the remove button lowered state of the road toolbar

   405

 *

   406

 * @param w The toolbar window

   407

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

   408

 */

   409

static void UpdateOptionWidgetStatus(Window *w, RoadToolbarWidgets clicked_widget)

   410

{

   411

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

   412

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

   413

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

   414

	switch (clicked_widget) {

   415

		case RTW_REMOVE:

   416

			w->RaiseWidget(RTW_ONE_WAY);

   417

			w->InvalidateWidget(RTW_ONE_WAY);

   418

			break;

   419

   420

		case RTW_ONE_WAY:

   421

			w->RaiseWidget(RTW_REMOVE);

   422

			w->InvalidateWidget(RTW_REMOVE);

   423

			break;

   424

   425

		case RTW_BUS_STATION:

   426

		case RTW_TRUCK_STATION:

   427

			w->DisableWidget(RTW_ONE_WAY);

   428

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

   429

			break;

   430

   431

		case RTW_ROAD_X:

   432

		case RTW_ROAD_Y:

   433

		case RTW_AUTOROAD:

   434

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

   435

				RTW_REMOVE,

   436

				RTW_ONE_WAY,

   437

				WIDGET_LIST_END);

   438

			break;

   439

   440

		default:

   441

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

   442

			 * disable the removal button */

   443

			w->SetWidgetsDisabledState(true,

   444

				RTW_REMOVE,

   445

				RTW_ONE_WAY,

   446

				WIDGET_LIST_END);

   447

			w->SetWidgetsLoweredState (false,

   448

				RTW_REMOVE,

   449

				RTW_ONE_WAY,

   450

				WIDGET_LIST_END);

   451

			break;

   452

	}

   453

}

   454

   455

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

   456

{

   457

	switch (e->event) {

   458

		case WE_CREATE:

   459

			w->SetWidgetsDisabledState(true,

   460

				RTW_REMOVE,

   461

				RTW_ONE_WAY,

   462

				WIDGET_LIST_END);

   463

			break;

   464

   465

		case WE_PAINT:

   466

			w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   467

				RTW_DEPOT,

   468

				RTW_BUS_STATION,

   469

				RTW_TRUCK_STATION,

   470

				WIDGET_LIST_END);

   472

			break;

   473

   474

		case WE_CLICK:

   475

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

   476

				_remove_button_clicked = false;

   477

				_one_way_button_clicked = false;

   478

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

   479

			}

   480

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

   481

			if (_ctrl_pressed) RoadToolbar_CtrlChanged(w);

   482

			break;

   483

   484

		case WE_KEYPRESS:

   485

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

   486

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

   487

					e->we.keypress.cont = false;

   488

					_remove_button_clicked = false;