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

    16

#include "viewport.h"

    17

#include "gfx.h"

    18

#include "sound.h"

    19

#include "command.h"

    20

#include "variables.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

static bool _one_way_button_clicked;

    33

    34

/**

    35

 * Define the values of the RoadFlags

    36

 * @see CmdBuildLongRoad

    37

 */

    38

enum RoadFlags {

    39

	RF_NONE             = 0x00,

    40

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

    41

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

    42

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

    43

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

    44

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

    45

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

    46

};

    47

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    48

    49

static RoadFlags _place_road_flag;

    50

    51

static RoadType _cur_roadtype;

    52

    53

static DiagDirection _road_depot_orientation;

    54

static DiagDirection _road_station_picker_orientation;

    55

    56

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

    57

{

    58

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    59

}

    60

    61

/**

    62

 * Set the initial flags for the road constuction.

    63

 * The flags are:

    64

 * @li The direction is the X-dir

    65

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

    66

 *

    67

 * @param tile The start tile

    68

 */

    69

static void PlaceRoad_X_Dir(TileIndex tile)

    70

{

    71

	_place_road_flag = RF_DIR_X;

    72

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

    73

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_X_DIR);

    74

}

    75

    76

/**

    77

 * Set the initial flags for the road constuction.

    78

 * The flags are:

    79

 * @li The direction is the Y-dir

    80

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

    81

 *

    82

 * @param tile The start tile

    83

 */

    84

static void PlaceRoad_Y_Dir(TileIndex tile)

    85

{

    86

	_place_road_flag = RF_DIR_Y;

    87

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

    88

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_Y_DIR);

    89

}

    90

    91

/**

    92

 * Set the initial flags for the road constuction.

    93

 * The flags are:

    94

 * @li The direction is not set.

    95

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

    96

 *

    97

 * @param tile The start tile

    98

 */

    99

static void PlaceRoad_AutoRoad(TileIndex tile)

   100

{

   101

	_place_road_flag = RF_NONE;

   102

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

   103

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

   104

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   105

}

   106

   107

static void PlaceRoad_Bridge(TileIndex tile)

   108

{

   109

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   110

}

   111

   112

   113

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

   114

{

   115

	if (success) {

   116

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   117

		ResetObjectToPlace();

   118

	} else {

   119

		SetRedErrorSquare(_build_tunnel_endtile);

   120

	}

   121

}

   122

   123

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

   124

struct RoadTypeInfo {

   125

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

   126

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

   127

	StringID err_depot;             ///< Building a depot

   128

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

   129

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

   130

   131

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

   132

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

   133

   134

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

   135

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

   136

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   137

};

   138

   139

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

   140

static const RoadTypeInfo _road_type_infos[] = {

   141

	{

   142

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   143

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   144

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   145

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   146

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   147

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   148

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   149

   150

		SPR_CURSOR_ROAD_NESW,

   151

		SPR_CURSOR_ROAD_NWSE,

   152

		SPR_CURSOR_AUTOROAD,

   153

	},

   154

	{

   155

		STR_1804_CAN_T_BUILD_TRAMWAY_HERE,

   156

		STR_1805_CAN_T_REMOVE_TRAMWAY_FROM,

   157

		STR_1807_CAN_T_BUILD_TRAM_VEHICLE,

   158

		{ STR_1808_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_1809_CAN_T_BUILD_CARGO_TRAM_STATION        },

   159

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,            STR_CAN_T_REMOVE_CARGO_TRAM_STATION            },

   160

		{ STR_3042_PASSENGER_TRAM_STATION_ORIENTATION,        STR_3043_CARGO_TRAM_STATION_ORIENT             },

   161

		{ STR_3051_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_3052_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   162

   163

		SPR_CURSOR_TRAMWAY_NESW,

   164

		SPR_CURSOR_TRAMWAY_NWSE,

   165

		SPR_CURSOR_AUTOTRAM,

   166

	},

   167

};

   168

   169

static void PlaceRoad_Tunnel(TileIndex tile)

   170

{

   171

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

   172

}

   173

   174

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   175

{

   176

	tile += TileOffsByDiagDir(direction);

   177

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

   178

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

   179

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

   180

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

   181

		}

   182

	}

   183

}

   184

   185

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

   186

{

   187

	if (success) {

   188

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

   189

		SndPlayTileFx(SND_1F_SPLAT, tile);

   190

		ResetObjectToPlace();

   191

		BuildRoadOutsideStation(tile, dir);

   192

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

   193

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

   194

	}

   195

}

   196

   197

static void PlaceRoad_Depot(TileIndex tile)

   198

{

   199

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

   200

}

   201

   202

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

   203

{

   204

	uint32 p1 = _road_station_picker_orientation;

   205

   206

	if (p1 >= DIAGDIR_END) {

   207

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

   208

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

   209

	}

   210

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

   211

}

   212

   213

static void PlaceRoad_BusStation(TileIndex tile)

   214

{

   215

	if (_remove_button_clicked) {

   216

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

   217

	} else {

   218

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

   219

	}

   220

}

   221

   222

static void PlaceRoad_TruckStation(TileIndex tile)

   223

{

   224

	if (_remove_button_clicked) {

   225

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

   226

	} else {

   227

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

   228

	}

   229

}

   230

   231

static void PlaceRoad_DemolishArea(TileIndex tile)

   232

{

   233

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_DEMOLISH_AREA);

   234

}

   235

   236

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

   237

enum RoadToolbarWidgets {

   238

	RTW_CLOSEBOX = 0,

   239

	RTW_CAPTION,

   240

	RTW_STICKY,

   241

	RTW_ROAD_X,

   242

	RTW_ROAD_Y,

   243

	RTW_AUTOROAD,

   244

	RTW_DEMOLISH,

   245

	RTW_DEPOT,

   246

	RTW_BUS_STATION,

   247

	RTW_TRUCK_STATION,

   248

	RTW_ONE_WAY,

   249

	RTW_BUILD_BRIDGE,

   250

	RTW_BUILD_TUNNEL,

   251

	RTW_REMOVE,

   252

};

   253

   254

typedef void OnButtonClick(Window *w);

   255

   256

/**

   257

 * Function that handles the click on the

   258

 *  X road placement button.

   259

 *

   260

 * @param w The current window

   261

 */

   262

static void BuildRoadClick_X_Dir(Window *w)

   263

{

   264

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

   265

}

   266

   267

/**

   268

 * Function that handles the click on the

   269

 *  Y road placement button.

   270

 *

   271

 * @param w The current window

   272

 */

   273

static void BuildRoadClick_Y_Dir(Window *w)

   274

{

   275

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

   276

}

   277

   278

/**

   279

 * Function that handles the click on the

   280

 *  autoroad placement button.

   281

 *

   282

 * @param w The current window

   283

 */

   284

static void BuildRoadClick_AutoRoad(Window *w)

   285

{

   286

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

   287

}

   288

   289

static void BuildRoadClick_Demolish(Window *w)

   290

{

   291

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

   292

}

   293

   294

static void BuildRoadClick_Depot(Window *w)

   295

{

   296

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

   297

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

   298

}

   299

   300

static void BuildRoadClick_BusStation(Window *w)

   301

{

   302

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

   303

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

   304

}

   305

   306

static void BuildRoadClick_TruckStation(Window *w)

   307

{

   308

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

   309

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

   310

}

   311

   312

/**

   313

 * Function that handles the click on the

   314

 *  one way road button.

   315

 *

   316

 * @param w The current window

   317

 */

   318

static void BuildRoadClick_OneWay(Window *w)

   319

{

   320

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

   321

	SetWindowDirty(w);

   322

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   323

	SetSelectionRed(false);

   324

}

   325

   326

static void BuildRoadClick_Bridge(Window *w)

   327

{

   328

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

   329

}

   330

   331

static void BuildRoadClick_Tunnel(Window *w)

   332

{

   333

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

   334

}

   335

   336

static void BuildRoadClick_Remove(Window *w)

   337

{

   338

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

   339

	SetWindowDirty(w);

   340

	SndPlayFx(SND_15_BEEP);

   341

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   342

	SetSelectionRed(w->IsWidgetLowered(RTW_REMOVE));

   343

}

   344

   345

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

   346

static OnButtonClick* const _build_road_button_proc[] = {

   347

	BuildRoadClick_X_Dir,

   348

	BuildRoadClick_Y_Dir,

   349

	BuildRoadClick_AutoRoad,

   350

	BuildRoadClick_Demolish,

   351

	BuildRoadClick_Depot,

   352

	BuildRoadClick_BusStation,

   353

	BuildRoadClick_TruckStation,

   354

	BuildRoadClick_OneWay,

   355

	BuildRoadClick_Bridge,

   356

	BuildRoadClick_Tunnel,

   357

	BuildRoadClick_Remove

   358

};

   359

   360

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

   361

static const uint16 _road_keycodes[] = {

   362

	'1',

   363

	'2',

   364

	'3',

   365

	'4',

   366

	'5',

   367

	'6',

   368

	'7',

   369

	'8',

   370

	'B',

   371

	'T',

   372

	'R',

   373

};

   374

   375

/**

   376

 * Update the remove button lowered state of the road toolbar

   377

 *

   378

 * @param w The toolbar window

   379

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

   380

 */

   381

static void UpdateOptionWidgetStatus(Window *w, int clicked_widget)

   382

{

   383

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

   384

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

   385

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

   386

	switch (clicked_widget) {

   387

		case RTW_REMOVE:

   388

			w->RaiseWidget(RTW_ONE_WAY);

   389

			break;

   390

		case RTW_ONE_WAY:

   391

			w->RaiseWidget(RTW_REMOVE);

   392

			break;

   393

		case RTW_BUS_STATION:

   394

		case RTW_TRUCK_STATION:

   395

			w->DisableWidget(RTW_ONE_WAY);

   396

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

   397

			break;

   398

		case RTW_ROAD_X:

   399

		case RTW_ROAD_Y:

   400

		case RTW_AUTOROAD:

   401

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

   402

				RTW_REMOVE,

   403

				RTW_ONE_WAY,

   404

				WIDGET_LIST_END);

   405

			break;

   406

		default:

   407

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

   408

			 * disable the removal button */

   409

			w->SetWidgetsDisabledState(true,

   410

				RTW_REMOVE,

   411

				RTW_ONE_WAY,

   412

				WIDGET_LIST_END);

   413

			w->SetWidgetsLoweredState (false,

   414

				RTW_REMOVE,

   415

				RTW_ONE_WAY,

   416

				WIDGET_LIST_END);

   417

			break;

   418

	}

   419

}

   420

   421

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

   422

{

   423

	switch (e->event) {

   424

	case WE_CREATE:

   425

		w->SetWidgetsDisabledState(true,

   426

			RTW_REMOVE,

   427

			RTW_ONE_WAY,

   428

			WIDGET_LIST_END);

   429

		break;

   430

   431

	case WE_PAINT:

   432

		w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   433

			RTW_DEPOT,

   434

			RTW_BUS_STATION,

   435

			RTW_TRUCK_STATION,

   436

			WIDGET_LIST_END);

   437

		DrawWindowWidgets(w);

   438

		break;

   439

   440

	case WE_CLICK:

   441

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

   442

			_remove_button_clicked = false;

   443

			_one_way_button_clicked = false;

   444

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

   445

		}

   446

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

   447

		break;

   448

   449

	case WE_KEYPRESS:

   450

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

   451

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

   452

				e->we.keypress.cont = false;

   453

				_remove_button_clicked = false;

   454

				_one_way_button_clicked = false;

   455

				_build_road_button_proc[i](w);

   456

				UpdateOptionWidgetStatus(w, i + RTW_ROAD_X);

   457

				break;

   458

			}

   459

		}

   460

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

   461

		break;

   462

   463

	case WE_PLACE_OBJ:

   464

		_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   465

		_one_way_button_clicked = w->IsWidgetLowered(RTW_ONE_WAY);

   466

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

   467

		break;

   468

   469

	case WE_ABORT_PLACE_OBJ:

   470

		w->RaiseButtons();

   471

		w->SetWidgetsDisabledState(true,

   472

			RTW_REMOVE,

   473

			RTW_ONE_WAY,

   474

			WIDGET_LIST_END);

   475

		w->InvalidateWidget(RTW_REMOVE);

   476

		w->InvalidateWidget(RTW_ONE_WAY);

   477

   478

		w = FindWindowById(WC_BUS_STATION, 0);

   479

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

   480

		w = FindWindowById(WC_TRUCK_STATION, 0);

   481

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

   482

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   483

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

   484

		break;

   485

   486

	case WE_PLACE_DRAG:

   487

		/* Here we update the end tile flags

   488

		 * of the road placement actions.

   489

		 * At first we reset the end halfroad