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

    10

#include "window_gui.h"

    11

#include "station_gui.h"

    12

#include "terraform_gui.h"

    13

#include "viewport_func.h"

    14

#include "gfx_func.h"

    15

#include "command_func.h"

    16

#include "variables.h"

    17

#include "road_type.h"

    18

#include "road_cmd.h"

    19

#include "road_map.h"

    20

#include "station_map.h"

    21

#include "station.h"

    22

#include "functions.h"

    23

#include "window_func.h"

    24

#include "vehicle_func.h"

    25

#include "sound_func.h"

    27

    28

    29

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

   157

		STR_1805_CAN_T_REMOVE_TRAMWAY_FROM,

   158

		STR_1807_CAN_T_BUILD_TRAM_VEHICLE,

   159

		{ STR_1808_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_1809_CAN_T_BUILD_CARGO_TRAM_STATION        },

   160

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,            STR_CAN_T_REMOVE_CARGO_TRAM_STATION            },

   161

		{ STR_3042_PASSENGER_TRAM_STATION_ORIENTATION,        STR_3043_CARGO_TRAM_STATION_ORIENT             },

   162

		{ STR_3051_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_3052_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 (IsTileType(tile, MP_ROAD) && GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   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

 * Function that handles the click on the

   259

 *  X road placement button.

   260

 *

   261

 * @param w The current window

   262

 */

   263

static void BuildRoadClick_X_Dir(Window *w)

   264

{

   265

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

   266

}

   267

   268

/**

   269

 * Function that handles the click on the

   270

 *  Y road placement button.

   271

 *

   272

 * @param w The current window

   273

 */

   274

static void BuildRoadClick_Y_Dir(Window *w)

   275

{

   276

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

   277

}

   278

   279

/**

   280

 * Function that handles the click on the

   281

 *  autoroad placement button.

   282

 *

   283

 * @param w The current window

   284

 */

   285

static void BuildRoadClick_AutoRoad(Window *w)

   286

{

   287

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

   288

}

   289

   290

static void BuildRoadClick_Demolish(Window *w)

   291

{

   292

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

   293

}

   294

   295

static void BuildRoadClick_Depot(Window *w)

   296

{

   297

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

   298

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

   299

}

   300

   301

static void BuildRoadClick_BusStation(Window *w)

   302

{

   303

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

   304

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

   305

}

   306

   307

static void BuildRoadClick_TruckStation(Window *w)

   308

{

   309

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

   310

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

   311

}

   312

   313

/**

   314

 * Function that handles the click on the

   315

 *  one way road button.

   316

 *

   317

 * @param w The current window

   318

 */

   319

static void BuildRoadClick_OneWay(Window *w)

   320

{

   321

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

   322

	SetWindowDirty(w);

   323

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   324

	SetSelectionRed(false);

   325

}

   326

   327

static void BuildRoadClick_Bridge(Window *w)

   328

{

   329

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

   330

}

   331

   332

static void BuildRoadClick_Tunnel(Window *w)

   333

{

   334

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

   335

}

   336

   337

static void BuildRoadClick_Remove(Window *w)

   338

{

   339

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

   340

	SetWindowDirty(w);

   341

	SndPlayFx(SND_15_BEEP);

   342

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   343

	SetSelectionRed(w->IsWidgetLowered(RTW_REMOVE));

   344

}

   345

   346

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

   347

static OnButtonClick* const _build_road_button_proc[] = {

   348

	BuildRoadClick_X_Dir,

   349

	BuildRoadClick_Y_Dir,

   350

	BuildRoadClick_AutoRoad,

   351

	BuildRoadClick_Demolish,

   352

	BuildRoadClick_Depot,

   353

	BuildRoadClick_BusStation,

   354

	BuildRoadClick_TruckStation,

   355

	BuildRoadClick_OneWay,

   356

	BuildRoadClick_Bridge,

   357

	BuildRoadClick_Tunnel,

   358

	BuildRoadClick_Remove

   359

};

   360

   361

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

   362

static const uint16 _road_keycodes[] = {

   363

	'1',

   364

	'2',

   365

	'3',

   366

	'4',

   367

	'5',

   368

	'6',

   369

	'7',

   370

	'8',

   371

	'B',

   372

	'T',

   373

	'R',

   374

};

   375

   376

/**

   377

 * Update the remove button lowered state of the road toolbar

   378

 *

   379

 * @param w The toolbar window

   380

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

   381

 */

   382

static void UpdateOptionWidgetStatus(Window *w, int clicked_widget)

   383

{

   384

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

   385

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

   386

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

   387

	switch (clicked_widget) {

   388

		case RTW_REMOVE:

   389

			w->RaiseWidget(RTW_ONE_WAY);

   390

			break;

   391

		case RTW_ONE_WAY:

   392

			w->RaiseWidget(RTW_REMOVE);

   393

			break;

   394

		case RTW_BUS_STATION:

   395

		case RTW_TRUCK_STATION:

   396

			w->DisableWidget(RTW_ONE_WAY);

   397

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

   398

			break;

   399

		case RTW_ROAD_X:

   400

		case RTW_ROAD_Y:

   401

		case RTW_AUTOROAD:

   402

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

   403

				RTW_REMOVE,

   404

				RTW_ONE_WAY,

   405

				WIDGET_LIST_END);

   406

			break;

   407

		default:

   408

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

   409

			 * disable the removal button */

   410

			w->SetWidgetsDisabledState(true,

   411

				RTW_REMOVE,

   412

				RTW_ONE_WAY,

   413

				WIDGET_LIST_END);

   414

			w->SetWidgetsLoweredState (false,

   415

				RTW_REMOVE,

   416

				RTW_ONE_WAY,

   417

				WIDGET_LIST_END);

   418

			break;

   419

	}

   420

}

   421

   422

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

   423

{

   424

	switch (e->event) {

   425

	case WE_CREATE:

   426

		w->SetWidgetsDisabledState(true,

   427

			RTW_REMOVE,

   428

			RTW_ONE_WAY,

   429

			WIDGET_LIST_END);

   430

		break;

   431

   432

	case WE_PAINT:

   433

		w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   434

			RTW_DEPOT,

   435

			RTW_BUS_STATION,

   436

			RTW_TRUCK_STATION,

   437

			WIDGET_LIST_END);

   438

		DrawWindowWidgets(w);

   439

		break;

   440

   441

	case WE_CLICK:

   442

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

   443

			_remove_button_clicked = false;

   444

			_one_way_button_clicked = false;

   445

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

   446

		}

   447

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

   448

		break;

   449

   450

	case WE_KEYPRESS:

   451

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

   452

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

   453

				e->we.keypress.cont = false;

   454

				_remove_button_clicked = false;

   455

				_one_way_button_clicked = false;

   456

				_build_road_button_proc[i](w);

   457

				UpdateOptionWidgetStatus(w, i + RTW_ROAD_X);

   458

				break;

   459

			}

   460

		}

   461

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

   462

		break;

   463

   464

	case WE_PLACE_OBJ:

   465

		_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   466

		_one_way_button_clicked = w->IsWidgetLowered(RTW_ONE_WAY);

   467

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

   468

		break;

   469

   470

	case WE_ABORT_PLACE_OBJ:

   471

		w->RaiseButtons();

   472

		w->SetWidgetsDisabledState(true,

   473

			RTW_REMOVE,

   474

			RTW_ONE_WAY,

   475

			WIDGET_LIST_END);

   476

		w->InvalidateWidget(RTW_REMOVE);

   477

		w->InvalidateWidget(RTW_ONE_WAY);

   478

   479

		w = FindWindowById(WC_BUS_STATION, 0);

   480

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

   481

		w = FindWindowById(WC_TRUCK_STATION, 0);

   482

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

   483

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   484

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

   485

		break;

   486

   487

	case WE_PLACE_DRAG:

   488

		/* Here we update the end tile flags

   489

		 * of the road placement actions.