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

    14

#include "variables.h"

    15

#include "road_cmd.h"

    16

#include "road_map.h"

    17

#include "station_map.h"

    18

#include "station.h"

    19

#include "functions.h"

    20

#include "window_func.h"

    21

#include "vehicle_func.h"

    22

#include "sound_func.h"

    23

    24

    25

static void ShowRVStationPicker(RoadStop::Type rs);

    26

static void ShowRoadDepotPicker();

    27

    28

static bool _remove_button_clicked;

    29

static bool _one_way_button_clicked;

    30

    31

/**

    32

 * Define the values of the RoadFlags

    33

 * @see CmdBuildLongRoad

    34

 */

    35

enum RoadFlags {

    36

	RF_NONE             = 0x00,

    37

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

    38

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

    39

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

    40

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

    41

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

    42

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

    43

};

    44

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    45

    46

static RoadFlags _place_road_flag;

    47

    48

static RoadType _cur_roadtype;

    49

    50

static DiagDirection _road_depot_orientation;

    51

static DiagDirection _road_station_picker_orientation;

    52

    53

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

    54

{

    55

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    56

}

    57

    58

/**

    59

 * Set the initial flags for the road constuction.

    60

 * The flags are:

    61

 * @li The direction is the X-dir

    62

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

    63

 *

    64

 * @param tile The start tile

    65

 */

    66

static void PlaceRoad_X_Dir(TileIndex tile)

    67

{

    68

	_place_road_flag = RF_DIR_X;

    69

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

    70

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_X_DIR);

    71

}

    72

    73

/**

    74

 * Set the initial flags for the road constuction.

    75

 * The flags are:

    76

 * @li The direction is the Y-dir

    77

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

    78

 *

    79

 * @param tile The start tile

    80

 */

    81

static void PlaceRoad_Y_Dir(TileIndex tile)

    82

{

    83

	_place_road_flag = RF_DIR_Y;

    84

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

    85

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_Y_DIR);

    86

}

    87

    88

/**

    89

 * Set the initial flags for the road constuction.

    90

 * The flags are:

    91

 * @li The direction is not set.

    92

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

    93

 *

    94

 * @param tile The start tile

    95

 */

    96

static void PlaceRoad_AutoRoad(TileIndex tile)

    97

{

    98

	_place_road_flag = RF_NONE;

    99

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

   100

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

   101

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   102

}

   103

   104

static void PlaceRoad_Bridge(TileIndex tile)

   105

{

   106

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   107

}

   108

   109

   110

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

   111

{

   112

	if (success) {

   113

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   114

		ResetObjectToPlace();

   115

	} else {

   116

		SetRedErrorSquare(_build_tunnel_endtile);

   117

	}

   118

}

   119

   120

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

   121

struct RoadTypeInfo {

   122

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

   123

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

   124

	StringID err_depot;             ///< Building a depot

   125

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

   126

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

   127

   128

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

   129

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

   130

   131

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

   132

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

   133

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   134

};

   135

   136

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

   137

static const RoadTypeInfo _road_type_infos[] = {

   138

	{

   139

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   140

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   141

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   142

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   143

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   144

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   145

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   146

   147

		SPR_CURSOR_ROAD_NESW,

   148

		SPR_CURSOR_ROAD_NWSE,

   149

		SPR_CURSOR_AUTOROAD,

   150

	},

   151

	{

   152

		STR_1804_CAN_T_BUILD_TRAMWAY_HERE,

   153

		STR_1805_CAN_T_REMOVE_TRAMWAY_FROM,

   154

		STR_1807_CAN_T_BUILD_TRAM_VEHICLE,

   155

		{ STR_1808_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_1809_CAN_T_BUILD_CARGO_TRAM_STATION        },

   156

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,            STR_CAN_T_REMOVE_CARGO_TRAM_STATION            },

   157

		{ STR_3042_PASSENGER_TRAM_STATION_ORIENTATION,        STR_3043_CARGO_TRAM_STATION_ORIENT             },

   158

		{ STR_3051_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_3052_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   159

   160

		SPR_CURSOR_TRAMWAY_NESW,

   161

		SPR_CURSOR_TRAMWAY_NWSE,

   162

		SPR_CURSOR_AUTOTRAM,

   163

	},

   164

};

   165

   166

static void PlaceRoad_Tunnel(TileIndex tile)

   167

{

   168

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

   169

}

   170

   171

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   172

{

   173

	tile += TileOffsByDiagDir(direction);

   174

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

   175

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

   176

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

   177

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

   178

		}

   179

	}

   180

}

   181

   182

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

   183

{

   184

	if (success) {

   185

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

   186

		SndPlayTileFx(SND_1F_SPLAT, tile);

   187

		ResetObjectToPlace();

   188

		BuildRoadOutsideStation(tile, dir);

   189

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

   190

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

   191

	}

   192

}

   193

   194

static void PlaceRoad_Depot(TileIndex tile)

   195

{

   196

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

   197

}

   198

   199

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

   200

{

   201

	uint32 p1 = _road_station_picker_orientation;

   202

   203

	if (p1 >= DIAGDIR_END) {

   204

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

   205

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

   206

	}

   207

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

   208

}

   209

   210

static void PlaceRoad_BusStation(TileIndex tile)

   211

{

   212

	if (_remove_button_clicked) {

   213

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

   214

	} else {

   215

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

   216

	}

   217

}

   218

   219

static void PlaceRoad_TruckStation(TileIndex tile)

   220

{

   221

	if (_remove_button_clicked) {

   222

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

   223

	} else {

   224

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

   225

	}

   226

}

   227

   228

static void PlaceRoad_DemolishArea(TileIndex tile)

   229

{

   230

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_DEMOLISH_AREA);

   231

}

   232

   233

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

   234

enum RoadToolbarWidgets {

   235

	RTW_CLOSEBOX = 0,

   236

	RTW_CAPTION,

   237

	RTW_STICKY,

   238

	RTW_ROAD_X,

   239

	RTW_ROAD_Y,

   240

	RTW_AUTOROAD,

   241

	RTW_DEMOLISH,

   242

	RTW_DEPOT,

   243

	RTW_BUS_STATION,

   244

	RTW_TRUCK_STATION,

   245

	RTW_ONE_WAY,

   246

	RTW_BUILD_BRIDGE,

   247

	RTW_BUILD_TUNNEL,

   248

	RTW_REMOVE,

   249

};

   250

   251

typedef void OnButtonClick(Window *w);

   252

   253

/**

   254

 * Function that handles the click on the

   255

 *  X road placement button.

   256

 *

   257

 * @param w The current window

   258

 */

   259

static void BuildRoadClick_X_Dir(Window *w)

   260

{

   261

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

   262

}

   263

   264

/**

   265

 * Function that handles the click on the

   266

 *  Y road placement button.

   267

 *

   268

 * @param w The current window

   269

 */

   270

static void BuildRoadClick_Y_Dir(Window *w)

   271

{

   272

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

   273

}

   274

   275

/**

   276

 * Function that handles the click on the

   277

 *  autoroad placement button.

   278

 *

   279

 * @param w The current window

   280

 */

   281

static void BuildRoadClick_AutoRoad(Window *w)

   282

{

   283

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

   284

}

   285

   286

static void BuildRoadClick_Demolish(Window *w)

   287

{

   288

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

   289

}

   290

   291

static void BuildRoadClick_Depot(Window *w)

   292

{

   293

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

   294

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

   295

}

   296

   297

static void BuildRoadClick_BusStation(Window *w)

   298

{

   299

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

   300

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

   301

}

   302

   303

static void BuildRoadClick_TruckStation(Window *w)

   304

{

   305

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

   306

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

   307

}

   308

   309

/**

   310

 * Function that handles the click on the

   311

 *  one way road button.

   312

 *

   313

 * @param w The current window

   314

 */

   315

static void BuildRoadClick_OneWay(Window *w)

   316

{

   317

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

   318

	SetWindowDirty(w);

   319

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   320

	SetSelectionRed(false);

   321

}

   322

   323

static void BuildRoadClick_Bridge(Window *w)

   324

{

   325

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

   326

}

   327

   328

static void BuildRoadClick_Tunnel(Window *w)

   329

{

   330

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

   331

}

   332

   333

static void BuildRoadClick_Remove(Window *w)

   334

{

   335

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

   336

	SetWindowDirty(w);

   337

	SndPlayFx(SND_15_BEEP);

   338

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   339

	SetSelectionRed(w->IsWidgetLowered(RTW_REMOVE));

   340

}

   341

   342

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

   343

static OnButtonClick* const _build_road_button_proc[] = {

   344

	BuildRoadClick_X_Dir,

   345

	BuildRoadClick_Y_Dir,

   346

	BuildRoadClick_AutoRoad,

   347

	BuildRoadClick_Demolish,

   348

	BuildRoadClick_Depot,

   349

	BuildRoadClick_BusStation,

   350

	BuildRoadClick_TruckStation,

   351

	BuildRoadClick_OneWay,

   352

	BuildRoadClick_Bridge,

   353

	BuildRoadClick_Tunnel,

   354

	BuildRoadClick_Remove

   355

};

   356

   357

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

   358

static const uint16 _road_keycodes[] = {

   359

	'1',

   360

	'2',

   361

	'3',

   362

	'4',

   363

	'5',

   364

	'6',

   365

	'7',

   366

	'8',

   367

	'B',

   368

	'T',

   369

	'R',

   370

};

   371

   372

/**

   373

 * Update the remove button lowered state of the road toolbar

   374

 *

   375

 * @param w The toolbar window

   376

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

   377

 */

   378

static void UpdateOptionWidgetStatus(Window *w, int clicked_widget)

   379

{

   380

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

   381

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

   382

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

   383

	switch (clicked_widget) {

   384

		case RTW_REMOVE:

   385

			w->RaiseWidget(RTW_ONE_WAY);

   386

			break;

   387

		case RTW_ONE_WAY:

   388

			w->RaiseWidget(RTW_REMOVE);

   389

			break;

   390

		case RTW_BUS_STATION:

   391

		case RTW_TRUCK_STATION:

   392

			w->DisableWidget(RTW_ONE_WAY);

   393

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

   394

			break;

   395

		case RTW_ROAD_X:

   396

		case RTW_ROAD_Y:

   397

		case RTW_AUTOROAD:

   398

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

   399

				RTW_REMOVE,

   400

				RTW_ONE_WAY,

   401

				WIDGET_LIST_END);

   402

			break;

   403

		default:

   404

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

   405

			 * disable the removal button */

   406

			w->SetWidgetsDisabledState(true,

   407

				RTW_REMOVE,

   408

				RTW_ONE_WAY,

   409

				WIDGET_LIST_END);

   410

			w->SetWidgetsLoweredState (false,

   411

				RTW_REMOVE,

   412

				RTW_ONE_WAY,

   413

				WIDGET_LIST_END);

   414

			break;

   415

	}

   416

}

   417

   418

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

   419

{

   420

	switch (e->event) {

   421

	case WE_CREATE:

   422

		w->SetWidgetsDisabledState(true,

   423

			RTW_REMOVE,

   424

			RTW_ONE_WAY,

   425

			WIDGET_LIST_END);

   426

		break;

   427

   428

	case WE_PAINT:

   429

		w->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   430

			RTW_DEPOT,

   431

			RTW_BUS_STATION,

   432

			RTW_TRUCK_STATION,

   433

			WIDGET_LIST_END);

   434

		DrawWindowWidgets(w);

   435

		break;

   436

   437

	case WE_CLICK:

   438

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

   439

			_remove_button_clicked = false;

   440

			_one_way_button_clicked = false;

   441

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

   442

		}

   443

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

   444

		break;

   445

   446

	case WE_KEYPRESS:

   447

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

   448

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

   449

				e->we.keypress.cont = false;

   450

				_remove_button_clicked = false;

   451

				_one_way_button_clicked = false;

   452

				_build_road_button_proc[i](w);

   453

				UpdateOptionWidgetStatus(w, i + RTW_ROAD_X);

   454

				break;

   455

			}

   456

		}

   457

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

   458

		break;

   459

   460

	case WE_PLACE_OBJ:

   461

		_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   462

		_one_way_button_clicked = w->IsWidgetLowered(RTW_ONE_WAY);

   463

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

   464

		break;

   465

   466

	case WE_ABORT_PLACE_OBJ:

   467

		w->RaiseButtons();

   468

		w->SetWidgetsDisabledState(true,

   469

			RTW_REMOVE,

   470

			RTW_ONE_WAY,

   471

			WIDGET_LIST_END);

   472

		w->InvalidateWidget(RTW_REMOVE);

   473

		w->InvalidateWidget(RTW_ONE_WAY);

   474

   475

		w = FindWindowById(WC_BUS_STATION, 0);

   476

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

   477

		w = FindWindowById(WC_TRUCK_STATION, 0);

   478

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

   479

		w = FindWindowById(WC_BUILD_DEPOT, 0);

   480

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

   481

		break;

   482

   483

	case WE_PLACE_DRAG:

   484

		/* Here we update the end tile flags

   485

		 * of the road placement actions.

   486

		 * At first we reset the end halfroad

   487

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

   488

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

   489

			case DDSP_PLACE_ROAD_X_DIR: