1

/* $Id$ */

     2

     3

/** @file road_gui.cpp */

     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

    26

#include "table/sprites.h"

    27

#include "table/strings.h"

    28

    29

static void ShowRVStationPicker(RoadStopType rs);

    30

static void ShowRoadDepotPicker();

    31

    32

static bool _remove_button_clicked;

    33

static bool _one_way_button_clicked;

    34

    35

/**

    36

 * Define the values of the RoadFlags

    37

 * @see CmdBuildLongRoad

    38

 */

    39

enum RoadFlags {

    40

	RF_NONE             = 0x00,

    41

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

    42

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

    43

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

    44

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

    45

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

    46

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

    47

};

    48

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    49

    50

static RoadFlags _place_road_flag;

    51

    52

static RoadType _cur_roadtype;

    53

    54

static DiagDirection _road_depot_orientation;

    55

static DiagDirection _road_station_picker_orientation;

    56

    57

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

    58

{

    59

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    60

}

    61

    62

/**

    63

 * Set the initial flags for the road constuction.

    64

 * The flags are:

    65

 * @li The direction is the X-dir

    66

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

    67

 *

    68

 * @param tile The start tile

    69

 */

    70

static void PlaceRoad_X_Dir(TileIndex tile)

    71

{

    72

	_place_road_flag = RF_DIR_X;

    73

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

    74

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_X_DIR);

    75

}

    76

    77

/**

    78

 * Set the initial flags for the road constuction.

    79

 * The flags are:

    80

 * @li The direction is the Y-dir

    81

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

    82

 *

    83

 * @param tile The start tile

    84

 */

    85

static void PlaceRoad_Y_Dir(TileIndex tile)

    86

{

    87

	_place_road_flag = RF_DIR_Y;

    88

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

    89

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_Y_DIR);

    90

}

    91

    92

/**

    93

 * Set the initial flags for the road constuction.

    94

 * The flags are:

    95

 * @li The direction is not set.

    96

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

    97

 *

    98

 * @param tile The start tile

    99

 */

   100

static void PlaceRoad_AutoRoad(TileIndex tile)

   101

{

   102

	_place_road_flag = RF_NONE;

   103

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

   104

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

   105

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   106

}

   107

   108

static void PlaceRoad_Bridge(TileIndex tile)

   109

{

   110

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   111

}

   112

   113

   114

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

   115

{

   116

	if (success) {

   117

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   118

		ResetObjectToPlace();

   119

	} else {

   120

		SetRedErrorSquare(_build_tunnel_endtile);

   121

	}

   122

}

   123

   124

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

   125

struct RoadTypeInfo {

   126

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

   127

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

   128

	StringID err_depot;             ///< Building a depot

   129

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

   130

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

   131

   132

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

   133

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

   134

   135

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

   136

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

   137

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   138

};

   139

   140

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

   141

static const RoadTypeInfo _road_type_infos[] = {

   142

	{

   143

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   144

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   145

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   146

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   147

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   148

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   149

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   150

   151

		SPR_CURSOR_ROAD_NESW,

   152

		SPR_CURSOR_ROAD_NWSE,

   153

		SPR_CURSOR_AUTOROAD,

   154

	},

   155

	{

   156

		STR_CAN_T_BUILD_TRAMWAY_HERE,

   157

		STR_CAN_T_REMOVE_TRAMWAY_FROM,

   158

		STR_CAN_T_BUILD_TRAM_VEHICLE,

   159

		{ STR_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_CAN_T_BUILD_CARGO_TRAM_STATION        },

   160

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,       STR_CAN_T_REMOVE_CARGO_TRAM_STATION       },

   161

		{ STR_PASSENGER_TRAM_STATION_ORIENTATION,        STR_CARGO_TRAM_STATION_ORIENT             },

   162

		{ STR_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   163

   164

		SPR_CURSOR_TRAMWAY_NESW,

   165

		SPR_CURSOR_TRAMWAY_NWSE,

   166

		SPR_CURSOR_AUTOTRAM,

   167

	},

   168

};

   169

   170

static void PlaceRoad_Tunnel(TileIndex tile)

   171

{

   172

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

   173

}

   174

   175

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   176

{

   177

	tile += TileOffsByDiagDir(direction);

   178

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

   179

	if (IsNormalRoadTile(tile)) {

   180

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

   181

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

   182

		}

   183

	}

   184

}

   185

   186

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

   187

{

   188

	if (success) {

   189

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

   190

		SndPlayTileFx(SND_1F_SPLAT, tile);

   191

		ResetObjectToPlace();

   192

		BuildRoadOutsideStation(tile, dir);

   193

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

   194

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

   195

	}

   196

}

   197

   198

static void PlaceRoad_Depot(TileIndex tile)

   199

{

   200

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

   201

}

   202

   203

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

   204

{

   205

	uint32 p1 = _road_station_picker_orientation;

   206

   207

	if (p1 >= DIAGDIR_END) {

   208

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

   209

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

   210

	}

   211

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

   212

}

   213

   214

static void PlaceRoad_BusStation(TileIndex tile)

   215

{

   216

	if (_remove_button_clicked) {

   217

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

   218

	} else {

   219

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

   220

	}

   221

}

   222

   223

static void PlaceRoad_TruckStation(TileIndex tile)

   224

{

   225

	if (_remove_button_clicked) {

   226

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

   227

	} else {

   228

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

   229

	}

   230

}

   231

   232

static void PlaceRoad_DemolishArea(TileIndex tile)

   233

{

   234

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_DEMOLISH_AREA);

   235

}

   236

   237

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

   238

enum RoadToolbarWidgets {

   239

	RTW_CLOSEBOX = 0,

   240

	RTW_CAPTION,

   241

	RTW_STICKY,

   242

	RTW_ROAD_X,

   243

	RTW_ROAD_Y,

   244

	RTW_AUTOROAD,

   245

	RTW_DEMOLISH,

   246

	RTW_DEPOT,

   247

	RTW_BUS_STATION,

   248

	RTW_TRUCK_STATION,

   249

	RTW_ONE_WAY,

   250

	RTW_BUILD_BRIDGE,

   251

	RTW_BUILD_TUNNEL,

   252

	RTW_REMOVE,

   253

};

   254

   255

typedef void OnButtonClick(Window *w);

   256

   257

   258

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

   259

 * @param w window the button belongs to

   260

 */

   261

static void ToggleRoadButton_Remove(Window *w)

   262

{

   263

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   264

	w->InvalidateWidget(RTW_REMOVE);

   265

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   266

	SetSelectionRed(_remove_button_clicked);

   267

}

   268

   269

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

   270

 * @param w window the button belongs to

   271

 * @return true iff the remove buton was changed

   272

 */

   273

static bool RoadToolbar_CtrlChanged(Window *w)

   274

{

   275

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

   276

   277

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

   278

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

   279

		if (w->IsWidgetLowered(i)) {

   280

			ToggleRoadButton_Remove(w);

   281

			return true;

   282

		}

   283

	}

   284

   285

	return false;

   286

}

   287

   288

   289

/**

   290

 * Function that handles the click on the

   291

 *  X road placement button.

   292

 *

   293

 * @param w The current window

   294

 */

   295

static void BuildRoadClick_X_Dir(Window *w)

   296

{

   297

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

   298

}

   299

   300

/**

   301

 * Function that handles the click on the

   302

 *  Y road placement button.

   303

 *

   304

 * @param w The current window

   305

 */

   306

static void BuildRoadClick_Y_Dir(Window *w)

   307

{

   308

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

   309

}

   310

   311

/**

   312

 * Function that handles the click on the

   313

 *  autoroad placement button.

   314

 *

   315

 * @param w The current window

   316

 */

   317

static void BuildRoadClick_AutoRoad(Window *w)

   318

{

   319

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

   320

}

   321

   322

static void BuildRoadClick_Demolish(Window *w)

   323

{

   324

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

   325

}

   326

   327

static void BuildRoadClick_Depot(Window *w)

   328

{

   329

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

   330

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

   331

}

   332

   333

static void BuildRoadClick_BusStation(Window *w)

   334

{

   335

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

   336

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

   337

}

   338

   339

static void BuildRoadClick_TruckStation(Window *w)

   340

{

   341

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

   342

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

   343

}

   344

   345

/**

   346

 * Function that handles the click on the

   347

 *  one way road button.

   348

 *

   349

 * @param w The current window

   350

 */

   351

static void BuildRoadClick_OneWay(Window *w)

   352

{

   353

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

   354

	SetWindowDirty(w);

   355

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   356

	SetSelectionRed(false);

   357

}

   358

   359

static void BuildRoadClick_Bridge(Window *w)

   360

{

   361

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

   362

}

   363

   364

static void BuildRoadClick_Tunnel(Window *w)

   365

{

   366

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

   367

}

   368

   369

static void BuildRoadClick_Remove(Window *w)

   370

{

   371

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

   372

	ToggleRoadButton_Remove(w);

   373

	SndPlayFx(SND_15_BEEP);

   374

}

   375

   376

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

   377

static OnButtonClick* const _build_road_button_proc[] = {

   378

	BuildRoadClick_X_Dir,

   379

	BuildRoadClick_Y_Dir,

   380

	BuildRoadClick_AutoRoad,

   381

	BuildRoadClick_Demolish,

   382

	BuildRoadClick_Depot,

   383

	BuildRoadClick_BusStation,

   384

	BuildRoadClick_TruckStation,

   385

	BuildRoadClick_OneWay,

   386

	BuildRoadClick_Bridge,

   387

	BuildRoadClick_Tunnel,

   388

	BuildRoadClick_Remove

   389

};

   390

   391

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

   392

static const uint16 _road_keycodes[] = {

   393

	'1',

   394

	'2',

   395

	'3',

   396

	'4',

   397

	'5',

   398

	'6',

   399

	'7',

   400

	'8',

   401

	'B',

   402

	'T',

   403

	'R',

   404

};

   405

   406

/**

   407

 * Update the remove button lowered state of the road toolbar

   408

 *

   409

 * @param w The toolbar window

   410

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

   411

 */

   412

static void UpdateOptionWidgetStatus(Window *w, RoadToolbarWidgets clicked_widget)

   413

{

   414

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

   415

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

   416

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

   417

	switch (clicked_widget) {

   418

		case RTW_REMOVE:

   419

			w->RaiseWidget(RTW_ONE_WAY);

   420

			w->InvalidateWidget(RTW_ONE_WAY);

   421

			break;

   422

   423

		case RTW_ONE_WAY:

   424

			w->RaiseWidget(RTW_REMOVE);

   425

			w->InvalidateWidget(RTW_REMOVE);

   426

			break;

   427

   428

		case RTW_BUS_STATION:

   429

		case RTW_TRUCK_STATION:

   430

			w->DisableWidget(RTW_ONE_WAY);

   431

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

   432

			break;

   433

   434

		case RTW_ROAD_X:

   435

		case RTW_ROAD_Y:

   436

		case RTW_AUTOROAD:

   437

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

   438

				RTW_REMOVE,

   439

				RTW_ONE_WAY,

   440

				WIDGET_LIST_END);

   441

			break;

   442

   443

		default:

   444

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

   445

			 * disable the removal button */

   446

			w->SetWidgetsDisabledState(true,

   447

				RTW_REMOVE,

   448

				RTW_ONE_WAY,

   449

				WIDGET_LIST_END);

   450

			w->SetWidgetsLoweredState (false,

   451

				RTW_REMOVE,

   452

				RTW_ONE_WAY,

   453

				WIDGET_LIST_END);

   454

			break;

   455

	}

   456

}

   457

   458

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

   459

{

   460

	switch (e->event) {

   461

		case WE_CREATE:

   462

			w->SetWidgetsDisabledState(true,

   463

				RTW_REMOVE,

   464

				RTW_ONE_WAY,

   465

				WIDGET_LIST_END);

   466

			break;

   467

   468

		case WE_PAINT:

   469

			w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   470

				RTW_DEPOT,

   471

				RTW_BUS_STATION,

   472

				RTW_TRUCK_STATION,

   473

				WIDGET_LIST_END);

   474

			DrawWindowWidgets(w);

   475

			break;

   476

   477

		case WE_CLICK:

   478

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

   479

				_remove_button_clicked = false;

   480

				_one_way_button_clicked = false;

   481

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

   482

			}

   483

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

   484

			if (_ctrl_pressed) RoadToolbar_CtrlChanged(w);

   485

			break;

   486

   487

		case WE_KEYPRESS:

   488

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

   489