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

    13

#include "sound.h"

    14

#include "command_func.h"

    15

#include "variables.h"

    16

#include "road_cmd.h"

    17

#include "road_map.h"

    18

#include "station_map.h"

    19

//needed for catchments

    20

#include "station.h"

    21

#include "functions.h"

    22

#include "window_func.h"

    24

    25

    26

static void ShowRVStationPicker(RoadStop::Type rs);

    27

static void ShowRoadDepotPicker();

    28

    29

static bool _remove_button_clicked;

    30

static bool _one_way_button_clicked;

    31

    32

/**

    33

 * Define the values of the RoadFlags

    34

 * @see CmdBuildLongRoad

    35

 */

    36

enum RoadFlags {

    37

	RF_NONE             = 0x00,

    38

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

    39

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

    40

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

    41

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

    42

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

    43

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

    44

};

    45

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    46

    47

static RoadFlags _place_road_flag;

    48

    49

static RoadType _cur_roadtype;

    50

    51

static DiagDirection _road_depot_orientation;

    52

static DiagDirection _road_station_picker_orientation;

    53

    54

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

    55

{

    56

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    57

}

    58

    59

/**

    60

 * Set the initial flags for the road constuction.

    61

 * The flags are:

    62

 * @li The direction is the X-dir

    63

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

    64

 *

    65

 * @param tile The start tile

    66

 */

    67

static void PlaceRoad_X_Dir(TileIndex tile)

    68

{

    69

	_place_road_flag = RF_DIR_X;

    70

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

    71

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_X_DIR);

    72

}

    73

    74

/**

    75

 * Set the initial flags for the road constuction.

    76

 * The flags are:

    77

 * @li The direction is the Y-dir

    78

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

    79

 *

    80

 * @param tile The start tile

    81

 */

    82

static void PlaceRoad_Y_Dir(TileIndex tile)

    83

{

    84

	_place_road_flag = RF_DIR_Y;

    85

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

    86

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_Y_DIR);

    87

}

    88

    89

/**

    90

 * Set the initial flags for the road constuction.

    91

 * The flags are:

    92

 * @li The direction is not set.

    93

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

    94

 *

    95

 * @param tile The start tile

    96

 */

    97

static void PlaceRoad_AutoRoad(TileIndex tile)

    98

{

    99

	_place_road_flag = RF_NONE;

   100

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

   101

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

   102

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   103

}

   104

   105

static void PlaceRoad_Bridge(TileIndex tile)

   106

{

   107

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   108

}

   109

   110

   111

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

   112

{

   113

	if (success) {

   114

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   115

		ResetObjectToPlace();

   116

	} else {

   117

		SetRedErrorSquare(_build_tunnel_endtile);

   118

	}

   119

}

   120

   121

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

   122

struct RoadTypeInfo {

   123

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

   124

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

   125

	StringID err_depot;             ///< Building a depot

   126

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

   127

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

   128

   129

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

   130

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

   131

   132

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

   133

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

   134

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   135

};

   136

   137

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

   138

static const RoadTypeInfo _road_type_infos[] = {

   139

	{

   140

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   141

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   142

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   143

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   144

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   145

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   146

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   147

   148

		SPR_CURSOR_ROAD_NESW,

   149

		SPR_CURSOR_ROAD_NWSE,

   150

		SPR_CURSOR_AUTOROAD,

   151

	},

   152

	{

   153

		STR_1804_CAN_T_BUILD_TRAMWAY_HERE,

   154

		STR_1805_CAN_T_REMOVE_TRAMWAY_FROM,

   155

		STR_1807_CAN_T_BUILD_TRAM_VEHICLE,

   156

		{ STR_1808_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_1809_CAN_T_BUILD_CARGO_TRAM_STATION        },

   157

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,            STR_CAN_T_REMOVE_CARGO_TRAM_STATION            },

   158

		{ STR_3042_PASSENGER_TRAM_STATION_ORIENTATION,        STR_3043_CARGO_TRAM_STATION_ORIENT             },

   159

		{ STR_3051_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_3052_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   160

   161

		SPR_CURSOR_TRAMWAY_NESW,

   162

		SPR_CURSOR_TRAMWAY_NWSE,

   163

		SPR_CURSOR_AUTOTRAM,

   164

	},

   165

};

   166

   167

static void PlaceRoad_Tunnel(TileIndex tile)

   168

{

   169

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

   170

}

   171

   172

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   173

{

   174

	tile += TileOffsByDiagDir(direction);

   175

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

   176

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

   177

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

   178

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

   179

		}

   180

	}

   181

}

   182

   183

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

   184

{

   185

	if (success) {

   186

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

   187

		SndPlayTileFx(SND_1F_SPLAT, tile);

   188

		ResetObjectToPlace();

   189

		BuildRoadOutsideStation(tile, dir);

   190

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

   191

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

   192

	}

   193

}

   194

   195

static void PlaceRoad_Depot(TileIndex tile)

   196

{

   197

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

   198

}

   199

   200

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

   201

{

   202

	uint32 p1 = _road_station_picker_orientation;

   203

   204

	if (p1 >= DIAGDIR_END) {

   205

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

   206

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

   207

	}

   208

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

   209

}

   210

   211

static void PlaceRoad_BusStation(TileIndex tile)

   212

{

   213

	if (_remove_button_clicked) {

   214

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

   215

	} else {

   216

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

   217

	}

   218

}

   219

   220

static void PlaceRoad_TruckStation(TileIndex tile)

   221

{

   222

	if (_remove_button_clicked) {

   223

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

   224

	} else {

   225

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

   226

	}

   227

}

   228

   229

static void PlaceRoad_DemolishArea(TileIndex tile)

   230

{

   231

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_DEMOLISH_AREA);

   232

}

   233

   234

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

   235

enum RoadToolbarWidgets {

   236

	RTW_CLOSEBOX = 0,

   237

	RTW_CAPTION,

   238

	RTW_STICKY,

   239

	RTW_ROAD_X,

   240

	RTW_ROAD_Y,

   241

	RTW_AUTOROAD,

   242

	RTW_DEMOLISH,

   243

	RTW_DEPOT,

   244

	RTW_BUS_STATION,

   245

	RTW_TRUCK_STATION,

   246

	RTW_ONE_WAY,

   247

	RTW_BUILD_BRIDGE,

   248

	RTW_BUILD_TUNNEL,

   249

	RTW_REMOVE,

   250

};

   251

   252

typedef void OnButtonClick(Window *w);

   253

   254

/**

   255

 * Function that handles the click on the

   256

 *  X road placement button.

   257

 *

   258

 * @param w The current window

   259

 */

   260

static void BuildRoadClick_X_Dir(Window *w)

   261

{

   262

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

   263

}

   264

   265

/**

   266

 * Function that handles the click on the

   267

 *  Y road placement button.

   268

 *

   269

 * @param w The current window

   270

 */

   271

static void BuildRoadClick_Y_Dir(Window *w)

   272

{

   273

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

   274

}

   275

   276

/**

   277

 * Function that handles the click on the

   278

 *  autoroad placement button.

   279

 *

   280

 * @param w The current window

   281

 */

   282

static void BuildRoadClick_AutoRoad(Window *w)

   283

{

   284

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

   285

}

   286

   287

static void BuildRoadClick_Demolish(Window *w)

   288

{

   289

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

   290

}

   291

   292

static void BuildRoadClick_Depot(Window *w)

   293

{

   294

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

   295

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

   296

}

   297

   298

static void BuildRoadClick_BusStation(Window *w)

   299

{

   300

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

   301

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

   302

}

   303

   304

static void BuildRoadClick_TruckStation(Window *w)

   305

{

   306

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

   307

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

   308

}

   309

   310

/**

   311

 * Function that handles the click on the

   312

 *  one way road button.

   313

 *

   314

 * @param w The current window

   315

 */

   316

static void BuildRoadClick_OneWay(Window *w)

   317

{

   318

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

   319

	SetWindowDirty(w);

   320

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   321

	SetSelectionRed(false);

   322

}

   323

   324

static void BuildRoadClick_Bridge(Window *w)

   325

{

   326

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

   327

}

   328

   329

static void BuildRoadClick_Tunnel(Window *w)

   330

{

   331

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

   332

}

   333

   334

static void BuildRoadClick_Remove(Window *w)

   335

{

   336

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

   337

	SetWindowDirty(w);

   338

	SndPlayFx(SND_15_BEEP);

   339

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   340

	SetSelectionRed(w->IsWidgetLowered(RTW_REMOVE));

   341

}

   342

   343

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

   344

static OnButtonClick* const _build_road_button_proc[] = {

   345

	BuildRoadClick_X_Dir,

   346

	BuildRoadClick_Y_Dir,

   347

	BuildRoadClick_AutoRoad,

   348

	BuildRoadClick_Demolish,

   349

	BuildRoadClick_Depot,

   350

	BuildRoadClick_BusStation,

   351

	BuildRoadClick_TruckStation,

   352

	BuildRoadClick_OneWay,

   353

	BuildRoadClick_Bridge,

   354

	BuildRoadClick_Tunnel,

   355

	BuildRoadClick_Remove

   356

};

   357

   358

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

   359

static const uint16 _road_keycodes[] = {

   360

	'1',

   361

	'2',

   362

	'3',

   363

	'4',

   364

	'5',

   365

	'6',

   366

	'7',

   367

	'8',

   368

	'B',

   369

	'T',

   370

	'R',

   371

};

   372

   373

/**

   374

 * Update the remove button lowered state of the road toolbar

   375

 *

   376

 * @param w The toolbar window

   377

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

   378

 */

   379

static void UpdateOptionWidgetStatus(Window *w, int clicked_widget)

   380

{

   381

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

   382

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

   383

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

   384

	switch (clicked_widget) {

   385

		case RTW_REMOVE:

   386

			w->RaiseWidget(RTW_ONE_WAY);

   387

			break;

   388

		case RTW_ONE_WAY:

   389

			w->RaiseWidget(RTW_REMOVE);

   390

			break;

   391

		case RTW_BUS_STATION:

   392

		case RTW_TRUCK_STATION:

   393

			w->DisableWidget(RTW_ONE_WAY);

   394

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

   395

			break;

   396

		case RTW_ROAD_X:

   397

		case RTW_ROAD_Y:

   398

		case RTW_AUTOROAD:

   399

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

   400

				RTW_REMOVE,

   401

				RTW_ONE_WAY,

   402

				WIDGET_LIST_END);

   403

			break;

   404

		default:

   405

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

   406

			 * disable the removal button */

   407

			w->SetWidgetsDisabledState(true,

   408

				RTW_REMOVE,

   409

				RTW_ONE_WAY,

   410

				WIDGET_LIST_END);

   411

			w->SetWidgetsLoweredState (false,

   412

				RTW_REMOVE,

   413

				RTW_ONE_WAY,

   414

				WIDGET_LIST_END);

   415

			break;

   416

	}

   417

}

   418

   419

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

   420

{

   421

	switch (e->event) {

   422

	case WE_CREATE:

   423

		w->SetWidgetsDisabledState(true,

   424

			RTW_REMOVE,

   425

			RTW_ONE_WAY,

   426

			WIDGET_LIST_END);

   427

		break;

   428

   429

	case WE_PAINT:

   430

		w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   431

			RTW_DEPOT,

   432

			RTW_BUS_STATION,

   433

			RTW_TRUCK_STATION,

   434

			WIDGET_LIST_END);

   435

		DrawWindowWidgets(w);

   436

		break;

   437

   438

	case WE_CLICK:

   439

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

   440

			_remove_button_clicked = false;

   441

			_one_way_button_clicked = false;

   442

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

   443

		}

   444

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

   445

		break;

   446

   447

	case WE_KEYPRESS:

   448

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

   449

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

   450

				e->we.keypress.cont = false;

   451

				_remove_button_clicked = false;

   452

				_one_way_button_clicked = false;

   453

				_build_road_button_proc[i](w);

   454

				UpdateOptionWidgetStatus(w, i + RTW_ROAD_X);

   455

				break;

   456

			}

   457

		}

   458

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

   459

		break;

   460

   461

	case WE_PLACE_OBJ:

   462

		_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   463

		_one_way_button_clicked = w->IsWidgetLowered(RTW_ONE_WAY);

   464

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

   465

		break;

   466

   467

	case WE_ABORT_PLACE_OBJ:

   468

		w->RaiseButtons();

   469

		w->SetWidgetsDisabledState(true,

   470

			RTW_REMOVE,

   471

			RTW_ONE_WAY,

   472

			WIDGET_LIST_END);

   473

		w->InvalidateWidget(RTW_REMOVE);

   474

		w->InvalidateWidget(RTW_ONE_WAY);

   475

   476

		w = FindWindowById(WC_BUS_STATION, 0);

   477

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

   478

		w = FindWindowById(WC_TRUCK_STATION, 0);

   479

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

   480

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   481

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

   482

		break;

   483

   484

	case WE_PLACE_DRAG:

   485

		/* Here we update the end tile flags

   486

		 * of the road placement actions.

   487

		 * At first we reset the end halfroad

   488

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

   489

		switch (e->we.place.select_proc) {