1

/* $Id$ */

     2

     3

/** @file town_cmd.cpp Handling of town tiles. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "tile_cmd.h"

     8

#include "debug.h"

     9

#include "road_map.h"

    10

#include "road_internal.h" /* Cleaning up road bits */

    11

#include "road_cmd.h"

    12

#include "landscape.h"

    13

#include "town_map.h"

    14

#include "tunnel_map.h"

    15

#include "viewport_func.h"

    16

#include "town.h"

    17

#include "command_func.h"

    18

#include "industry.h"

    19

#include "station_base.h"

    20

#include "company_base.h"

    21

#include "news_func.h"

    22

#include "saveload.h"

    23

#include "gui.h"

    24

#include "unmovable_map.h"

    25

#include "water_map.h"

    26

#include "variables.h"

    27

#include "bridge.h"

    28

#include "bridge_map.h"

    29

#include "genworld.h"

    30

#include "newgrf.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_house.h"

    33

#include "newgrf_commons.h"

    34

#include "newgrf_townname.h"

    35

#include "autoslope.h"

    36

#include "waypoint.h"

    37

#include "transparency.h"

    38

#include "tunnelbridge_map.h"

    39

#include "strings_func.h"

    40

#include "window_func.h"

    41

#include "string_func.h"

    42

#include "newgrf_cargo.h"

    43

#include "oldpool_func.h"

    44

#include "sprite.h"

    45

#include "economy_func.h"

    46

#include "station_func.h"

    47

#include "cheat_func.h"

    48

#include "functions.h"

    49

#include "animated_tile_func.h"

    50

#include "date_func.h"

    51

#include <map>

    52

    53

#include "table/strings.h"

    54

#include "table/sprites.h"

    55

#include "table/town_land.h"

    56

    57

uint _total_towns;

    58

HouseSpec _house_specs[HOUSE_MAX];

    59

    60

Town *_cleared_town;

    61

int _cleared_town_rating;

    62

    63

/* Initialize the town-pool */

    64

DEFINE_OLD_POOL_GENERIC(Town, Town)

    65

    66

Town::Town(TileIndex tile)

    67

{

    68

	if (tile != 0) _total_towns++;

    69

	this->xy = tile;

    70

}

    71

    72

Town::~Town()

    73

{

    74

	free(this->name);

    75

    76

	if (CleaningPool()) return;

    77

    78

	Industry *i;

    79

    80

	/* Delete town authority window

    81

	 * and remove from list of sorted towns */

    82

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    83

	InvalidateWindowData(WC_TOWN_DIRECTORY, 0, 0);

    84

	_total_towns--;

    85

    86

	/* Delete all industries belonging to the town */

    87

	FOR_ALL_INDUSTRIES(i) if (i->town == this) delete i;

    88

    89

	/* Go through all tiles and delete those belonging to the town */

    90

	for (TileIndex tile = 0; tile < MapSize(); ++tile) {

    91

		switch (GetTileType(tile)) {

    92

			case MP_HOUSE:

    93

				if (GetTownByTile(tile) == this) DoCommand(tile, 0, 0, DC_EXEC, CMD_LANDSCAPE_CLEAR);

    94

				break;

    95

    96

			case MP_ROAD:

    97

				if (!IsRoadOwner(tile, ROADTYPE_ROAD, OWNER_TOWN) && GetTownIndex(tile) == this->index) {

    98

					/* Town-owned roads get cleared soon, anyway */

    99

					SetTownIndex(tile, (TownID)INVALID_TOWN);

   100

					break;

   101

				}

   102

				/* Fall-through */

   103

			case MP_TUNNELBRIDGE:

   104

				if (IsTileOwner(tile, OWNER_TOWN) &&

   105

						ClosestTownFromTile(tile, UINT_MAX) == this)

   106

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

   107

				break;

   108

   109

			default:

   110

				break;

   111

		}

   112

	}

   113

   114

	DeleteSubsidyWithTown(this->index);

   115

   116

	MarkWholeScreenDirty();

   117

   118

	this->xy = 0;

   119

}

   120

   121

/**

   122

 * Generate a random town road layout.

   123

 *

   124

 * The layout is based on the TileHash.

   125

 */

   126

void Town::InitializeLayout()

   127

{

   128

	this->layout = (TownLayout)(TileHash(TileX(this->xy), TileY(this->xy)) % NUM_TLS);

   129

   130

	/* Set invalid layouts to valid ones */

   131

	switch (this->layout) {

   132

		default: break;

   133

		case TL_RANDOM: this->layout = TL_ORIGINAL; break;

   134

		case TL_NO_ROADS: this->layout = TL_BETTER_ROADS; break;

   135

	}

   136

}

   137

   138

Money HouseSpec::GetRemovalCost() const

   139

{

   140

	return (_price.remove_house * this->removal_cost) >> 8;

   141

}

   142

   143

// Local

   144

static int _grow_town_result;

   145

   146

/* Describe the possible states */

   147

enum TownGrowthResult {

   148

	GROWTH_SUCCEED         = -1,

   149

	GROWTH_SEARCH_STOPPED  =  0

   150

//	GROWTH_SEARCH_RUNNING >=  1

   151

};

   152

   153

static bool BuildTownHouse(Town *t, TileIndex tile);

   154

   155

static void TownDrawHouseLift(const TileInfo *ti)

   156

{

   157

	AddChildSpriteScreen(SPR_LIFT, PAL_NONE, 14, 60 - GetLiftPosition(ti->tile));

   158

}

   159

   160

typedef void TownDrawTileProc(const TileInfo *ti);

   161

static TownDrawTileProc *const _town_draw_tile_procs[1] = {

   162

	TownDrawHouseLift

   163

};

   164

   165

/**

   166

 * Return a random direction

   167

 *

   168

 * @return a random direction

   169

 */

   170

static inline DiagDirection RandomDiagDir()

   171

{

   172

	return (DiagDirection)(3 & Random());

   173

}

   174

   175

/**

   176

 * House Tile drawing handler.

   177

 * Part of the tile loop process

   178

 * @param ti TileInfo of the tile to draw

   179

 */

   180

static void DrawTile_Town(TileInfo *ti)

   181

{

   182

	HouseID house_id = GetHouseType(ti->tile);

   183

   184

	if (house_id >= NEW_HOUSE_OFFSET) {

   185

		/* Houses don't necessarily need new graphics. If they don't have a

   186

		 * spritegroup associated with them, then the sprite for the substitute

   187

		 * house id is drawn instead. */

   188

		if (GetHouseSpecs(house_id)->spritegroup != NULL) {

   189

			DrawNewHouseTile(ti, house_id);

   190

			return;

   191

		} else {

   192

			house_id = GetHouseSpecs(house_id)->substitute_id;

   193

		}

   194

	}

   195

   196

	/* Retrieve pointer to the draw town tile struct */

   197

	const DrawBuildingsTileStruct *dcts = &_town_draw_tile_data[house_id << 4 | TileHash2Bit(ti->x, ti->y) << 2 | GetHouseBuildingStage(ti->tile)];

   198

   199

	if (ti->tileh != SLOPE_FLAT) DrawFoundation(ti, FOUNDATION_LEVELED);

   200

   201

	DrawGroundSprite(dcts->ground.sprite, dcts->ground.pal);

   202

   203

	/* If houses are invisible, do not draw the upper part */

   204

	if (IsInvisibilitySet(TO_HOUSES)) return;

   205

   206

	/* Add a house on top of the ground? */

   207

	SpriteID image = dcts->building.sprite;

   208

	if (image != 0) {

   209

		AddSortableSpriteToDraw(image, dcts->building.pal,

   210

			ti->x + dcts->subtile_x,

   211

			ti->y + dcts->subtile_y,

   212

			dcts->width,

   213

			dcts->height,

   214

			dcts->dz,

   215

			ti->z,

   216

			IsTransparencySet(TO_HOUSES)

   217

		);

   218

   219

		if (IsTransparencySet(TO_HOUSES)) return;

   220

	}

   221

   222

	{

   223

		int proc = dcts->draw_proc - 1;

   224

   225

		if (proc >= 0) _town_draw_tile_procs[proc](ti);

   226

	}

   227

}

   228

   229

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

   230

{

   231

	return GetTileMaxZ(tile);

   232

}

   233

   234

/** Tile callback routine */

   235

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   236

{

   237

	return FlatteningFoundation(tileh);

   238

}

   239

   240

/**

   241

 * Animate a tile for a town

   242

 * Only certain houses can be animated

   243

 * The newhouses animation superseeds regular ones

   244

 * @param tile TileIndex of the house to animate

   245

 */

   246

static void AnimateTile_Town(TileIndex tile)

   247

{

   248

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   249

		AnimateNewHouseTile(tile);

   250

		return;

   251

	}

   252

   253

	if (_tick_counter & 3) return;

   254

   255

	/* If the house is not one with a lift anymore, then stop this animating.

   256

	 * Not exactly sure when this happens, but probably when a house changes.

   257

	 * Before this was just a return...so it'd leak animated tiles..

   258

	 * That bug seems to have been here since day 1?? */

   259

	if (!(GetHouseSpecs(GetHouseType(tile))->building_flags & BUILDING_IS_ANIMATED)) {

   260

		DeleteAnimatedTile(tile);

   261

		return;

   262

	}

   263

   264

	if (!LiftHasDestination(tile)) {

   265

		uint i;

   266

   267

		/* Building has 6 floors, number 0 .. 6, where 1 is illegal.

   268

		 * This is due to the fact that the first floor is, in the graphics,

   269

		 *  the height of 2 'normal' floors.

   270

		 * Furthermore, there are 6 lift positions from floor N (incl) to floor N + 1 (excl) */

   271

		do {

   272

			i = RandomRange(7);

   273

		} while (i == 1 || i * 6 == GetLiftPosition(tile));

   274

   275

		SetLiftDestination(tile, i);

   276

	}

   277

   278

	int pos = GetLiftPosition(tile);

   279

	int dest = GetLiftDestination(tile) * 6;

   280

	pos += (pos < dest) ? 1 : -1;

   281

	SetLiftPosition(tile, pos);

   282

   283

	if (pos == dest) {

   284

		HaltLift(tile);

   285

		DeleteAnimatedTile(tile);

   286

	}

   287

   288

	MarkTileDirtyByTile(tile);

   289

}

   290

   291

/**

   292

 * Determines if a town is close to a tile

   293

 * @param tile TileIndex of the tile to query

   294

 * @param dist maximum distance to be accepted

   295

 * @returns true if the tile correspond to the distance criteria

   296

 */

   297

static bool IsCloseToTown(TileIndex tile, uint dist)

   298

{

   299

	const Town *t;

   300

   301

	FOR_ALL_TOWNS(t) {

   302

		if (DistanceManhattan(tile, t->xy) < dist) return true;

   303

	}

   304

	return false;

   305

}

   306

   307

/**

   308

 * Marks the town sign as needing a repaint.

   309

 *

   310

 * This function marks the area of the sign of a town as dirty for repaint.

   311

 *

   312

 * @param t Town requesting town sign for repaint

   313

 * @ingroup dirty

   314

 */

   315

static void MarkTownSignDirty(Town *t)

   316

{

   317

	MarkAllViewportsDirty(

   318

		t->sign.left - 6,

   319

		t->sign.top - 3,

   320

		t->sign.left + t->sign.width_1 * 4 + 12,

   321

		t->sign.top + 45

   322

	);

   323

}

   324

   325

/**

   326

 * Resize the sign(label) of the town after changes in

   327

 * population (creation or growth or else)

   328

 * @param t Town to update

   329

 */

   330

void UpdateTownVirtCoord(Town *t)

   331

{

   332

	MarkTownSignDirty(t);

   333

	Point pt = RemapCoords2(TileX(t->xy) * TILE_SIZE, TileY(t->xy) * TILE_SIZE);

   334

	SetDParam(0, t->index);

   335

	SetDParam(1, t->population);

   336

	UpdateViewportSignPos(&t->sign, pt.x, pt.y - 24,

   337

		_settings_client.gui.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   338

	MarkTownSignDirty(t);

   339

}

   340

   341

/** Update the virtual coords needed to draw the town sign for all towns. */

   342

void UpdateAllTownVirtCoords()

   343

{

   344

	Town *t;

   345

	FOR_ALL_TOWNS(t) {

   346

		UpdateTownVirtCoord(t);

   347

	}

   348

}

   349

   350

/**

   351

 * Change the towns population

   352

 * @param t Town which polulation has changed

   353

 * @param mod polulation change (can be positive or negative)

   354

 */

   355

static void ChangePopulation(Town *t, int mod)

   356

{

   357

	t->population += mod;

   358

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   359

	UpdateTownVirtCoord(t);

   360

   361

	InvalidateWindowData(WC_TOWN_DIRECTORY, 0, 1);

   362

}

   363

   364

/**

   365

 * Determines the world population

   366

 * Basically, count population of all towns, one by one

   367

 * @return uint32 the calculated population of the world

   368

 */

   369

uint32 GetWorldPopulation()

   370

{

   371

	uint32 pop = 0;

   372

	const Town *t;

   373

   374

	FOR_ALL_TOWNS(t) pop += t->population;

   375

	return pop;

   376

}

   377

   378

/**

   379

 * Helper function for house completion stages progression

   380

 * @param tile TileIndex of the house (or parts of it) to "grow"

   381

 */

   382

static void MakeSingleHouseBigger(TileIndex tile)

   383

{

   384

	assert(IsTileType(tile, MP_HOUSE));

   385

   386

	/* means it is completed, get out. */

   387

	if (LiftHasDestination(tile)) return;

   388

   389

	/* progress in construction stages */

   390

	IncHouseConstructionTick(tile);

   391

	if (GetHouseConstructionTick(tile) != 0) return;

   392

   393

	const HouseSpec *hs = GetHouseSpecs(GetHouseType(tile));

   394

   395

	/* Check and/or  */

   396

	if (HasBit(hs->callback_mask, CBM_HOUSE_CONSTRUCTION_STATE_CHANGE)) {

   397

		uint16 callback_res = GetHouseCallback(CBID_HOUSE_CONSTRUCTION_STATE_CHANGE, 0, 0, GetHouseType(tile), GetTownByTile(tile), tile);

   398

		if (callback_res != CALLBACK_FAILED) ChangeHouseAnimationFrame(hs->grffile, tile, callback_res);

   399

	}

   400

   401

	if (IsHouseCompleted(tile)) {

   402

		/* Now that construction is complete, we can add the population of the

   403

		 * building to the town. */

   404

		ChangePopulation(GetTownByTile(tile), hs->population);

   405

		SetHouseConstructionYear(tile, _cur_year);

   406

	}

   407

	MarkTileDirtyByTile(tile);

   408

}

   409

   410

/** Make the house advance in its construction stages until completion

   411

 * @param tile TileIndex of house

   412

 */

   413

static void MakeTownHouseBigger(TileIndex tile)

   414

{

   415

	uint flags = GetHouseSpecs(GetHouseType(tile))->building_flags;

   416

	if (flags & BUILDING_HAS_1_TILE)  MakeSingleHouseBigger(TILE_ADDXY(tile, 0, 0));

   417

	if (flags & BUILDING_2_TILES_Y)   MakeSingleHouseBigger(TILE_ADDXY(tile, 0, 1));

   418

	if (flags & BUILDING_2_TILES_X)   MakeSingleHouseBigger(TILE_ADDXY(tile, 1, 0));

   419

	if (flags & BUILDING_HAS_4_TILES) MakeSingleHouseBigger(TILE_ADDXY(tile, 1, 1));

   420

}

   421

   422

/**

   423

 * Tile callback function.

   424

 *

   425

 * Periodic tic handler for houses and town

   426

 * @param tile been asked to do its stuff

   427

 */

   428

static void TileLoop_Town(TileIndex tile)

   429

{

   430

	HouseID house_id = GetHouseType(tile);

   431

   432

	/* NewHouseTileLoop returns false if Callback 21 succeeded, i.e. the house

   433

	 * doesn't exist any more, so don't continue here. */

   434

	if (house_id >= NEW_HOUSE_OFFSET && !NewHouseTileLoop(tile)) return;

   435

   436

	if (!IsHouseCompleted(tile)) {

   437

		/* Construction is not completed. See if we can go further in construction*/

   438

		MakeTownHouseBigger(tile);

   439

		return;

   440

	}

   441

   442

	const HouseSpec *hs = GetHouseSpecs(house_id);

   443

   444

	/* If the lift has a destination, it is already an animated tile. */

   445

	if ((hs->building_flags & BUILDING_IS_ANIMATED) &&

   446

			house_id < NEW_HOUSE_OFFSET &&

   447

			!LiftHasDestination(tile) &&

   448

			Chance16(1, 2)) {

   449

		AddAnimatedTile(tile);

   450

	}

   451

   452

	Town *t = GetTownByTile(tile);

   453

	uint32 r = Random();

   454

   455

	if (HasBit(hs->callback_mask, CBM_HOUSE_PRODUCE_CARGO)) {

   456

		for (uint i = 0; i < 256; i++) {

   457

			uint16 callback = GetHouseCallback(CBID_HOUSE_PRODUCE_CARGO, i, r, house_id, t, tile);

   458

   459

			if (callback == CALLBACK_FAILED || callback == CALLBACK_HOUSEPRODCARGO_END) break;

   460

   461

			CargoID cargo = GetCargoTranslation(GB(callback, 8, 7), hs->grffile);

   462

			if (cargo == CT_INVALID) continue;

   463

   464

			uint amt = GB(callback, 0, 8);

   465

			uint moved = MoveGoodsToStation(tile, 1, 1, cargo, amt);

   466

   467

			const CargoSpec *cs = GetCargo(cargo);

   468

			switch (cs->town_effect) {

   469

				case TE_PASSENGERS:

   470

					t->new_max_pass += amt;

   471

					t->new_act_pass += moved;

   472

					break;

   473

   474

				case TE_MAIL:

   475

					t->new_max_mail += amt;

   476

					t->new_act_mail += moved;

   477

					break;

   478

   479

				default:

   480

					break;

   481

			}

   482

		}

   483

	} else {

   484

		if (GB(r, 0, 8) < hs->population) {

   485

			uint amt = GB(r, 0, 8) / 8 + 1;

   486

   487