1

/* $Id$ */

     2

     3

/** @file town_cmd.cpp */

     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 "misc/autoptr.hpp"

    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

    49

#include "table/strings.h"

    50

#include "table/sprites.h"

    51

#include "table/town_land.h"

    52

    53

uint _total_towns;

    54

HouseSpec _house_specs[HOUSE_MAX];

    55

    56

bool _town_sort_dirty;

    57

byte _town_sort_order;

    58

const Town **_town_sort;

    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

	_town_sort_dirty = true;

    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

			case MP_TUNNELBRIDGE:

    98

				if (IsTileOwner(tile, OWNER_TOWN) &&

    99

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

   100

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

   101

				break;

   102

   103

			default:

   104

				break;

   105

		}

   106

	}

   107

   108

	DeleteSubsidyWithTown(this->index);

   109

   110

	MarkWholeScreenDirty();

   111

   112

	this->xy = 0;

   113

}

   114

   115

/**

   116

 * Generate a random town road layout.

   117

 *

   118

 * The layout is based on the TileHash.

   119

 */

   120

void Town::InitializeLayout()

   121

{

   122

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

   123

   124

	/* Set invalid layouts to valid ones */

   125

	switch (this->layout) {

   126

		default: break;

   127

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

   128

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

   129

	}

   130

}

   131

   132

// Local

   133

static int _grow_town_result;

   134

   135

/* Describe the possible states */

   136

enum TownGrowthResult {

   137

	GROWTH_SUCCEED         = -1,

   138

	GROWTH_SEARCH_STOPPED  =  0

   139

//	GROWTH_SEARCH_RUNNING >=  1

   140

};

   141

   142

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

   143

   144

static void TownDrawHouseLift(const TileInfo *ti)

   145

{

   146

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

   147

}

   148

   149

typedef void TownDrawTileProc(const TileInfo *ti);

   150

static TownDrawTileProc *const _town_draw_tile_procs[1] = {

   151

	TownDrawHouseLift

   152

};

   153

   154

/**

   155

 * Return a random direction

   156

 *

   157

 * @return a random direction

   158

 */

   159

static inline DiagDirection RandomDiagDir()

   160

{

   161

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

   162

}

   163

   164

/**

   165

 * House Tile drawing handler.

   166

 * Part of the tile loop process

   167

 * @param ti TileInfo of the tile to draw

   168

 */

   169

static void DrawTile_Town(TileInfo *ti)

   170

{

   171

	HouseID house_id = GetHouseType(ti->tile);

   172

   173

	if (house_id >= NEW_HOUSE_OFFSET) {

   174

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

   175

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

   176

		 * house id is drawn instead. */

   177

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

   178

			DrawNewHouseTile(ti, house_id);

   179

			return;

   180

		} else {

   181

			house_id = GetHouseSpecs(house_id)->substitute_id;

   182

		}

   183

	}

   184

   185

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

   186

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

   187

   188

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

   189

   190

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

   191

   192

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

   193

	if (IsInvisibilitySet(TO_HOUSES)) return;

   194

   195

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

   196

	SpriteID image = dcts->building.sprite;

   197

	if (image != 0) {

   198

		AddSortableSpriteToDraw(image, dcts->building.pal,

   199

			ti->x + dcts->subtile_x,

   200

			ti->y + dcts->subtile_y,

   201

			dcts->width,

   202

			dcts->height,

   203

			dcts->dz,

   204

			ti->z,

   205

			IsTransparencySet(TO_HOUSES)

   206

		);

   207

   208

		if (IsTransparencySet(TO_HOUSES)) return;

   209

	}

   210

   211

	{

   212

		int proc = dcts->draw_proc - 1;

   213

   214

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

   215

	}

   216

}

   217

   218

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

   219

{

   220

	return GetTileMaxZ(tile);

   221

}

   222

   223

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   224

{

   225

	return FlatteningFoundation(tileh);

   226

}

   227

   228

/**

   229

 * Animate a tile for a town

   230

 * Only certain houses can be animated

   231

 * The newhouses animation superseeds regular ones

   232

 * @param tile TileIndex of the house to animate

   233

 */

   234

static void AnimateTile_Town(TileIndex tile)

   235

{

   236

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   237

		AnimateNewHouseTile(tile);

   238

		return;

   239

	}

   240

   241

	if (_tick_counter & 3) return;

   242

   243

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

   244

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

   245

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

   246

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

   247

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

   248

		DeleteAnimatedTile(tile);

   249

		return;

   250

	}

   251

   252

	if (!LiftHasDestination(tile)) {

   253

		uint i;

   254

   255

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

   256

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

   257

		 *  the height of 2 'normal' floors.

   258

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

   259

		do {

   260

			i = RandomRange(7);

   261

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

   262

   263

		SetLiftDestination(tile, i);

   264

	}

   265

   266

	int pos = GetLiftPosition(tile);

   267

	int dest = GetLiftDestination(tile) * 6;

   268

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

   269

	SetLiftPosition(tile, pos);

   270

   271

	if (pos == dest) HaltLift(tile);

   272

   273

	MarkTileDirtyByTile(tile);

   274

}

   275

   276

/**

   277

 * Determines if a town is close to a tile

   278

 * @param tile TileIndex of the tile to query

   279

 * @param dist maximum distance to be accepted

   280

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

   281

 */

   282

static bool IsCloseToTown(TileIndex tile, uint dist)

   283

{

   284

	const Town *t;

   285

   286

	FOR_ALL_TOWNS(t) {

   287

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

   288

	}

   289

	return false;

   290

}

   291

   292

/**

   293

 * Marks the town sign as needing a repaint.

   294

 *

   295

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

   296

 *

   297

 * @param t Town requesting town sign for repaint

   298

 * @ingroup dirty

   299

 */

   300

static void MarkTownSignDirty(Town *t)

   301

{

   302

	MarkAllViewportsDirty(

   303

		t->sign.left - 6,

   304

		t->sign.top - 3,

   305

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

   306

		t->sign.top + 45

   307

	);

   308

}

   309

   310

/**

   311

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

   312

 * population (creation or growth or else)

   313

 * @param t Town to update

   314

 */

   315

void UpdateTownVirtCoord(Town *t)

   316

{

   317

	MarkTownSignDirty(t);

   318

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

   319

	SetDParam(0, t->index);

   320

	SetDParam(1, t->population);

   321

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

   322

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   323

	MarkTownSignDirty(t);

   324

}

   325

   326

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

   327

void UpdateAllTownVirtCoords()

   328

{

   329

	Town *t;

   330

	FOR_ALL_TOWNS(t) {

   331

		UpdateTownVirtCoord(t);

   332

	}

   333

}

   334

   335

/**

   336

 * Change the towns population

   337

 * @param t Town which polulation has changed

   338

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

   339

 */

   340

static void ChangePopulation(Town *t, int mod)

   341

{

   342

	t->population += mod;

   343

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   344

	UpdateTownVirtCoord(t);

   345

   346

	if (_town_sort_order & 2) _town_sort_dirty = true;

   347

}

   348

   349

/**

   350

 * Determines the world population

   351

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

   352

 * @return uint32 the calculated population of the world

   353

 */

   354

uint32 GetWorldPopulation()

   355

{

   356

	uint32 pop = 0;

   357

	const Town *t;

   358

   359

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

   360

	return pop;

   361

}

   362

   363

/**

   364

 * Helper function for house completion stages progression

   365

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

   366

 */

   367

static void MakeSingleHouseBigger(TileIndex tile)

   368

{

   369

	assert(IsTileType(tile, MP_HOUSE));

   370

   371

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

   372

	if (LiftHasDestination(tile)) return;

   373

   374

	/* progress in construction stages */

   375

	IncHouseConstructionTick(tile);

   376

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

   377

   378

	/* Check and/or  */

   379

	if (HasBit(GetHouseSpecs(GetHouseType(tile))->callback_mask, CBM_HOUSE_CONSTRUCTION_STATE_CHANGE)) {

   380

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

   381

		if (callback_res != CALLBACK_FAILED) ChangeHouseAnimationFrame(tile, callback_res);

   382

	}

   383

   384

	if (IsHouseCompleted(tile)) {

   385

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

   386

		 * building to the town. */

   387

		ChangePopulation(GetTownByTile(tile), GetHouseSpecs(GetHouseType(tile))->population);

   388

	}

   389

	MarkTileDirtyByTile(tile);

   390

}

   391

   392

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

   393

 * @param tile TileIndex of house

   394

 */

   395

static void MakeTownHouseBigger(TileIndex tile)

   396

{

   397

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

   398

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

   399

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

   400

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

   401

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

   402

}

   403

   404

/**

   405

 * Periodic tic handler for houses and town

   406

 * @param tile been asked to do its stuff

   407

 */

   408

static void TileLoop_Town(TileIndex tile)

   409

{

   410

	HouseID house_id = GetHouseType(tile);

   411

   412

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

   413

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

   414

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

   415

   416

	if (!IsHouseCompleted(tile)) {

   417

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

   418

		MakeTownHouseBigger(tile);

   419

		return;

   420

	}

   421

   422

	const HouseSpec *hs = GetHouseSpecs(house_id);

   423

   424

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

   425

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

   426

			house_id < NEW_HOUSE_OFFSET &&

   427

			!LiftHasDestination(tile) &&

   428

			Chance16(1, 2)) {

   429

		AddAnimatedTile(tile);

   430

	}

   431

   432

	Town *t = GetTownByTile(tile);

   433

	uint32 r = Random();

   434

   435

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

   436

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

   437

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

   438

   439

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

   440

   441

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

   442

			if (cargo == CT_INVALID) continue;

   443

   444

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

   445

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

   446

   447

			const CargoSpec *cs = GetCargo(cargo);

   448

			switch (cs->town_effect) {

   449

				case TE_PASSENGERS:

   450

					t->new_max_pass += amt;

   451

					t->new_act_pass += moved;

   452

					break;

   453

   454

				case TE_MAIL:

   455

					t->new_max_mail += amt;

   456

					t->new_act_mail += moved;

   457

					break;

   458

   459

				default:

   460

					break;

   461

			}

   462

		}

   463

	} else {

   464

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

   465

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

   466

   467

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

   468

			t->new_max_pass += amt;

   469

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

   470

		}

   471

   472

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

   473

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

   474

   475

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

   476

			t->new_max_mail += amt;

   477

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

   478

		}

   479

	}

   480

   481

	_current_player = OWNER_TOWN;

   482

   483

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   484

			HasBit(t->flags12, TOWN_IS_FUNDED) &&

   485

			CanDeleteHouse(tile) &&

   486

			max(_cur_year - GetHouseConstructionYear(tile), 0) >= hs->minimum_life &&

   487

			--t->time_until_rebuild == 0) {