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

    12

#include "town_map.h"

    13

#include "tunnel_map.h"

    14

#include "viewport_func.h"

    15

#include "town.h"

    16

#include "command_func.h"

    17

#include "industry.h"

    18

#include "station_base.h"

    19

#include "player_base.h"

    20

#include "news_func.h"

    21

#include "saveload.h"

    22

#include "gui.h"

    23

#include "unmovable_map.h"

    24

#include "water_map.h"

    25

#include "variables.h"

    26

#include "bridge.h"

    27

#include "bridge_map.h"

    28

#include "genworld.h"

    29

#include "newgrf.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_house.h"

    32

#include "newgrf_commons.h"

    33

#include "newgrf_townname.h"

    34

#include "autoslope.h"

    35

#include "waypoint.h"

    36

#include "transparency.h"

    37

#include "tunnelbridge_map.h"

    38

#include "strings_func.h"

    39

#include "window_func.h"

    40

#include "string_func.h"

    41

#include "newgrf_cargo.h"

    42

#include "oldpool_func.h"

    43

#include "sprite.h"

    44

#include "economy_func.h"

    45

#include "station_func.h"

    46

#include "cheat_func.h"

    47

#include "functions.h"

    48

#include "animated_tile_func.h"

    49

#include "date_func.h"

    50

#include <map>

    51

    52

#include "table/strings.h"

    53

#include "table/sprites.h"

    54

#include "table/town_land.h"

    55

    56

uint _total_towns;

    57

HouseSpec _house_specs[HOUSE_MAX];

    58

    59

Town *_cleared_town;

    60

int _cleared_town_rating;

    61

    62

/* Initialize the town-pool */

    63

DEFINE_OLD_POOL_GENERIC(Town, Town)

    64

    65

Town::Town(TileIndex tile)

    66

{

    67

	if (tile != 0) _total_towns++;

    68

	this->xy = tile;

    69

}

    70

    71

Town::~Town()

    72

{

    73

	free(this->name);

    74

    75

	if (CleaningPool()) return;

    76

    77

	Industry *i;

    78

    79

	/* Delete town authority window

    80

	 * and remove from list of sorted towns */

    81

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    82

	InvalidateWindowData(WC_TOWN_DIRECTORY, 0, 0);

    83

	_total_towns--;

    84

    85

	/* Delete all industries belonging to the town */

    86

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

    87

    88

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

    89

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

    90

		switch (GetTileType(tile)) {

    91

			case MP_HOUSE:

    92

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

    93

				break;

    94

    95

			case MP_ROAD:

    96

			case MP_TUNNELBRIDGE:

    97

				if (IsTileOwner(tile, OWNER_TOWN) &&

    98

						ClosestTownFromTile(tile, (uint)-1) == this)

    99

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

   100

				break;

   101

   102

			default:

   103

				break;

   104

		}

   105

	}

   106

   107

	DeleteSubsidyWithTown(this->index);

   108

   109

	MarkWholeScreenDirty();

   110

   111

	this->xy = 0;

   112

}

   113

   114

/**

   115

 * Generate a random town road layout.

   116

 *

   117

 * The layout is based on the TileHash.

   118

 */

   119

void Town::InitializeLayout()

   120

{

   121

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

   122

   123

	/* Set invalid layouts to valid ones */

   124

	switch (this->layout) {

   125

		default: break;

   126

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

   127

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

   128

	}

   129

}

   130

   131

Money HouseSpec::GetRemovalCost() const

   132

{

   133

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

   134

}

   135

   136

// Local

   137

static int _grow_town_result;

   138

   139

/* Describe the possible states */

   140

enum TownGrowthResult {

   141

	GROWTH_SUCCEED         = -1,

   142

	GROWTH_SEARCH_STOPPED  =  0

   143

//	GROWTH_SEARCH_RUNNING >=  1

   144

};

   145

   146

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

   147

   148

static void TownDrawHouseLift(const TileInfo *ti)

   149

{

   150

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

   151

}

   152

   153

typedef void TownDrawTileProc(const TileInfo *ti);

   154

static TownDrawTileProc *const _town_draw_tile_procs[1] = {

   155

	TownDrawHouseLift

   156

};

   157

   158

/**

   159

 * Return a random direction

   160

 *

   161

 * @return a random direction

   162

 */

   163

static inline DiagDirection RandomDiagDir()

   164

{

   165

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

   166

}

   167

   168

/**

   169

 * House Tile drawing handler.

   170

 * Part of the tile loop process

   171

 * @param ti TileInfo of the tile to draw

   172

 */

   173

static void DrawTile_Town(TileInfo *ti)

   174

{

   175

	HouseID house_id = GetHouseType(ti->tile);

   176

   177

	if (house_id >= NEW_HOUSE_OFFSET) {

   178

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

   179

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

   180

		 * house id is drawn instead. */

   181

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

   182

			DrawNewHouseTile(ti, house_id);

   183

			return;

   184

		} else {

   185

			house_id = GetHouseSpecs(house_id)->substitute_id;

   186

		}

   187

	}

   188

   189

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

   190

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

   191

   192

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

   193

   194

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

   195

   196

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

   197

	if (IsInvisibilitySet(TO_HOUSES)) return;

   198

   199

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

   200

	SpriteID image = dcts->building.sprite;

   201

	if (image != 0) {

   202

		AddSortableSpriteToDraw(image, dcts->building.pal,

   203

			ti->x + dcts->subtile_x,

   204

			ti->y + dcts->subtile_y,

   205

			dcts->width,

   206

			dcts->height,

   207

			dcts->dz,

   208

			ti->z,

   209

			IsTransparencySet(TO_HOUSES)

   210

		);

   211

   212

		if (IsTransparencySet(TO_HOUSES)) return;

   213

	}

   214

   215

	{

   216

		int proc = dcts->draw_proc - 1;

   217

   218

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

   219

	}

   220

}

   221

   222

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

   223

{

   224

	return GetTileMaxZ(tile);

   225

}

   226

   227

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   228

{

   229

	return FlatteningFoundation(tileh);

   230

}

   231

   232

/**

   233

 * Animate a tile for a town

   234

 * Only certain houses can be animated

   235

 * The newhouses animation superseeds regular ones

   236

 * @param tile TileIndex of the house to animate

   237

 */

   238

static void AnimateTile_Town(TileIndex tile)

   239

{

   240

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   241

		AnimateNewHouseTile(tile);

   242

		return;

   243

	}

   244

   245

	if (_tick_counter & 3) return;

   246

   247

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

   248

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

   249

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

   250

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

   251

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

   252

		DeleteAnimatedTile(tile);

   253

		return;

   254

	}

   255

   256

	if (!LiftHasDestination(tile)) {

   257

		uint i;

   258

   259

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

   260

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

   261

		 *  the height of 2 'normal' floors.

   262

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

   263

		do {

   264

			i = RandomRange(7);

   265

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

   266

   267

		SetLiftDestination(tile, i);

   268

	}

   269

   270

	int pos = GetLiftPosition(tile);

   271

	int dest = GetLiftDestination(tile) * 6;

   272

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

   273

	SetLiftPosition(tile, pos);

   274

   275

	if (pos == dest) {

   276

		HaltLift(tile);

   277

		DeleteAnimatedTile(tile);

   278

	}

   279

   280

	MarkTileDirtyByTile(tile);

   281

}

   282

   283

/**

   284

 * Determines if a town is close to a tile

   285

 * @param tile TileIndex of the tile to query

   286

 * @param dist maximum distance to be accepted

   287

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

   288

 */

   289

static bool IsCloseToTown(TileIndex tile, uint dist)

   290

{

   291

	const Town *t;

   292

   293

	FOR_ALL_TOWNS(t) {

   294

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

   295

	}

   296

	return false;

   297

}

   298

   299

/**

   300

 * Marks the town sign as needing a repaint.

   301

 *

   302

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

   303

 *

   304

 * @param t Town requesting town sign for repaint

   305

 * @ingroup dirty

   306

 */

   307

static void MarkTownSignDirty(Town *t)

   308

{

   309

	MarkAllViewportsDirty(

   310

		t->sign.left - 6,

   311

		t->sign.top - 3,

   312

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

   313

		t->sign.top + 45

   314

	);

   315

}

   316

   317

/**

   318

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

   319

 * population (creation or growth or else)

   320

 * @param t Town to update

   321

 */

   322

void UpdateTownVirtCoord(Town *t)

   323

{

   324

	MarkTownSignDirty(t);

   325

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

   326

	SetDParam(0, t->index);

   327

	SetDParam(1, t->population);

   328

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

   329

		_settings_client.gui.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   330

	MarkTownSignDirty(t);

   331

}

   332

   333

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

   334

void UpdateAllTownVirtCoords()

   335

{

   336

	Town *t;

   337

	FOR_ALL_TOWNS(t) {

   338

		UpdateTownVirtCoord(t);

   339

	}

   340

}

   341

   342

/**

   343

 * Change the towns population

   344

 * @param t Town which polulation has changed

   345

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

   346

 */

   347

static void ChangePopulation(Town *t, int mod)

   348

{

   349

	t->population += mod;

   350

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   351

	UpdateTownVirtCoord(t);

   352

   353

	InvalidateWindowData(WC_TOWN_DIRECTORY, 0, 1);

   354

}

   355

   356

/**

   357

 * Determines the world population

   358

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

   359

 * @return uint32 the calculated population of the world

   360

 */

   361

uint32 GetWorldPopulation()

   362

{

   363

	uint32 pop = 0;

   364

	const Town *t;

   365

   366

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

   367

	return pop;

   368

}

   369

   370

/**

   371

 * Helper function for house completion stages progression

   372

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

   373

 */

   374

static void MakeSingleHouseBigger(TileIndex tile)

   375

{

   376

	assert(IsTileType(tile, MP_HOUSE));

   377

   378

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

   379

	if (LiftHasDestination(tile)) return;

   380

   381

	/* progress in construction stages */

   382

	IncHouseConstructionTick(tile);

   383

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

   384

   385

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

   386

   387

	/* Check and/or  */

   388

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

   389

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

   390

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

   391

	}

   392

   393

	if (IsHouseCompleted(tile)) {

   394

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

   395

		 * building to the town. */

   396

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

   397

		SetHouseConstructionYear(tile, _cur_year);

   398

	}

   399

	MarkTileDirtyByTile(tile);

   400

}

   401

   402

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

   403

 * @param tile TileIndex of house

   404

 */

   405

static void MakeTownHouseBigger(TileIndex tile)

   406

{

   407

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

   408

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

   409

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

   410

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

   411

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

   412

}

   413

   414

/**

   415

 * Periodic tic handler for houses and town

   416

 * @param tile been asked to do its stuff

   417

 */

   418

static void TileLoop_Town(TileIndex tile)

   419

{

   420

	HouseID house_id = GetHouseType(tile);

   421

   422

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

   423

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

   424

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

   425

   426

	if (!IsHouseCompleted(tile)) {

   427

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

   428

		MakeTownHouseBigger(tile);

   429

		return;

   430

	}

   431

   432

	const HouseSpec *hs = GetHouseSpecs(house_id);

   433

   434

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

   435

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

   436

			house_id < NEW_HOUSE_OFFSET &&

   437

			!LiftHasDestination(tile) &&

   438

			Chance16(1, 2)) {

   439

		AddAnimatedTile(tile);

   440

	}

   441

   442

	Town *t = GetTownByTile(tile);

   443

	uint32 r = Random();

   444

   445

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

   446

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

   447

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

   448

   449

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

   450

   451

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

   452

			if (cargo == CT_INVALID) continue;

   453

   454

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

   455

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

   456

   457

			const CargoSpec *cs = GetCargo(cargo);

   458

			switch (cs->town_effect) {

   459

				case TE_PASSENGERS:

   460

					t->new_max_pass += amt;

   461

					t->new_act_pass += moved;

   462

					break;

   463

   464

				case TE_MAIL:

   465

					t->new_max_mail += amt;

   466

					t->new_act_mail += moved;

   467

					break;

   468

   469

				default:

   470

					break;

   471

			}

   472

		}

   473

	} else {

   474

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

   475

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

   476

   477

			if (_economy.fluct <= 0) amt = (amt + 1) >> 1;

   478

			t->new_max_pass += amt;

   479

			t->new_act_pass += MoveGoodsToStation(tile, 1, 1, CT_PASSENGERS, amt);

   480

		}

   481

   482

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

   483

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

   484

   485

			if (_economy.fluct <= 0) amt = (amt + 1) >> 1;

   486

			t->new_max_mail += amt;

   487

			t->new_act_mail += MoveGoodsToStation(tile, 1, 1, CT_MAIL, amt);