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 "station.h"

    20

#include "functions.h"

    21

#include "window_func.h"

    22

#include "vehicle_func.h"

    23

#include "sound_func.h"

    24

#include "player_func.h"

    25

#include "settings_type.h"

    26

    27

#include "table/sprites.h"

    28

#include "table/strings.h"

    29

    30

static void ShowRVStationPicker(RoadStop::Type 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

   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

 * Function that handles the click on the

   260

 *  X road placement button.

   261

 *

   262

 * @param w The current window

   263

 */

   264

static void BuildRoadClick_X_Dir(Window *w)

   265

{

   266

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

   267

}

   268

   269

/**

   270

 * Function that handles the click on the

   271

 *  Y road placement button.

   272

 *

   273

 * @param w The current window

   274

 */

   275

static void BuildRoadClick_Y_Dir(Window *w)

   276

{

   277

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

   278

}

   279

   280

/**

   281

 * Function that handles the click on the

   282

 *  autoroad placement button.

   283

 *

   284

 * @param w The current window

   285

 */

   286

static void BuildRoadClick_AutoRoad(Window *w)

   287

{

   288

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

   289

}

   290

   291

static void BuildRoadClick_Demolish(Window *w)

   292

{

   293

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

   294

}

   295

   296

static void BuildRoadClick_Depot(Window *w)

   297

{

   298

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

   299

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

   300

}

   301

   302

static void BuildRoadClick_BusStation(Window *w)

   303

{

   304

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

   305

	if (HandlePlacePushButton(w, RTW_BUS_STATION, SPR_CURSOR_BUS_STATION, VHM_RECT, PlaceRoad_BusStation)) ShowRVStationPicker(RoadStop::BUS);

   306

}

   307

   308

static void BuildRoadClick_TruckStation(Window *w)

   309

{

   310

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

   311

	if (HandlePlacePushButton(w, RTW_TRUCK_STATION, SPR_CURSOR_TRUCK_STATION, VHM_RECT, PlaceRoad_TruckStation)) ShowRVStationPicker(RoadStop::TRUCK);

   312

}

   313

   314

/**

   315

 * Function that handles the click on the

   316

 *  one way road button.

   317

 *

   318

 * @param w The current window

   319

 */

   320

static void BuildRoadClick_OneWay(Window *w)

   321

{

   322

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

   323

	SetWindowDirty(w);

   324

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   325

	SetSelectionRed(false);

   326

}

   327

   328

static void BuildRoadClick_Bridge(Window *w)

   329

{

   330

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

   331

}

   332

   333

static void BuildRoadClick_Tunnel(Window *w)

   334

{

   335

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

   336

}

   337

   338

static void BuildRoadClick_Remove(Window *w)

   339

{

   340

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

   341

	SetWindowDirty(w);

   342

	SndPlayFx(SND_15_BEEP);

   343

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   344

	SetSelectionRed(w->IsWidgetLowered(RTW_REMOVE));

   345

}

   346

   347

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

   348

static OnButtonClick* const _build_road_button_proc[] = {

   349

	BuildRoadClick_X_Dir,

   350

	BuildRoadClick_Y_Dir,

   351

	BuildRoadClick_AutoRoad,

   352

	BuildRoadClick_Demolish,

   353

	BuildRoadClick_Depot,

   354

	BuildRoadClick_BusStation,

   355

	BuildRoadClick_TruckStation,

   356

	BuildRoadClick_OneWay,

   357

	BuildRoadClick_Bridge,

   358

	BuildRoadClick_Tunnel,

   359

	BuildRoadClick_Remove

   360

};

   361

   362

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

   363

static const uint16 _road_keycodes[] = {

   364

	'1',

   365

	'2',

   366

	'3',

   367

	'4',

   368

	'5',

   369

	'6',

   370

	'7',

   371

	'8',

   372

	'B',

   373

	'T',

   374

	'R',

   375

};

   376

   377

/**

   378

 * Update the remove button lowered state of the road toolbar

   379

 *

   380

 * @param w The toolbar window

   381

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

   382

 */

   383

static void UpdateOptionWidgetStatus(Window *w, int clicked_widget)

   384

{

   385

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

   386

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

   387

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

   388

	switch (clicked_widget) {

   389

		case RTW_REMOVE:

   390

			w->RaiseWidget(RTW_ONE_WAY);

   391

			break;

   392

		case RTW_ONE_WAY:

   393

			w->RaiseWidget(RTW_REMOVE);

   394

			break;

   395

		case RTW_BUS_STATION:

   396

		case RTW_TRUCK_STATION:

   397

			w->DisableWidget(RTW_ONE_WAY);

   398

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

   399

			break;

   400

		case RTW_ROAD_X:

   401

		case RTW_ROAD_Y:

   402

		case RTW_AUTOROAD:

   403

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

   404

				RTW_REMOVE,

   405

				RTW_ONE_WAY,

   406

				WIDGET_LIST_END);

   407

			break;

   408

		default:

   409

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

   410

			 * disable the removal button */

   411

			w->SetWidgetsDisabledState(true,

   412

				RTW_REMOVE,

   413

				RTW_ONE_WAY,

   414

				WIDGET_LIST_END);

   415

			w->SetWidgetsLoweredState (false,

   416

				RTW_REMOVE,

   417

				RTW_ONE_WAY,

   418

				WIDGET_LIST_END);

   419

			break;

   420

	}

   421

}

   422

   423

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

   424

{

   425

	switch (e->event) {

   426

	case WE_CREATE:

   427

		w->SetWidgetsDisabledState(true,

   428

			RTW_REMOVE,

   429

			RTW_ONE_WAY,

   430

			WIDGET_LIST_END);

   431

		break;

   432

   433

	case WE_PAINT:

   434

		w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   435

			RTW_DEPOT,

   436

			RTW_BUS_STATION,

   437

			RTW_TRUCK_STATION,

   438

			WIDGET_LIST_END);

   439

		DrawWindowWidgets(w);

   440

		break;

   441

   442

	case WE_CLICK:

   443

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

   444

			_remove_button_clicked = false;

   445

			_one_way_button_clicked = false;

   446

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

   447

		}

   448

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

   449

		break;

   450

   451

	case WE_KEYPRESS:

   452

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

   453

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

   454

				e->we.keypress.cont = false;

   455

				_remove_button_clicked = false;

   456

				_one_way_button_clicked = false;

   457

				_build_road_button_proc[i](w);

   458

				UpdateOptionWidgetStatus(w, i + RTW_ROAD_X);

   459

				break;

   460

			}

   461

		}

   462

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

   463

		break;

   464

   465

	case WE_PLACE_OBJ:

   466

		_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   467

		_one_way_button_clicked = w->IsWidgetLowered(RTW_ONE_WAY);

   468

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

   469

		break;

   470

   471

	case WE_ABORT_PLACE_OBJ:

   472

		w->RaiseButtons();

   473

		w->SetWidgetsDisabledState(true,

   474

			RTW_REMOVE,

   475

			RTW_ONE_WAY,

   476

			WIDGET_LIST_END);

   477

		w->InvalidateWidget(RTW_REMOVE);

   478

		w->InvalidateWidget(RTW_ONE_WAY);

   479

   480

		w = FindWindowById(WC_BUS_STATION, 0);

   481

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

   482

		w = FindWindowById(WC_TRUCK_STATION, 0);

   483

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

   484

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   485

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

   486

		break;

   487

   488

	case WE_PLACE_DRAG:

   489

		/* Here we update the end tile flags