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

    14

#include "gui.h"

    15

#include "viewport.h"

    16

#include "gfx.h"

    17

#include "sound.h"

    18

#include "command.h"

    19

#include "variables.h"

    20

#include "road_cmd.h"

    21

#include "road_map.h"

    22

#include "station_map.h"

    23

//needed for catchments

    24

#include "station.h"

    25

    26

    27

static void ShowRVStationPicker(RoadStop::Type rs);

    28

static void ShowRoadDepotPicker();

    29

    30

static bool _remove_button_clicked;

    31

static bool _one_way_button_clicked;

    32

    33

/**

    34

 * Define the values of the RoadFlags

    35

 * @see CmdBuildLongRoad

    36

 */

    37

enum RoadFlags {

    38

	RF_NONE             = 0x00,

    39

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

    40

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

    41

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

    42

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

    43

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

    44

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

    45

};

    46

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    47

    48

static RoadFlags _place_road_flag;

    49

    50

static RoadType _cur_roadtype;

    51

    52

static DiagDirection _road_depot_orientation;

    53

static DiagDirection _road_station_picker_orientation;

    54

    55

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

    56

{

    57

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    58

}

    59

    60

/**

    61

 * Set the initial flags for the road constuction.

    62

 * The flags are:

    63

 * @li The direction is the X-dir

    64

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

    65

 *

    66

 * @param tile The start tile

    67

 */

    68

static void PlaceRoad_X_Dir(TileIndex tile)

    69

{

    70

	_place_road_flag = RF_DIR_X;

    71

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

    72

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_X_DIR);

    73

}

    74

    75

/**

    76

 * Set the initial flags for the road constuction.

    77

 * The flags are:

    78

 * @li The direction is the Y-dir

    79

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

    80

 *

    81

 * @param tile The start tile

    82

 */

    83

static void PlaceRoad_Y_Dir(TileIndex tile)

    84

{

    85

	_place_road_flag = RF_DIR_Y;

    86

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

    87

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_Y_DIR);

    88

}

    89

    90

/**

    91

 * Set the initial flags for the road constuction.

    92

 * The flags are:

    93

 * @li The direction is not set.

    94

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

    95

 *

    96

 * @param tile The start tile

    97

 */

    98

static void PlaceRoad_AutoRoad(TileIndex tile)

    99

{

   100

	_place_road_flag = RF_NONE;

   101

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

   102

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

   103

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   104

}

   105

   106

static void PlaceRoad_Bridge(TileIndex tile)

   107

{

   108

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   109

}

   110

   111

   112

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

   113

{

   114

	if (success) {

   115

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   116

		ResetObjectToPlace();

   117

	} else {

   118

		SetRedErrorSquare(_build_tunnel_endtile);

   119

	}

   120

}

   121

   122

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

   123

struct RoadTypeInfo {

   124

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

   125

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

   126

	StringID err_depot;             ///< Building a depot

   127

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

   128

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

   129

   130

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

   131

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

   132

   133

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

   134

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

   135

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   136

};

   137

   138

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

   139

static const RoadTypeInfo _road_type_infos[] = {

   140

	{

   141

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   142

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   143

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   144

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   145

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   146

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   147

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   148

   149

		SPR_CURSOR_ROAD_NESW,

   150

		SPR_CURSOR_ROAD_NWSE,

   151

		SPR_CURSOR_AUTOROAD,

   152

	},

   153

	{

   154

		STR_1804_CAN_T_BUILD_TRAMWAY_HERE,

   155

		STR_1805_CAN_T_REMOVE_TRAMWAY_FROM,

   156

		STR_1807_CAN_T_BUILD_TRAM_VEHICLE,

   157

		{ STR_1808_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_1809_CAN_T_BUILD_CARGO_TRAM_STATION        },

   158

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,            STR_CAN_T_REMOVE_CARGO_TRAM_STATION            },

   159

		{ STR_3042_PASSENGER_TRAM_STATION_ORIENTATION,        STR_3043_CARGO_TRAM_STATION_ORIENT             },

   160

		{ STR_3051_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_3052_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   161

   162

		SPR_CURSOR_TRAMWAY_NESW,

   163

		SPR_CURSOR_TRAMWAY_NWSE,

   164

		SPR_CURSOR_AUTOTRAM,

   165

	},

   166

};

   167

   168

static void PlaceRoad_Tunnel(TileIndex tile)

   169

{

   170

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

   171

}

   172

   173

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   174

{

   175

	tile += TileOffsByDiagDir(direction);

   176

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

   177

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

   178

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

   179

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

   180

		}

   181

	}

   182

}

   183

   184

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

   185

{

   186

	if (success) {

   187

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

   188

		SndPlayTileFx(SND_1F_SPLAT, tile);

   189

		ResetObjectToPlace();

   190

		BuildRoadOutsideStation(tile, dir);

   191

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

   192

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

   193

	}

   194

}

   195

   196

static void PlaceRoad_Depot(TileIndex tile)

   197

{

   198

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

   199

}

   200

   201

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

   202

{

   203

	uint32 p1 = _road_station_picker_orientation;

   204

   205

	if (p1 >= DIAGDIR_END) {

   206

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

   207

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

   208

	}

   209

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

   210

}

   211

   212

static void PlaceRoad_BusStation(TileIndex tile)

   213

{

   214

	if (_remove_button_clicked) {

   215

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

   216

	} else {

   217

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

   218

	}

   219

}

   220

   221

static void PlaceRoad_TruckStation(TileIndex tile)

   222

{

   223

	if (_remove_button_clicked) {

   224

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

   225

	} else {

   226

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

   227

	}

   228

}

   229

   230

static void PlaceRoad_DemolishArea(TileIndex tile)

   231

{

   232

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_DEMOLISH_AREA);

   233

}

   234

   235

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

   236

enum RoadToolbarWidgets {

   237

	RTW_CLOSEBOX = 0,

   238

	RTW_CAPTION,

   239

	RTW_STICKY,

   240

	RTW_ROAD_X,

   241

	RTW_ROAD_Y,

   242

	RTW_AUTOROAD,

   243

	RTW_DEMOLISH,

   244

	RTW_DEPOT,

   245

	RTW_BUS_STATION,

   246

	RTW_TRUCK_STATION,

   247

	RTW_ONE_WAY,

   248

	RTW_BUILD_BRIDGE,

   249

	RTW_BUILD_TUNNEL,

   250

	RTW_REMOVE,

   251

};

   252

   253

typedef void OnButtonClick(Window *w);

   254

   255

/**

   256

 * Function that handles the click on the

   257

 *  X road placement button.

   258

 *

   259

 * @param w The current window

   260

 */

   261

static void BuildRoadClick_X_Dir(Window *w)

   262

{

   263

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

   264

}

   265

   266

/**

   267

 * Function that handles the click on the

   268

 *  Y road placement button.

   269

 *

   270

 * @param w The current window

   271

 */

   272

static void BuildRoadClick_Y_Dir(Window *w)

   273

{

   274

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

   275

}

   276

   277

/**

   278

 * Function that handles the click on the

   279

 *  autoroad placement button.

   280

 *

   281

 * @param w The current window

   282

 */

   283

static void BuildRoadClick_AutoRoad(Window *w)

   284

{

   285

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

   286

}

   287

   288

static void BuildRoadClick_Demolish(Window *w)

   289

{

   290

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

   291

}

   292

   293

static void BuildRoadClick_Depot(Window *w)

   294

{

   295

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

   296

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

   297

}

   298

   299

static void BuildRoadClick_BusStation(Window *w)

   300

{

   301

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

   302

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

   303

}

   304

   305

static void BuildRoadClick_TruckStation(Window *w)

   306

{

   307

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

   308

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

   309

}

   310

   311

/**

   312

 * Function that handles the click on the

   313

 *  one way road button.

   314

 *

   315

 * @param w The current window

   316

 */

   317

static void BuildRoadClick_OneWay(Window *w)

   318

{

   319

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

   320

	SetWindowDirty(w);

   321

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   322

	SetSelectionRed(false);

   323

}

   324

   325

static void BuildRoadClick_Bridge(Window *w)

   326

{

   327

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

   328

}

   329

   330

static void BuildRoadClick_Tunnel(Window *w)

   331

{

   332

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

   333

}

   334

   335

static void BuildRoadClick_Remove(Window *w)

   336

{

   337

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

   338

	SetWindowDirty(w);

   339

	SndPlayFx(SND_15_BEEP);

   340

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   341

	SetSelectionRed(w->IsWidgetLowered(RTW_REMOVE));

   342

}

   343

   344

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

   345

static OnButtonClick* const _build_road_button_proc[] = {

   346

	BuildRoadClick_X_Dir,

   347

	BuildRoadClick_Y_Dir,

   348

	BuildRoadClick_AutoRoad,

   349

	BuildRoadClick_Demolish,

   350

	BuildRoadClick_Depot,

   351

	BuildRoadClick_BusStation,

   352

	BuildRoadClick_TruckStation,

   353

	BuildRoadClick_OneWay,

   354

	BuildRoadClick_Bridge,

   355

	BuildRoadClick_Tunnel,

   356

	BuildRoadClick_Remove

   357

};

   358

   359

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

   360

static const uint16 _road_keycodes[] = {

   361

	'1',

   362

	'2',

   363

	'3',

   364

	'4',

   365

	'5',

   366

	'6',

   367

	'7',

   368

	'8',

   369

	'B',

   370

	'T',

   371

	'R',

   372

};

   373

   374

/**

   375

 * Update the remove button lowered state of the road toolbar

   376

 *

   377

 * @param w The toolbar window

   378

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

   379

 */

   380

static void UpdateOptionWidgetStatus(Window *w, int clicked_widget)

   381

{

   382

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

   383

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

   384

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

   385

	switch (clicked_widget) {

   386

		case RTW_REMOVE:

   387

			w->RaiseWidget(RTW_ONE_WAY);

   388

			break;

   389

		case RTW_ONE_WAY:

   390

			w->RaiseWidget(RTW_REMOVE);

   391

			break;

   392

		case RTW_BUS_STATION:

   393

		case RTW_TRUCK_STATION:

   394

			w->DisableWidget(RTW_ONE_WAY);

   395

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

   396

			break;

   397

		case RTW_ROAD_X:

   398

		case RTW_ROAD_Y:

   399

		case RTW_AUTOROAD:

   400

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

   401

				RTW_REMOVE,

   402

				RTW_ONE_WAY,

   403

				WIDGET_LIST_END);

   404

			break;

   405

		default:

   406

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

   407

			 * disable the removal button */

   408

			w->SetWidgetsDisabledState(true,

   409

				RTW_REMOVE,

   410

				RTW_ONE_WAY,

   411

				WIDGET_LIST_END);

   412

			w->SetWidgetsLoweredState (false,

   413

				RTW_REMOVE,

   414

				RTW_ONE_WAY,

   415

				WIDGET_LIST_END);

   416

			break;

   417

	}

   418

}

   419

   420

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

   421

{

   422

	switch (e->event) {

   423

	case WE_CREATE:

   424

		w->SetWidgetsDisabledState(true,

   425

			RTW_REMOVE,

   426

			RTW_ONE_WAY,

   427

			WIDGET_LIST_END);

   428

		break;

   429

   430

	case WE_PAINT:

   431

		w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   432

			RTW_DEPOT,

   433

			RTW_BUS_STATION,

   434

			RTW_TRUCK_STATION,

   435

			WIDGET_LIST_END);

   436

		DrawWindowWidgets(w);

   437

		break;

   438

   439

	case WE_CLICK:

   440

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

   441

			_remove_button_clicked = false;

   442

			_one_way_button_clicked = false;

   443

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

   444

		}

   445

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

   446

		break;

   447

   448

	case WE_KEYPRESS:

   449

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

   450

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

   451

				e->we.keypress.cont = false;

   452

				_remove_button_clicked = false;

   453

				_one_way_button_clicked = false;

   454

				_build_road_button_proc[i](w);

   455

				UpdateOptionWidgetStatus(w, i + RTW_ROAD_X);

   456

				break;

   457

			}

   458

		}

   459

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

   460

		break;

   461

   462

	case WE_PLACE_OBJ:

   463

		_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   464

		_one_way_button_clicked = w->IsWidgetLowered(RTW_ONE_WAY);

   465

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

   466

		break;

   467

   468

	case WE_ABORT_PLACE_OBJ:

   469

		w->RaiseButtons();

   470

		w->SetWidgetsDisabledState(true,

   471

			RTW_REMOVE,

   472

			RTW_ONE_WAY,

   473

			WIDGET_LIST_END);

   474

		w->InvalidateWidget(RTW_REMOVE);

   475

		w->InvalidateWidget(RTW_ONE_WAY);

   476

   477

		w = FindWindowById(WC_BUS_STATION, 0);

   478

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

   479

		w = FindWindowById(WC_TRUCK_STATION, 0);

   480

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

   481

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   482

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

   483

		break;

   484

   485

	case WE_PLACE_DRAG:

   486

		/* Here we update the end tile flags

   487

		 * of the road placement actions.

   488

		 * At first we reset the end halfroad

   489

		 * bits and if needed we set them again. */