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

    13

#include "sprite.h"

    14

#include "tile_cmd.h"

    15

#include "landscape.h"

    16

#include "town_map.h"

    17

#include "viewport_func.h"

    18

#include "command_func.h"

    19

#include "town.h"

    20

#include "yapf/yapf.h"

    21

#include "depot.h"

    22

#include "newgrf.h"

    23

#include "station_map.h"

    24

#include "tunnel_map.h"

    25

#include "misc/autoptr.hpp"

    26

#include "variables.h"

    27

#include "autoslope.h"

    28

#include "transparency.h"

    29

#include "tunnelbridge_map.h"

    30

#include "window_func.h"

    31

#include "strings_func.h"

    32

#include "vehicle_func.h"

    33

#include "vehicle_base.h"

    34

#include "sound_func.h"

    35

#include "road_func.h"

    36

#include "tunnelbridge.h"

    37

    38

#include "table/sprites.h"

    39

#include "table/strings.h"

    40

    41

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

    42

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

    43

static const uint32 VALID_LEVEL_CROSSING_SLOPES = (M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT));

    44

#undef M

    45

    46

Foundation GetRoadFoundation(Slope tileh, RoadBits bits);

    47

    48

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

    49

{

    50

	RoadBits present;

    51

	RoadBits n;

    52

	*edge_road = true;

    53

    54

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

    55

    56

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

    57

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

    58

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

    59

	if (_current_player == OWNER_WATER ||

    60

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

    61

    62

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

    63

	 * by a town */

    64

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

    65

    66

	if (_cheats.magic_bulldozer.value) return true;

    67

    68

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

    69

	n = ROAD_NONE;

    70

	present = GetAnyRoadBits(tile, rt);

    71

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

    72

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

    73

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

    74

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

    75

    76

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

    77

	 * then allow it */

    78

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

    79

		Town *t;

    80

		*edge_road = false;

    81

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

    82

		if (_patches.extra_dynamite) return true;

    83

    84

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

    85

    86

		SetDParam(0, t->index);

    87

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    88

		return false;

    89

	}

    90

    91

	return true;

    92

}

    93

    94

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

    95

{

    96

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

    97

}

    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 pieces roadbits to remove

   104

 * @param rt roadtype to remove

   105

 * @param crossing_check should we check if there is a tram track when we are removing road from crossing?

   106

 */

   107

static CommandCost RemoveRoad(TileIndex tile, uint32 flags, RoadBits pieces, RoadType rt, bool crossing_check)

   108

{

   109

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

   110

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

   111

   112

	/* true if the roadpiece was always removeable,

   113

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

   114

	bool edge_road;

   115

   116

	Town *t = NULL;

   117

	switch (GetTileType(tile)) {

   118

		case MP_ROAD:

   119

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

   120

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   121

			break;

   122

   123

		case MP_STATION:

   124

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   125

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   126

			break;

   127

   128

		case MP_TUNNELBRIDGE:

   129

			if (GetTunnelBridgeTransportType(tile) != TRANSPORT_ROAD) return CMD_ERROR;

   130

			if (GetVehicleTunnelBridge(tile, GetOtherTunnelBridgeEnd(tile)) != NULL) return CMD_ERROR;

   131

			break;

   132

   133

		default:

   134

			return CMD_ERROR;

   135

	}

   136

   137

	RoadTypes rts = GetRoadTypes(tile);

   138

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

   139

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

   140

   141

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

   142

   143

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

   144

	 * removal allowance depends on difficulty setting */

   145

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

   146

   147

	if (!IsTileType(tile, MP_ROAD)) {

   148

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

   149

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

   150

   151

		CommandCost cost(EXPENSES_CONSTRUCTION);

   152

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   153

			TileIndex other_end = GetOtherTunnelBridgeEnd(tile);

   154

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

   155

			cost.AddCost((GetTunnelBridgeLength(other_end, tile) + 2) * _price.remove_road);

   156

			if (flags & DC_EXEC) {

   157

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

   158

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

   159

   160

				/* Mark tiles diry that have been repaved */

   161

				MarkTileDirtyByTile(tile);

   162

				MarkTileDirtyByTile(other_end);

   163

				if (IsBridge(tile)) {

   164

					TileIndexDiff delta = TileOffsByDiagDir(GetTunnelBridgeDirection(tile));

   165

   166

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

   167

				}

   168

			}

   169

		} else {

   170

			cost.AddCost(_price.remove_road);

   171

			if (flags & DC_EXEC) {

   172

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

   173

				MarkTileDirtyByTile(tile);

   174

			}

   175

		}

   176

		return cost;

   177

	}

   178

   179

	switch (GetRoadTileType(tile)) {

   180

		case ROAD_TILE_NORMAL: {

   181

			RoadBits present = GetRoadBits(tile, rt);

   182

			RoadBits c = pieces;

   183

   184

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

   185

   186

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

   187

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

   188

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

   189

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

   190

			}

   191

   192

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

   193

			c &= present;

   194

			if (c == ROAD_NONE) return CMD_ERROR;

   195

   196

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

   197

			if (flags & DC_EXEC) {

   198

				present ^= c;

   199

				if (present == ROAD_NONE) {

   200

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

   201

					if (rts == ROADTYPES_NONE) {

   202

						/* Includes MarkTileDirtyByTile() */

   203

						DoClearSquare(tile);

   204

					} else {

   205

						SetRoadBits(tile, ROAD_NONE, rt);

   206

						SetRoadTypes(tile, rts);

   207

						MarkTileDirtyByTile(tile);

   208

					}

   209

				} else {

   210

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

   211

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

   212

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

   213

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

   214

					SetRoadBits(tile, present, rt);

   215

					MarkTileDirtyByTile(tile);

   216

				}

   217

			}

   218

			return CommandCost(EXPENSES_CONSTRUCTION, CountBits(c) * _price.remove_road);

   219

		}

   220

   221

		case ROAD_TILE_CROSSING: {

   222

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

   223

				return CMD_ERROR;

   224

			}

   225

   226

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

   227

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

   228

			if (rt == ROADTYPE_ROAD && HasTileRoadType(tile, ROADTYPE_TRAM) && (flags & DC_EXEC || crossing_check)) return CMD_ERROR;

   229

   230

			if (rt == ROADTYPE_ROAD) {

   231

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

   232

			}

   233

   234

			if (flags & DC_EXEC) {

   235

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

   236

				if (rts == ROADTYPES_NONE) {

   237

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

   238

				} else {

   239

					SetRoadTypes(tile, rts);

   240

				}

   241

				MarkTileDirtyByTile(tile);

   242

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

   243

			}

   244

			return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_road * 2);

   245

		}

   246

   247

		default:

   248

		case ROAD_TILE_DEPOT:

   249

			return CMD_ERROR;

   250

	}

   251

}

   252

   253

   254

/** Delete a piece of road.

   255

 * @param tile tile where to remove road from

   256

 * @param flags operation to perform

   257

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

   258

 *           bit 4..5 road type

   259

 * @param p2 unused

   260

 */

   261

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

   262

{

   263

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

   264

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   265

   266

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

   267

   268

	return RemoveRoad(tile, flags, pieces, rt, true);

   269

}

   270

   271

   272

static const RoadBits _valid_tileh_slopes_road[][15] = {

   273

	/* set of normal ones */

   274

	{

   275

		ROAD_ALL,  // SLOPE_FLAT

   276

		ROAD_NONE, // SLOPE_W

   277

		ROAD_NONE, // SLOPE_S

   278

   279

		ROAD_X,    // SLOPE_SW

   280

		ROAD_NONE, // SLOPE_E

   281

		ROAD_NONE, // SLOPE_EW

   282

   283

		ROAD_Y,    // SLOPE_SE

   284

		ROAD_NONE, // SLOPE_WSE

   285

		ROAD_NONE, // SLOPE_N

   286

   287

		ROAD_Y,    // SLOPE_NW

   288

		ROAD_NONE, // SLOPE_NS

   289

		ROAD_NONE, // SLOPE_NE

   290

   291

		ROAD_X,    // SLOPE_ENW

   292

		ROAD_NONE, // SLOPE_SEN

   293

		ROAD_NONE  // SLOPE_ELEVATED

   294

	},

   295

	/* allowed road for an evenly raised platform */

   296

	{

   297

		ROAD_NONE,         // SLOPE_FLAT

   298

		ROAD_SW | ROAD_NW, // SLOPE_W

   299

		ROAD_SW | ROAD_SE, // SLOPE_S

   300

   301

		ROAD_Y  | ROAD_SW, // SLOPE_SW

   302

		ROAD_SE | ROAD_NE, // SLOPE_E

   303

		ROAD_ALL,          // SLOPE_EW

   304

   305

		ROAD_X  | ROAD_SE, // SLOPE_SE

   306

		ROAD_ALL,          // SLOPE_WSE

   307

		ROAD_NW | ROAD_NE, // SLOPE_N

   308

   309

		ROAD_X  | ROAD_NW, // SLOPE_NW

   310

		ROAD_ALL,          // SLOPE_NS

   311

		ROAD_ALL,          // SLOPE_NE

   312

   313

		ROAD_Y  | ROAD_NE, // SLOPE_ENW

   314

		ROAD_ALL,          // SLOPE_SEN

   315

		ROAD_ALL           // SLOPE_ELEVATED

   316

	},

   317

	/* Singe bits on slopes */

   318

	{

   319

		ROAD_ALL,          // SLOPE_FLAT

   320

		ROAD_NE | ROAD_SE, // SLOPE_W

   321

		ROAD_NE | ROAD_NW, // SLOPE_S

   322

   323

		ROAD_NE,           // SLOPE_SW

   324

		ROAD_NW | ROAD_SW, // SLOPE_E

   325

		ROAD_ALL,          // SLOPE_EW

   326

   327

		ROAD_NW,           // SLOPE_SE

   328

		ROAD_ALL,          // SLOPE_WSE

   329

		ROAD_SE | ROAD_SW, // SLOPE_N

   330

   331

		ROAD_SE,           // SLOPE_NW

   332

		ROAD_ALL,          // SLOPE_NS

   333

		ROAD_ALL,          // SLOPE_NE

   334

   335

		ROAD_SW,           // SLOPE_ENW

   336

		ROAD_ALL,          // SLOPE_SEN

   337

		ROAD_ALL,          // SLOPE_ELEVATED

   338

	},

   339

};

   340

   341

/**

   342

 * Calculate the costs for roads on slopes

   343

 *  Aside modify the RoadBits to fit on the slopes

   344

 *

   345

 * @note The RoadBits are modified too!

   346

 * @param tileh The current slope

   347

 * @param pieces The RoadBits we want to add

   348

 * @param existing The existent RoadBits

   349

 * @return The costs for these RoadBits on this slope

   350

 */

   351

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

   352

{

   353

	if (IsSteepSlope(tileh)) {

   354

		/* Force straight roads. */

   355

		*pieces |= MirrorRoadBits(*pieces);

   356

   357

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

   358

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

   359

		}

   360

		return CMD_ERROR;

   361

	}

   362

   363

	RoadBits road_bits = *pieces | existing;

   364

   365

	/* Single bits on slopes.

   366

	 * We check for the roads that need at least 2 bits */

   367

	if (_patches.build_on_slopes &&

   368

			existing == ROAD_NONE && CountBits(*pieces) == 1 &&

   369

			(_valid_tileh_slopes_road[2][tileh] & *pieces) == ROAD_NONE) {

   370

		return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   371

	}

   372

   373

	/* no special foundation */

   374

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

   375

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

   376

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

   377

		return CommandCost(); // no extra cost

   378

	}

   379

   380

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

   381

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

   382

		return CommandCost(EXPENSES_CONSTRUCTION, existing != ROAD_NONE ? (Money)0 : _price.terraform);

   383

	}

   384

   385

	/* Force straight roads. */

   386

	*pieces |= MirrorRoadBits(*pieces);

   387

   388

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

   389

	if ((existing == ROAD_NONE || existing == *pieces) && IsSlopeWithOneCornerRaised(tileh)) {

   390

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

   391

	}

   392

	return CMD_ERROR;

   393

}

   394

   395

/** Build a piece of road.

   396

 * @param tile tile where to build road

   397

 * @param flags operation to perform

   398

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

   399

 *           bit 4..5 road type

   400

 *           bit 6..7 disallowed directions to toggle

   401

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

   402

 */

   403

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

   404

{

   405

	CommandCost cost(EXPENSES_CONSTRUCTION);

   406

	CommandCost ret;

   407

	RoadBits existing = ROAD_NONE;

   408

	RoadBits all_bits = ROAD_NONE;

   409

	Slope tileh;

   410

   411

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

   412

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

   413

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

   414

   415

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

   416

   417

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

   418

	if (!IsValidRoadType(rt) || !ValParamRoadType(rt)) return CMD_ERROR;

   419

   420

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

   421

   422

	tileh = GetTileSlope(tile, NULL);

   423

   424

	switch (GetTileType(tile)) {

   425

		case MP_ROAD:

   426

			switch (GetRoadTileType(tile)) {

   427

				case ROAD_TILE_NORMAL: {

   428

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

   429

   430

					all_bits = GetAllRoadBits(tile);

   431

					if (!HasTileRoadType(tile, rt)) break;

   432

   433

					existing = GetRoadBits(tile, rt);

   434

					RoadBits merged = existing | pieces;

   435

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

   436

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

   437

						/* Junctions cannot be one-way */

   438

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   439

					}

   440

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

   441

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

   442

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

   443

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   444

   445

							if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   446

   447

							/* Ignore half built tiles */

   448

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

   449

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

   450

								MarkTileDirtyByTile(tile);

   451

							}

   452

							return CommandCost();

   453

						}

   454

						return_cmd_error(STR_1007_ALREADY_BUILT);

   455

					}

   456

				} break;

   457

   458

				case ROAD_TILE_CROSSING:

   459

					if (HasTileRoadType(tile, rt)) return_cmd_error(STR_1007_ALREADY_BUILT);

   460

					all_bits = GetCrossingRoadBits(tile);

   461

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

   462

					break;

   463

   464

				default:

   465

				case ROAD_TILE_DEPOT:

   466

					goto do_clear;

   467

			}

   468

			break;

   469

   470

		case MP_RAILWAY: {

   471

			Axis roaddir;

   472

   473

			if (IsSteepSlope(tileh)) {

   474

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   475

			}

   476

   477

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

   478

			if (!HasBit(VALID_LEVEL_CROSSING_SLOPES, tileh)) {

   479

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   480

			}

   481

   482

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

   483

			switch (GetTrackBits(tile)) {