1

/* $Id$ */

     2

     3

/** @file tunnelbridge_cmd.c

     4

 * This file deals with tunnels and bridges (non-gui stuff)

     5

 * @todo seperate this file into two

     6

 */

     7

     8

#include "stdafx.h"

     9

#include "openttd.h"

    10

#include "bridge_map.h"

    11

#include "rail_map.h"

    12

#include "road_map.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "functions.h"

    16

#include "map.h"

    17

#include "tile.h"

    18

#include "tunnel_map.h"

    19

#include "unmovable_map.h"

    20

#include "vehicle.h"

    21

#include "viewport.h"

    22

#include "command.h"

    23

#include "player.h"

    24

#include "town.h"

    25

#include "sound.h"

    26

#include "variables.h"

    27

#include "bridge.h"

    28

#include "train.h"

    29

#include "water_map.h"

    30

#include "yapf/yapf.h"

    31

#include "date.h"

    32

#include "newgrf_sound.h"

    33

    34

#include "table/bridge_land.h"

    35

    36

/** Build Tunnel.

    37

 * @param tile start tile of tunnel

    38

 * @param p1 railtype, 0x200 for road tunnel

    39

 * @param p2 unused

    40

 */

    41

int32 CmdBuildTunnel(TileIndex start_tile, uint32 flags, uint32 p1, uint32 p2)

    42

{

    43

	TileIndexDiff delta;

    44

	TileIndex end_tile;

    45

	DiagDirection direction;

    46

	Slope start_tileh;

    47

	Slope end_tileh;

    48

	uint start_z;

    49

	uint end_z;

    50

	int32 cost;

    51

	int32 ret;

    52

    53

	_build_tunnel_endtile = 0;

    54

    55

	if (p1 != 0x200 && !ValParamRailtype(p1)) return CMD_ERROR;

    56

    57

	start_tileh = GetTileSlope(start_tile, &start_z);

    58

    59

	switch (start_tileh) {

    60

		case SLOPE_SW: direction = DIAGDIR_SW; break;

    61

		case SLOPE_SE: direction = DIAGDIR_SE; break;

    62

		case SLOPE_NW: direction = DIAGDIR_NW; break;

    63

		case SLOPE_NE: direction = DIAGDIR_NE; break;

    64

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

    65

	}

    66

    67

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

    68

	if (CmdFailed(ret)) return ret;

    69

    70

	/* XXX - do NOT change 'ret' in the loop, as it is used as the price

    71

	 * for the clearing of the entrance of the tunnel. Assigning it to

    72

	 * cost before the loop will yield different costs depending on start-

    73

	 * position, because of increased-cost-by-length: 'cost += cost >> 3' */

    74

	cost = 0;

    75

	delta = TileOffsByDiagDir(direction);

    76

	end_tile = start_tile;

    77

	for (;;) {

    78

		end_tile += delta;

    79

		end_tileh = GetTileSlope(end_tile, &end_z);

    80

    81

		if (start_z == end_z) break;

    82

    83

		if (!_cheats.crossing_tunnels.value && IsTunnelInWay(end_tile, start_z)) {

    84

			return_cmd_error(STR_5003_ANOTHER_TUNNEL_IN_THE_WAY);

    85

		}

    86

    87

		cost += _price.build_tunnel;

    88

		cost += cost >> 3; // add a multiplier for longer tunnels

    89

		if (cost >= 400000000) cost = 400000000;

    90

	}

    91

    92

	/* Add the cost of the entrance */

    93

	cost += _price.build_tunnel + ret;

    94

    95

	// if the command fails from here on we want the end tile to be highlighted

    96

	_build_tunnel_endtile = end_tile;

    97

    98

	// slope of end tile must be complementary to the slope of the start tile

    99

	if (end_tileh != ComplementSlope(start_tileh)) {

   100

		ret = DoCommand(end_tile, end_tileh & start_tileh, 0, flags, CMD_TERRAFORM_LAND);

   101

		if (CmdFailed(ret)) return_cmd_error(STR_5005_UNABLE_TO_EXCAVATE_LAND);

   102

	} else {

   103

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

   104

		if (CmdFailed(ret)) return ret;

   105

	}

   106

	cost += _price.build_tunnel + ret;

   107

   108

	if (flags & DC_EXEC) {

   109

		if (GB(p1, 9, 1) == TRANSPORT_RAIL) {

   110

			MakeRailTunnel(start_tile, _current_player, direction,                 GB(p1, 0, 4));

   111

			MakeRailTunnel(end_tile,   _current_player, ReverseDiagDir(direction), GB(p1, 0, 4));

   112

			UpdateSignalsOnSegment(start_tile, direction);

   113

			YapfNotifyTrackLayoutChange(start_tile, AxisToTrack(DiagDirToAxis(direction)));

   114

		} else {

   115

			MakeRoadTunnel(start_tile, _current_player, direction);

   116

			MakeRoadTunnel(end_tile,   _current_player, ReverseDiagDir(direction));

   117

		}

   118

	}

   119

   120

	return cost;

   121

}

   122

   123

TileIndex CheckTunnelBusy(TileIndex tile, uint *length)

   124

{

   125

	uint z = GetTileZ(tile);

   126

	DiagDirection dir = GetTunnelDirection(tile);

   127

	TileIndexDiff delta = TileOffsByDiagDir(dir);

   128

	uint len = 0;

   129

	TileIndex starttile = tile;

   130

	Vehicle *v;

   131

   132

	do {

   133

		tile += delta;

   134

		len++;

   135

	} while (

   136

		!IsTunnelTile(tile) ||

   137

		ReverseDiagDir(GetTunnelDirection(tile)) != dir ||

   138

		GetTileZ(tile) != z

   139

	);

   140

   141

	v = FindVehicleBetween(starttile, tile, z);

   142

	if (v != NULL) {

   143

		_error_message = v->type == VEH_Train ?

   144

			STR_5000_TRAIN_IN_TUNNEL : STR_5001_ROAD_VEHICLE_IN_TUNNEL;

   145

		return INVALID_TILE;

   146

	}

   147

   148

	if (length != NULL) *length = len;

   149

	return tile;

   150

}

   151

   152

static inline bool CheckAllowRemoveTunnel(TileIndex tile)

   153

{

   154

	/* Floods can remove anything as well as the scenario editor */

   155

	if (_current_player == OWNER_WATER || _game_mode == GM_EDITOR) return true;

   156

	/* Obviously if the bridge/tunnel belongs to us, or no-one, we can remove it */

   157

	if (CheckTileOwnership(tile) || IsTileOwner(tile, OWNER_NONE)) return true;

   158

	/* Otherwise we can only remove town-owned stuff with extra patch-settings, or cheat */

   159

	if (IsTileOwner(tile, OWNER_TOWN) && (_patches.extra_dynamite || _cheats.magic_bulldozer.value)) return true;

   160

	return false;

   161

}

   162

   163

static int32 DoClearTunnel(TileIndex tile, uint32 flags)

   164

{

   165

	Town *t = NULL;

   166

	TileIndex endtile;

   167

	uint length;

   168

   169

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   170

   171

	if (!CheckAllowRemoveTunnel(tile)) return CMD_ERROR;

   172

   173

	endtile = CheckTunnelBusy(tile, &length);

   174

	if (endtile == INVALID_TILE) return CMD_ERROR;

   175

   176

	_build_tunnel_endtile = endtile;

   177

   178

	if (IsTileOwner(tile, OWNER_TOWN) && _game_mode != GM_EDITOR) {

   179

		t = ClosestTownFromTile(tile, (uint)-1); // town penalty rating

   180

   181

		/* Check if you are allowed to remove the tunnel owned by a town

   182

		 * Removal depends on difficulty settings */

   183

		if (!CheckforTownRating(flags, t, TUNNELBRIDGE_REMOVE)) {

   184

			SetDParam(0, t->index);

   185

			return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   186

		}

   187

	}

   188

   189

	if (flags & DC_EXEC) {

   190

		// We first need to request the direction before calling DoClearSquare

   191

		//  else the direction is always 0.. dah!! ;)

   192

		DiagDirection dir = GetTunnelDirection(tile);

   193

		Track track;

   194

   195

		// Adjust the town's player rating. Do this before removing the tile owner info.

   196

		if (IsTileOwner(tile, OWNER_TOWN) && _game_mode != GM_EDITOR)

   197

			ChangeTownRating(t, RATING_TUNNEL_BRIDGE_DOWN_STEP, RATING_TUNNEL_BRIDGE_MINIMUM);

   198

   199

		DoClearSquare(tile);

   200

		DoClearSquare(endtile);

   201

		UpdateSignalsOnSegment(tile, ReverseDiagDir(dir));

   202

		UpdateSignalsOnSegment(endtile, dir);

   203

		track = AxisToTrack(DiagDirToAxis(dir));

   204

		YapfNotifyTrackLayoutChange(tile, track);

   205

		YapfNotifyTrackLayoutChange(endtile, track);

   206

	}

   207

	return _price.clear_tunnel * (length + 1);

   208

}

   209

   210

   211

   212

static int32 ClearTile_Tunnel(TileIndex tile, byte flags)

   213

{

   214

	assert(IsTunnelTile(tile));

   215

	if (flags & DC_AUTO) return_cmd_error(STR_5006_MUST_DEMOLISH_TUNNEL_FIRST);

   216

	return DoClearTunnel(tile, flags);

   217

}

   218

   219

   220

int32 DoConvertTunnelRail(TileIndex tile, RailType totype, bool exec)

   221

{

   222

	TileIndex endtile;

   223

   224

	if (GetTunnelTransportType(tile) == TRANSPORT_RAIL) {

   225

		uint length;

   226

   227

		if (!CheckTileOwnership(tile)) return CMD_ERROR;

   228

   229

		if (GetRailType(tile) == totype) return CMD_ERROR;

   230

   231

		// 'hidden' elrails can't be downgraded to normal rail when elrails are disabled

   232

		if (_patches.disable_elrails && totype == RAILTYPE_RAIL && GetRailType(tile) == RAILTYPE_ELECTRIC) return CMD_ERROR;

   233

   234

		endtile = CheckTunnelBusy(tile, &length);

   235

		if (endtile == INVALID_TILE) return CMD_ERROR;

   236

   237

		if (exec) {

   238

			Track track;

   239

			SetRailType(tile, totype);

   240

			SetRailType(endtile, totype);

   241

			MarkTileDirtyByTile(tile);

   242

			MarkTileDirtyByTile(endtile);

   243

   244

			track = AxisToTrack(DiagDirToAxis(GetTunnelDirection(tile)));

   245

			YapfNotifyTrackLayoutChange(tile, track);

   246

			YapfNotifyTrackLayoutChange(endtile, track);

   247

		}

   248

		return (length + 1) * (_price.build_rail >> 1);

   249

	} else {

   250

		return CMD_ERROR;

   251

	}

   252

}

   253

   254

/**

   255

 * Draws a tunnel tile.

   256

 * Please note that in this code, "roads" are treated as railtype 1, whilst the real railtypes are 0, 2 and 3

   257

 */

   258

static void DrawTile_Tunnel(TileInfo *ti)

   259

{

   260

	uint32 image;

   261

   262

	if (GetTunnelTransportType(ti->tile) == TRANSPORT_RAIL) {

   263

		image = GetRailTypeInfo(GetRailType(ti->tile))->base_sprites.tunnel;

   264

	} else {

   265

		image = SPR_TUNNEL_ENTRY_REAR_ROAD;

   266

	}

   267

   268

	if (HasTunnelSnowOrDesert(ti->tile)) image += 32;

   269

   270

	image += GetTunnelDirection(ti->tile) * 2;

   271

	DrawGroundSprite(image);

   272

	if (GetRailType(ti->tile) == RAILTYPE_ELECTRIC) DrawCatenary(ti);

   273

   274

	AddSortableSpriteToDraw(image+1, ti->x + TILE_SIZE - 1, ti->y + TILE_SIZE - 1, 1, 1, 8, (byte)ti->z);

   275

	DrawBridgeMiddle(ti);

   276

}

   277

   278

   279

/** Gets the absolute z coordinate of a point inside a tunnel tile

   280

 *  When we're on the track (that means between position 5 and 10)

   281

 *  on the coordinate perpendicular to the track it returns only the

   282

 *  base height of the tile (because the track is horizontal).

   283

 *  Outside this range (from 0 to 4 and from 11 to 15) it returns the

   284

 *  "true" Z coordinate of the tile by taking the slope into account

   285

 *  @param tile The index of the tile we are talking about

   286

 *  @param x Absolute or relative x coordinate

   287

 *  @param y Absolute or relative y coordinate

   288

 *  @return Absolute z coordinate

   289

 */

   290

static uint GetSlopeZ_Tunnel(TileIndex tile, uint x, uint y)

   291

{

   292

	uint z, pos;

   293

	Slope tileh = GetTileSlope(tile, &z);

   294

   295

	x &= 0xF;

   296

	y &= 0xF;

   297

   298

	pos = (DiagDirToAxis(GetTunnelDirection(tile)) == AXIS_X ? y : x);

   299

   300

	// In the tunnel entrance?

   301

	if (5 <= pos && pos <= 10) return z;

   302

   303

	return z + GetPartialZ(x, y, tileh);

   304

}

   305

   306

   307

static Slope GetSlopeTileh_Tunnel(TileIndex tile, Slope tileh)

   308

{

   309

	return tileh;

   310

}

   311

   312

   313

static void GetAcceptedCargo_Tunnel(TileIndex tile, AcceptedCargo ac)

   314

{

   315

	/* not used */

   316

}

   317

   318

static void GetTileDesc_Tunnel(TileIndex tile, TileDesc *td)

   319

{

   320

	td->str = (GetTunnelTransportType(tile) == TRANSPORT_RAIL) ?  STR_5017_RAILROAD_TUNNEL : STR_5018_ROAD_TUNNEL;

   321

	td->owner = GetTileOwner(tile);

   322

}

   323

   324

static void AnimateTile_Tunnel(TileIndex tile)

   325

{

   326

	/* not used */

   327

}

   328

   329

static void TileLoop_Tunnel(TileIndex tile)

   330

{

   331

	bool snow_or_desert = HasTunnelSnowOrDesert(tile);

   332

	switch (_opt.landscape) {

   333

		case LT_HILLY:

   334

			if (snow_or_desert != (GetTileZ(tile) > _opt.snow_line)) {

   335

				SetTunnelSnowOrDesert(tile, !snow_or_desert);

   336

				MarkTileDirtyByTile(tile);

   337

			}

   338

			break;

   339

   340

		case LT_DESERT:

   341

			if (GetTropicZone(tile) == TROPICZONE_DESERT && !snow_or_desert) {

   342

				SetTunnelSnowOrDesert(tile, true);

   343

				MarkTileDirtyByTile(tile);

   344

			}

   345

			break;

   346

	}

   347

}

   348

   349

   350

static void ClickTile_Tunnel(TileIndex tile)

   351

{

   352

	/* not used */

   353

}

   354

   355

static uint32 GetTileTrackStatus_Tunnel(TileIndex tile, TransportType mode)

   356

{

   357

	if (GetTunnelTransportType(tile) != mode) return 0;

   358

	return AxisToTrackBits(DiagDirToAxis(GetTunnelDirection(tile))) * 0x101;

   359

}

   360

   361

static void ChangeTileOwner_Tunnel(TileIndex tile, PlayerID old_player, PlayerID new_player)

   362

{

   363

	if (!IsTileOwner(tile, old_player)) return;

   364

   365

	if (new_player != PLAYER_SPECTATOR) {

   366

		SetTileOwner(tile, new_player);

   367

	} else {

   368

		DoCommand(tile, 0, 0, DC_EXEC, CMD_LANDSCAPE_CLEAR);

   369

	}

   370

}

   371

   372

   373

static const byte _tunnel_fractcoord_1[4]    = {0x8E, 0x18, 0x81, 0xE8};

   374

static const byte _tunnel_fractcoord_2[4]    = {0x81, 0x98, 0x87, 0x38};

   375

static const byte _tunnel_fractcoord_3[4]    = {0x82, 0x88, 0x86, 0x48};

   376

static const byte _exit_tunnel_track[4]      = {1, 2, 1, 2};

   377

   378

static const byte _road_exit_tunnel_state[4] = {8, 9, 0, 1};

   379

static const byte _road_exit_tunnel_frame[4] = {2, 7, 9, 4};

   380

   381

static const byte _tunnel_fractcoord_4[4]    = {0x52, 0x85, 0x98, 0x29};

   382

static const byte _tunnel_fractcoord_5[4]    = {0x92, 0x89, 0x58, 0x25};

   383

static const byte _tunnel_fractcoord_6[4]    = {0x92, 0x89, 0x56, 0x45};

   384

static const byte _tunnel_fractcoord_7[4]    = {0x52, 0x85, 0x96, 0x49};

   385

   386

static uint32 VehicleEnter_Tunnel(Vehicle *v, TileIndex tile, int x, int y)

   387

{

   388

	int z = GetSlopeZ(x, y) - v->z_pos;

   389

   390

	byte fc;

   391

	DiagDirection dir;

   392

	DiagDirection vdir;

   393

   394

	if (myabs(z) > 2) return 8;

   395

   396

	if (v->type == VEH_Train) {

   397

		fc = (x & 0xF) + (y << 4);

   398

   399

		dir = GetTunnelDirection(tile);

   400

		vdir = DirToDiagDir(v->direction);

   401

   402

		if (v->u.rail.track != 0x40 && dir == vdir) {

   403

			if (IsFrontEngine(v) && fc == _tunnel_fractcoord_1[dir]) {

   404

				if (!PlayVehicleSound(v, VSE_TUNNEL) && v->spritenum < 4) {

   405

					SndPlayVehicleFx(SND_05_TRAIN_THROUGH_TUNNEL, v);

   406

				}

   407

				return 0;

   408

			}

   409

			if (fc == _tunnel_fractcoord_2[dir]) {

   410

				v->tile = tile;

   411

				v->u.rail.track = 0x40;

   412

				v->vehstatus |= VS_HIDDEN;

   413

				return 4;

   414

			}

   415

		}

   416

   417

		if (dir == ReverseDiagDir(vdir) && fc == _tunnel_fractcoord_3[dir] && z == 0) {

   418

			/* We're at the tunnel exit ?? */

   419

			v->tile = tile;

   420

			v->u.rail.track = _exit_tunnel_track[dir];

   421

			assert(v->u.rail.track);

   422

			v->vehstatus &= ~VS_HIDDEN;

   423

			return 4;

   424

		}

   425

	} else if (v->type == VEH_Road) {

   426

		fc = (x & 0xF) + (y << 4);

   427

		dir = GetTunnelDirection(tile);

   428

		vdir = DirToDiagDir(v->direction);

   429

   430

		// Enter tunnel?

   431

		if (v->u.road.state != 0xFF && dir == vdir) {

   432

			if (fc == _tunnel_fractcoord_4[dir] ||

   433

					fc == _tunnel_fractcoord_5[dir]) {

   434

				v->tile = tile;

   435

				v->u.road.state = 0xFF;

   436

				v->vehstatus |= VS_HIDDEN;

   437

				return 4;

   438

			} else {

   439

				return 0;

   440

			}

   441

		}

   442

   443

		if (dir == ReverseDiagDir(vdir) && (

   444

					/* We're at the tunnel exit ?? */

   445

					fc == _tunnel_fractcoord_6[dir] ||

   446

					fc == _tunnel_fractcoord_7[dir]

   447

				) &&

   448

				z == 0) {

   449

			v->tile = tile;

   450

			v->u.road.state = _road_exit_tunnel_state[dir];

   451

			v->u.road.frame = _road_exit_tunnel_frame[dir];

   452

			v->vehstatus &= ~VS_HIDDEN;

   453

			return 4;

   454

		}

   455

	}

   456

	return 0;

   457

}

   458

   459

   460

const TileTypeProcs _tile_type_tunnel_procs = {

   461

	DrawTile_Tunnel,           /* draw_tile_proc */

   462

	GetSlopeZ_Tunnel,          /* get_slope_z_proc */

   463

	ClearTile_Tunnel,          /* clear_tile_proc */

   464

	GetAcceptedCargo_Tunnel,   /* get_accepted_cargo_proc */

   465

	GetTileDesc_Tunnel,        /* get_tile_desc_proc */

   466

	GetTileTrackStatus_Tunnel, /* get_tile_track_status_proc */

   467

	ClickTile_Tunnel,          /* click_tile_proc */

   468

	AnimateTile_Tunnel,        /* animate_tile_proc */

   469

	TileLoop_Tunnel,           /* tile_loop_clear */

   470

	ChangeTileOwner_Tunnel,    /* change_tile_owner_clear */

   471

	NULL,                            /* get_produced_cargo_proc */

   472

	VehicleEnter_Tunnel,       /* vehicle_enter_tile_proc */

   473

	GetSlopeTileh_Tunnel,      /* get_slope_tileh_proc */

   474

};

   475