1

/* $Id$ */

     2

     3

/** @file road_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "bridge.h"

     9

#include "cmd_helper.h"

    10

#include "rail_map.h"

    11

#include "road_map.h"

    12

#include "sprite.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "strings.h"

    16

#include "functions.h"

    17

#include "window.h"

    18

#include "map.h"

    19

#include "landscape.h"

    20

#include "tile.h"

    21

#include "town_map.h"

    22

#include "vehicle.h"

    23

#include "viewport.h"

    24

#include "command.h"

    25

#include "player.h"

    26

#include "town.h"

    27

#include "gfx.h"

    28

#include "sound.h"

    29

#include "yapf/yapf.h"

    30

#include "depot.h"

    31

#include "newgrf.h"

    32

#include "station_map.h"

    33

#include "tunnel_map.h"

    34

#include "misc/autoptr.hpp"

    35

    36

    37

static uint CountRoadBits(RoadBits r)

    38

{

    39

	uint count = 0;

    40

    41

	if (r & ROAD_NW) ++count;

    42

	if (r & ROAD_SW) ++count;

    43

	if (r & ROAD_SE) ++count;

    44

	if (r & ROAD_NE) ++count;

    45

	return count;

    46

}

    47

    48

    49

bool CheckAllowRemoveRoad(TileIndex tile, RoadBits remove, Owner owner, bool *edge_road, RoadType rt)

    50

{

    51

	RoadBits present;

    52

	RoadBits n;

    53

	*edge_road = true;

    54

    55

	if (_game_mode == GM_EDITOR || remove == ROAD_NONE) return true;

    56

    57

	/* Water can always flood and towns can always remove "normal" road pieces.

    58

	 * Towns are not be allowed to remove non "normal" road pieces, like tram

    59

	 * tracks as that would result in trams that cannot turn. */

    60

	if (_current_player == OWNER_WATER ||

    61

			(rt == ROADTYPE_ROAD && !IsValidPlayer(_current_player))) return true;

    62

    63

	/* Only do the special processing if the road is owned

    64

	 * by a town */

    65

	if (owner != OWNER_TOWN) return (owner == OWNER_NONE) || CheckOwnership(owner);

    66

    67

	if (_cheats.magic_bulldozer.value) return true;

    68

    69

	/* Get a bitmask of which neighbouring roads has a tile */

    70

	n = ROAD_NONE;

    71

	present = GetAnyRoadBits(tile, rt);

    72

	if (present & ROAD_NE && GetAnyRoadBits(TILE_ADDXY(tile, -1,  0), rt) & ROAD_SW) n |= ROAD_NE;

    73

	if (present & ROAD_SE && GetAnyRoadBits(TILE_ADDXY(tile,  0,  1), rt) & ROAD_NW) n |= ROAD_SE;

    74

	if (present & ROAD_SW && GetAnyRoadBits(TILE_ADDXY(tile,  1,  0), rt) & ROAD_NE) n |= ROAD_SW;

    75

	if (present & ROAD_NW && GetAnyRoadBits(TILE_ADDXY(tile,  0, -1), rt) & ROAD_SE) n |= ROAD_NW;

    76

    77

	/* If 0 or 1 bits are set in n, or if no bits that match the bits to remove,

    78

	 * then allow it */

    79

	if ((n & (n - 1)) != 0 && (n & remove) != 0) {

    80

		Town *t;

    81

		*edge_road = false;

    82

		/* you can remove all kind of roads with extra dynamite */

    83

		if (_patches.extra_dynamite) return true;

    84

    85

		t = ClosestTownFromTile(tile, (uint)-1);

    86

    87

		SetDParam(0, t->index);

    88

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    89

		return false;

    90

	}

    91

    92

	return true;

    93

}

    94

    95

static bool CheckAllowRemoveRoad(TileIndex tile, RoadBits remove, bool *edge_road, RoadType rt)

    96

{

    97

	return CheckAllowRemoveRoad(tile, remove, GetRoadOwner(tile, rt), edge_road, rt);

    98

}

    99

   100

/** Delete a piece of road.

   101

 * @param tile tile where to remove road from

   102

 * @param flags operation to perform

   103

 * @param p1 bit 0..3 road pieces to remove (RoadBits)

   104

 *           bit 4..5 road type

   105

 *           bit    6 ignore the fact that the tram track has not been removed

   106

 *                    yet when removing the road bits when not actually doing

   107

 *                    it. Makes it possible to test whether the road bits can

   108

 *                    be removed from a level crossing without physically

   109

 *                    removing the tram bits before the test.

   110

 * @param p2 unused

   111

 */

   112

CommandCost CmdRemoveRoad(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   113

{

   114

	/* cost for removing inner/edge -roads */

   115

	static const uint16 road_remove_cost[2] = {50, 18};

   116

   117

	/* true if the roadpiece was always removeable,

   118

	 * false if it was a center piece. Affects town ratings drop */

   119

	bool edge_road;

   120

   121

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   122

   123

	RoadType rt = (RoadType)GB(p1, 4, 2);

   124

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   125

   126

	Town *t = NULL;

   127

	switch (GetTileType(tile)) {

   128

		case MP_ROAD:

   129

			if (_game_mode != GM_EDITOR && GetRoadOwner(tile, rt) == OWNER_TOWN) t = GetTownByTile(tile);

   130

			break;

   131

   132

		case MP_STATION:

   133

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   134

			break;

   135

   136

		case MP_TUNNELBRIDGE:

   137

			if ((IsTunnel(tile) && GetTunnelTransportType(tile) != TRANSPORT_ROAD) ||

   138

					(IsBridge(tile) && GetBridgeTransportType(tile) != TRANSPORT_ROAD)) return CMD_ERROR;

   139

			break;

   140

   141

		default:

   142

			return CMD_ERROR;

   143

	}

   144

   145

	RoadBits pieces = Extract<RoadBits, 0>(p1);

   146

	RoadTypes rts = GetRoadTypes(tile);

   147

	/* The tile doesn't have the given road type */

   148

	if (!HASBIT(rts, rt)) return CMD_ERROR;

   149

   150

	if (!CheckAllowRemoveRoad(tile, pieces, &edge_road, rt)) return CMD_ERROR;

   151

   152

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   153

   154

	/* check if you're allowed to remove the street owned by a town

   155

	 * removal allowance depends on difficulty setting */

   156

	if (!CheckforTownRating(flags, t, ROAD_REMOVE)) return CMD_ERROR;

   157

   158

	if (!IsTileType(tile, MP_ROAD)) {

   159

		/* If it's the last roadtype, just clear the whole tile */

   160

		if (rts == RoadTypeToRoadTypes(rt)) return DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   161

   162

		CommandCost cost;

   163

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   164

			TileIndex other_end = IsTunnel(tile) ? GetOtherTunnelEnd(tile) : GetOtherBridgeEnd(tile);

   165

			/* Pay for *every* tile of the bridge or tunnel */

   166

			cost.AddCost((DistanceManhattan(IsTunnel(tile) ? GetOtherTunnelEnd(tile) : GetOtherBridgeEnd(tile), tile) + 1) * _price.remove_road);

   167

			if (flags & DC_EXEC) {

   168

				SetRoadTypes(other_end, GetRoadTypes(other_end) & ~RoadTypeToRoadTypes(rt));

   169

				SetRoadTypes(tile, GetRoadTypes(tile) & ~RoadTypeToRoadTypes(rt));

   170

   171

				/* Mark tiles diry that have been repaved */

   172

				MarkTileDirtyByTile(tile);

   173

				MarkTileDirtyByTile(other_end);

   174

				if (IsBridge(tile)) {

   175

					TileIndexDiff delta = TileOffsByDiagDir(GetBridgeRampDirection(tile));

   176

   177

					for (TileIndex t = tile + delta; t != other_end; t += delta) MarkTileDirtyByTile(t);

   178

				}

   179

			}

   180

		} else {

   181

			cost.AddCost(_price.remove_road);

   182

			if (flags & DC_EXEC) {

   183

				SetRoadTypes(tile, GetRoadTypes(tile) & ~RoadTypeToRoadTypes(rt));

   184

				MarkTileDirtyByTile(tile);

   185

			}

   186

		}

   187

		return CommandCost(cost);

   188

	}

   189

   190

	switch (GetRoadTileType(tile)) {

   191

		case ROAD_TILE_NORMAL: {

   192

			RoadBits present = GetRoadBits(tile, rt);

   193

			RoadBits c = pieces;

   194

   195

			if (HasRoadWorks(tile)) return_cmd_error(STR_ROAD_WORKS_IN_PROGRESS);

   196

   197

			if (GetTileSlope(tile, NULL) != SLOPE_FLAT  &&

   198

					(present == ROAD_Y || present == ROAD_X)) {

   199

				c |= (RoadBits)((c & 0xC) >> 2);

   200

				c |= (RoadBits)((c & 0x3) << 2);

   201

			}

   202

   203

			/* limit the bits to delete to the existing bits. */

   204

			c &= present;

   205

			if (c == ROAD_NONE) return CMD_ERROR;

   206

   207

			if (flags & DC_EXEC) {

   208

				ChangeTownRating(t, -road_remove_cost[(byte)edge_road], RATING_ROAD_MINIMUM);

   209

   210

				present ^= c;

   211

				if (present == ROAD_NONE) {

   212

					RoadTypes rts = GetRoadTypes(tile) & ComplementRoadTypes(RoadTypeToRoadTypes(rt));

   213

					if (rts == ROADTYPES_NONE) {

   214

						DoClearSquare(tile);

   215

					} else {

   216

						SetRoadBits(tile, ROAD_NONE, rt);

   217

						SetRoadTypes(tile, rts);

   218

					}

   219

				} else {

   220

					/* When bits are removed, you *always* end up with something that

   221

					 * is not a complete straight road tile. However, trams do not have

   222

					 * onewayness, so they cannot remove it either. */

   223

					if (rt != ROADTYPE_TRAM) SetDisallowedRoadDirections(tile, DRD_NONE);

   224

					SetRoadBits(tile, present, rt);

   225

					MarkTileDirtyByTile(tile);

   226

				}

   227

			}

   228

			return CommandCost(CountRoadBits(c) * _price.remove_road);

   229

		}

   230

   231

		case ROAD_TILE_CROSSING: {

   232

			if (pieces & ComplementRoadBits(GetCrossingRoadBits(tile))) {

   233

				return CMD_ERROR;

   234

			}

   235

   236

			/* Don't allow road to be removed from the crossing when there is tram;

   237

			 * we can't draw the crossing without trambits ;) */

   238

			if (rt == ROADTYPE_ROAD && HASBIT(GetRoadTypes(tile), ROADTYPE_TRAM) && ((flags & DC_EXEC) || !HASBIT(p1, 6))) return CMD_ERROR;

   239

   240

			if (flags & DC_EXEC) {

   241

				if (rt == ROADTYPE_ROAD) {

   242

					ChangeTownRating(t, -road_remove_cost[(byte)edge_road], RATING_ROAD_MINIMUM);

   243

				}

   244

   245

				RoadTypes rts = GetRoadTypes(tile) & ComplementRoadTypes(RoadTypeToRoadTypes(rt));

   246

				if (rts == ROADTYPES_NONE) {

   247

					MakeRailNormal(tile, GetTileOwner(tile), GetCrossingRailBits(tile), GetRailType(tile));

   248

				} else {

   249

					SetRoadTypes(tile, rts);

   250

				}

   251

				MarkTileDirtyByTile(tile);

   252

				YapfNotifyTrackLayoutChange(tile, FindFirstTrack(GetTrackBits(tile)));

   253

			}

   254

			return CommandCost(_price.remove_road * 2);

   255

		}

   256

   257

		default:

   258

		case ROAD_TILE_DEPOT:

   259

			return CMD_ERROR;

   260

	}

   261

}

   262

   263

   264

static const RoadBits _valid_tileh_slopes_road[][15] = {

   265

	/* set of normal ones */

   266

	{

   267

		ROAD_ALL, ROAD_NONE, ROAD_NONE,

   268

		ROAD_X,   ROAD_NONE, ROAD_NONE,  // 3, 4, 5

   269

		ROAD_Y,   ROAD_NONE, ROAD_NONE,

   270

		ROAD_Y,   ROAD_NONE, ROAD_NONE,  // 9, 10, 11

   271

		ROAD_X,   ROAD_NONE, ROAD_NONE

   272

	},

   273

	/* allowed road for an evenly raised platform */

   274

	{

   275

		ROAD_NONE,

   276

		ROAD_SW | ROAD_NW,

   277

		ROAD_SW | ROAD_SE,

   278

		ROAD_Y  | ROAD_SW,

   279

   280

		ROAD_SE | ROAD_NE, // 4

   281

		ROAD_ALL,

   282

		ROAD_X  | ROAD_SE,

   283

		ROAD_ALL,

   284

   285

		ROAD_NW | ROAD_NE, // 8

   286

		ROAD_X  | ROAD_NW,

   287

		ROAD_ALL,

   288

		ROAD_ALL,

   289

   290

		ROAD_Y  | ROAD_NE, // 12

   291

		ROAD_ALL,

   292

		ROAD_ALL

   293

	},

   294

};

   295

   296

   297

static CommandCost CheckRoadSlope(Slope tileh, RoadBits* pieces, RoadBits existing)

   298

{

   299

	RoadBits road_bits;

   300

   301

	if (IsSteepSlope(tileh)) {

   302

		/* force full pieces. */

   303

		*pieces |= (RoadBits)((*pieces & 0xC) >> 2);

   304

		*pieces |= (RoadBits)((*pieces & 0x3) << 2);

   305

   306

		if (existing == 0 || existing == *pieces) {

   307

			if (*pieces == ROAD_X || *pieces == ROAD_Y) return _price.terraform;

   308

		}

   309

		return CMD_ERROR;

   310

	}

   311

	road_bits = *pieces | existing;

   312

   313

	/* no special foundation */

   314

	if ((~_valid_tileh_slopes_road[0][tileh] & road_bits) == 0) {

   315

		/* force that all bits are set when we have slopes */

   316

		if (tileh != SLOPE_FLAT) *pieces |= _valid_tileh_slopes_road[0][tileh];

   317

		return CommandCost(); // no extra cost

   318

	}

   319

   320

	/* foundation is used. Whole tile is leveled up */

   321

	if ((~_valid_tileh_slopes_road[1][tileh] & road_bits) == 0) {

   322

		return CommandCost(existing != 0 ? 0 : _price.terraform);

   323

	}

   324

   325

	*pieces |= (RoadBits)((*pieces & 0xC) >> 2);

   326

	*pieces |= (RoadBits)((*pieces & 0x3) << 2);

   327

   328

	/* partly leveled up tile, only if there's no road on that tile */

   329

	if ((existing == 0 || existing == *pieces) && (tileh == SLOPE_W || tileh == SLOPE_S || tileh == SLOPE_E || tileh == SLOPE_N)) {

   330

		/* force full pieces. */

   331

		if (*pieces == ROAD_X || *pieces == ROAD_Y) return _price.terraform;

   332

	}

   333

	return CMD_ERROR;

   334

}

   335

   336

/** Build a piece of road.

   337

 * @param tile tile where to build road

   338

 * @param flags operation to perform

   339

 * @param p1 bit 0..3 road pieces to build (RoadBits)

   340

 *           bit 4..5 road type

   341

 *           bit 6..7 disallowed directions to toggle

   342

 * @param p2 the town that is building the road (0 if not applicable)

   343

 */

   344

CommandCost CmdBuildRoad(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   345

{

   346

	CommandCost cost;

   347

	CommandCost ret;

   348

	RoadBits existing = ROAD_NONE;

   349

	RoadBits all_bits = ROAD_NONE;

   350

	Slope tileh;

   351

   352

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   353

   354

	/* Road pieces are max 4 bitset values (NE, NW, SE, SW) and town can only be non-zero

   355

	 * if a non-player is building the road */

   356

	if ((IsValidPlayer(_current_player) && p2 != 0) || (_current_player == OWNER_TOWN && !IsValidTownID(p2))) return CMD_ERROR;

   357

   358

	RoadBits pieces = Extract<RoadBits, 0>(p1);

   359

   360

	RoadType rt = (RoadType)GB(p1, 4, 2);

   361

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   362

   363

	DisallowedRoadDirections toggle_drd = (DisallowedRoadDirections)GB(p1, 6, 2);

   364

   365

	tileh = GetTileSlope(tile, NULL);

   366

   367

	switch (GetTileType(tile)) {

   368

		case MP_ROAD:

   369

			switch (GetRoadTileType(tile)) {

   370

				case ROAD_TILE_NORMAL: {

   371

					if (HasRoadWorks(tile)) return_cmd_error(STR_ROAD_WORKS_IN_PROGRESS);

   372

					if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   373

   374

					all_bits = GetAllRoadBits(tile);

   375

					if (!HASBIT(GetRoadTypes(tile), rt)) break;

   376

   377

					existing = GetRoadBits(tile, rt);

   378

					RoadBits merged = existing | pieces;

   379

					bool crossing = (merged != ROAD_X && merged != ROAD_Y);

   380

					if (rt != ROADTYPE_TRAM && (GetDisallowedRoadDirections(tile) != DRD_NONE || toggle_drd != DRD_NONE) && crossing) {

   381

						/* Junctions cannot be one-way */

   382

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   383

					}

   384

					if ((existing & pieces) == pieces) {

   385

						/* We only want to set the (dis)allowed road directions */

   386

						if (toggle_drd != DRD_NONE && rt != ROADTYPE_TRAM && GetRoadOwner(tile, ROADTYPE_ROAD) == _current_player) {

   387

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   388

   389

							/* Ignore half built tiles */

   390

							if (flags & DC_EXEC && rt != ROADTYPE_TRAM && (existing == ROAD_X || existing == ROAD_Y)) {

   391

								SetDisallowedRoadDirections(tile, GetDisallowedRoadDirections(tile) ^ toggle_drd);

   392

								MarkTileDirtyByTile(tile);

   393

							}

   394

							return CommandCost();

   395

						}

   396

						return_cmd_error(STR_1007_ALREADY_BUILT);

   397

					}

   398

				} break;

   399

   400

				case ROAD_TILE_CROSSING:

   401

					if (HASBIT(GetRoadTypes(tile), rt)) return_cmd_error(STR_1007_ALREADY_BUILT);

   402

					all_bits = GetCrossingRoadBits(tile);

   403

					if (pieces & ComplementRoadBits(all_bits)) goto do_clear;

   404

					break;

   405

   406

				default:

   407

				case ROAD_TILE_DEPOT:

   408

					goto do_clear;

   409

			}

   410

			break;

   411

   412

		case MP_RAILWAY: {

   413

			Axis roaddir;

   414

   415

			if (IsSteepSlope(tileh)) {

   416

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   417

			}

   418

   419

#define M(x) (1 << (x))

   420

			/* Level crossings may only be built on these slopes */

   421

			if (!HASBIT(M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT), tileh)) {

   422

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   423

			}

   424

#undef M

   425

   426

			if (GetRailTileType(tile) != RAIL_TILE_NORMAL) goto do_clear;

   427

			switch (GetTrackBits(tile)) {

   428

				case TRACK_BIT_X:

   429

					if (pieces & ROAD_X) goto do_clear;

   430

					roaddir = AXIS_Y;

   431

					break;

   432

   433

				case TRACK_BIT_Y:

   434

					if (pieces & ROAD_Y) goto do_clear;

   435

					roaddir = AXIS_X;

   436

					break;

   437

   438

				default: goto do_clear;

   439

			}

   440

   441

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   442

   443

			if (flags & DC_EXEC) {

   444

				YapfNotifyTrackLayoutChange(tile, FindFirstTrack(GetTrackBits(tile)));

   445

				/* Always add road to the roadtypes (can't draw without it) */

   446

				MakeRoadCrossing(tile, _current_player, _current_player, _current_player, GetTileOwner(tile), roaddir, GetRailType(tile), RoadTypeToRoadTypes(rt) | ROADTYPES_ROAD, p2);

   447

				MarkTileDirtyByTile(tile);

   448

			}

   449

			return CommandCost(_price.build_road * (rt == ROADTYPE_ROAD ? 2 : 4));

   450

		}

   451

   452

		case MP_STATION:

   453

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   454

			if (HASBIT(GetRoadTypes(tile), rt)) return_cmd_error(STR_1007_ALREADY_BUILT);

   455

			/* Don't allow "upgrading" the roadstop when vehicles are already driving on it */

   456

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   457

			break;

   458

   459

		case MP_TUNNELBRIDGE:

   460

			if ((IsTunnel(tile) && GetTunnelTransportType(tile) != TRANSPORT_ROAD) ||

   461

					(IsBridge(tile) && GetBridgeTransportType(tile) != TRANSPORT_ROAD)) return CMD_ERROR;

   462

			if (HASBIT(GetRoadTypes(tile), rt)) return_cmd_error(STR_1007_ALREADY_BUILT);

   463

			/* Don't allow "upgrading" the bridge/tunnel when vehicles are already driving on it */

   464

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   465

			break;

   466

   467

		default:

   468

do_clear:;

   469

			ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   470

			if (CmdFailed(ret)) return ret;

   471

			cost.AddCost(ret);

   472

	}

   473

   474

	if (all_bits != pieces) {

   475

		/* Check the foundation/slopes when adding road/tram bits */

   476

		ret = CheckRoadSlope(tileh, &pieces, all_bits | existing);

   477

		/* Return an error if we need to build a foundation (ret != 0) but the

   478

		 * current patch-setting is turned off (or stupid AI@work) */

   479

		if (CmdFailed(ret) || (ret.GetCost() != 0 && (!_patches.build_on_slopes || _is_old_ai_player))) {

   480

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   481

		}

   482

		cost.AddCost(ret);

   483

	}