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"

    41

    42

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

    43

{

    44

	RoadBits present;

    45

	RoadBits n;

    46

	*edge_road = true;

    47

    48

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

    49

    50

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

    51

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

    52

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

    53

	if (_current_player == OWNER_WATER ||

    54

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

    55

    56

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

    57

	 * by a town */

    58

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

    59

    60

	if (_cheats.magic_bulldozer.value) return true;

    61

    62

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

    63

	n = ROAD_NONE;

    64

	present = GetAnyRoadBits(tile, rt);

    65

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

    66

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

    67

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

    68

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

    69

    70

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

    71

	 * then allow it */

    72

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

    73

		Town *t;

    74

		*edge_road = false;

    75

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

    76

		if (_patches.extra_dynamite) return true;

    77

    78

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

    79

    80

		SetDParam(0, t->index);

    81

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    82

		return false;

    83

	}

    84

    85

	return true;

    86

}

    87

    88

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

    89

{

    90

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

    91

}

    92

    93

/** Delete a piece of road.

    94

 * @param tile tile where to remove road from

    95

 * @param flags operation to perform

    96

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

    97

 *           bit 4..5 road type

    98

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

    99

 *                    yet when removing the road bits when not actually doing

   100

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

   101

 *                    be removed from a level crossing without physically

   102

 *                    removing the tram bits before the test.

   103

 * @param p2 unused

   104

 */

   105

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

   106

{

   107

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

   108

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

   109

   110

	/* true if the roadpiece was always removeable,

   111

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

   112

	bool edge_road;

   113

   114

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   115

   116

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

   117

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   118

   119

	Town *t = NULL;

   120

	switch (GetTileType(tile)) {

   121

		case MP_ROAD:

   122

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

   123

			break;

   124

   125

		case MP_STATION:

   126

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   127

			break;

   128

   129

		case MP_TUNNELBRIDGE:

   130

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

   131

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

   132

			break;

   133

   134

		default:

   135

			return CMD_ERROR;

   136

	}

   137

   138

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

   139

	RoadTypes rts = GetRoadTypes(tile);

   140

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

   141

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

   142

   143

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

   144

   145

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   146

   147

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

   148

	 * removal allowance depends on difficulty setting */

   149

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

   150

   151

	if (!IsTileType(tile, MP_ROAD)) {

   152

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

   153

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

   154

   155

		CommandCost cost;

   156

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   157

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

   158

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

   159

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

   160

			if (flags & DC_EXEC) {

   161

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

   162

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

   163

   164

				/* Mark tiles diry that have been repaved */

   165

				MarkTileDirtyByTile(tile);

   166

				MarkTileDirtyByTile(other_end);

   167

				if (IsBridge(tile)) {

   168

					TileIndexDiff delta = TileOffsByDiagDir(GetBridgeRampDirection(tile));

   169

   170

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

   171

				}

   172

			}

   173

		} else {

   174

			cost.AddCost(_price.remove_road);

   175

			if (flags & DC_EXEC) {

   176

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

   177

				MarkTileDirtyByTile(tile);

   178

			}

   179

		}

   180

		return CommandCost(cost);

   181

	}

   182

   183

	switch (GetRoadTileType(tile)) {

   184

		case ROAD_TILE_NORMAL: {

   185

			RoadBits present = GetRoadBits(tile, rt);

   186

			RoadBits c = pieces;

   187

   188

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

   189

   190

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

   191

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

   192

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

   193

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

   194

			}

   195

   196

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

   197

			c &= present;

   198

			if (c == ROAD_NONE) return CMD_ERROR;

   199

   200

			if (flags & DC_EXEC) {

   201

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

   202

   203

				present ^= c;

   204

				if (present == ROAD_NONE) {

   205

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

   206

					if (rts == ROADTYPES_NONE) {

   207

						/* Includes MarkTileDirtyByTile() */

   208

						DoClearSquare(tile);

   209

					} else {

   210

						SetRoadBits(tile, ROAD_NONE, rt);

   211

						SetRoadTypes(tile, rts);

   212

						MarkTileDirtyByTile(tile);

   213

					}

   214

				} else {

   215

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

   216

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

   217

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

   218

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

   219

					SetRoadBits(tile, present, rt);

   220

					MarkTileDirtyByTile(tile);

   221

				}

   222

			}

   223

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

   224

		}

   225

   226

		case ROAD_TILE_CROSSING: {

   227

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

   228

				return CMD_ERROR;

   229

			}

   230

   231

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

   232

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

   233

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

   234

   235

			if (flags & DC_EXEC) {

   236

				if (rt == ROADTYPE_ROAD) {

   237

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

   238

				}

   239

   240

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

   241

				if (rts == ROADTYPES_NONE) {

   242

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

   243

				} else {

   244

					SetRoadTypes(tile, rts);

   245

				}

   246

				MarkTileDirtyByTile(tile);

   247

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

   248

			}

   249

			return CommandCost(_price.remove_road * 2);

   250

		}

   251

   252

		default:

   253

		case ROAD_TILE_DEPOT:

   254

			return CMD_ERROR;

   255

	}

   256

}

   257

   258

   259

static const RoadBits _valid_tileh_slopes_road[][15] = {

   260

	/* set of normal ones */

   261

	{

   262

		ROAD_ALL, ROAD_NONE, ROAD_NONE,

   263

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

   264

		ROAD_Y,   ROAD_NONE, ROAD_NONE,

   265

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

   266

		ROAD_X,   ROAD_NONE, ROAD_NONE

   267

	},

   268

	/* allowed road for an evenly raised platform */

   269

	{

   270

		ROAD_NONE,

   271

		ROAD_SW | ROAD_NW,

   272

		ROAD_SW | ROAD_SE,

   273

		ROAD_Y  | ROAD_SW,

   274

   275

		ROAD_SE | ROAD_NE, // 4

   276

		ROAD_ALL,

   277

		ROAD_X  | ROAD_SE,

   278

		ROAD_ALL,

   279

   280

		ROAD_NW | ROAD_NE, // 8

   281

		ROAD_X  | ROAD_NW,

   282

		ROAD_ALL,

   283

		ROAD_ALL,

   284

   285

		ROAD_Y  | ROAD_NE, // 12

   286

		ROAD_ALL,

   287

		ROAD_ALL

   288

	},

   289

};

   290

   291

   292

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

   293

{

   294

	RoadBits road_bits;

   295

   296

	if (IsSteepSlope(tileh)) {

   297

		/* force full pieces. */

   298

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

   299

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

   300

   301

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

   302

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

   303

		}

   304

		return CMD_ERROR;

   305

	}

   306

	road_bits = *pieces | existing;

   307

   308

	/* no special foundation */

   309

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

   310

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

   311

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

   312

		return CommandCost(); // no extra cost

   313

	}

   314

   315

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

   316

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

   317

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

   318

	}

   319

   320

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

   321

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

   322

   323

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

   324

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

   325

		/* force full pieces. */

   326

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

   327

	}

   328

	return CMD_ERROR;

   329

}

   330

   331

/** Build a piece of road.

   332

 * @param tile tile where to build road

   333

 * @param flags operation to perform

   334

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

   335

 *           bit 4..5 road type

   336

 *           bit 6..7 disallowed directions to toggle

   337

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

   338

 */

   339

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

   340

{

   341

	CommandCost cost;

   342

	CommandCost ret;

   343

	RoadBits existing = ROAD_NONE;

   344

	RoadBits all_bits = ROAD_NONE;

   345

	Slope tileh;

   346

   347

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   348

   349

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

   350

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

   351

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

   352

   353

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

   354

   355

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

   356

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   357

   358

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

   359

   360

	tileh = GetTileSlope(tile, NULL);

   361

   362

	switch (GetTileType(tile)) {

   363

		case MP_ROAD:

   364

			switch (GetRoadTileType(tile)) {

   365

				case ROAD_TILE_NORMAL: {

   366

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

   367

					if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   368

   369

					all_bits = GetAllRoadBits(tile);

   370

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

   371

   372

					existing = GetRoadBits(tile, rt);

   373

					RoadBits merged = existing | pieces;

   374

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

   375

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

   376

						/* Junctions cannot be one-way */

   377

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   378

					}

   379

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

   380

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

   381

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

   382

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   383

   384

							/* Ignore half built tiles */

   385

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

   386

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

   387

								MarkTileDirtyByTile(tile);

   388

							}

   389

							return CommandCost();

   390

						}

   391

						return_cmd_error(STR_1007_ALREADY_BUILT);

   392

					}

   393

				} break;

   394

   395

				case ROAD_TILE_CROSSING:

   396

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

   397

					all_bits = GetCrossingRoadBits(tile);

   398

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

   399

					break;

   400

   401

				default:

   402

				case ROAD_TILE_DEPOT:

   403

					goto do_clear;

   404

			}

   405

			break;

   406

   407

		case MP_RAILWAY: {

   408

			Axis roaddir;

   409

   410

			if (IsSteepSlope(tileh)) {

   411

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   412

			}

   413

   414

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

   416

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   417

			}

   418

   419

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

   420

			switch (GetTrackBits(tile)) {

   421

				case TRACK_BIT_X:

   422

					if (pieces & ROAD_X) goto do_clear;

   423

					roaddir = AXIS_Y;

   424

					break;

   425

   426

				case TRACK_BIT_Y:

   427

					if (pieces & ROAD_Y) goto do_clear;

   428

					roaddir = AXIS_X;

   429

					break;

   430

   431

				default: goto do_clear;

   432

			}

   433

   434

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   435

   436

			if (flags & DC_EXEC) {

   437

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

   438

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

   439

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

   440

				MarkTileDirtyByTile(tile);

   441

			}

   442

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

   443

		}

   444

   445

		case MP_STATION:

   446

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   447

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

   448

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

   449

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   450

			break;

   451

   452

		case MP_TUNNELBRIDGE:

   453

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

   454

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

   455

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

   456

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

   457

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   458

			break;

   459

   460

		default:

   461

do_clear:;

   462

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

   463

			if (CmdFailed(ret)) return ret;

   464

			cost.AddCost(ret);

   465

	}

   466

   467

	if (all_bits != pieces) {

   468

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

   469

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

   470

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

   471

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

   472

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

   473

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   474

		}

   475

		cost.AddCost(ret);

   476

	}

   477

   478

	if (IsTileType(tile, MP_ROAD)) {

   479

		/* Don't put the pieces that already exist */

   480

		pieces &= ComplementRoadBits(existing);

   481

	}

   482

   483

	cost.AddCost(COUNTBITS(pieces) * _price.build_road);