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

    45

#include "table/strings.h"

    46

#include "table/sprites.h"

    47

#include "table/town_land.h"

    48

    49

uint _total_towns;

    50

HouseSpec _house_specs[HOUSE_MAX];

    51

    52

bool _town_sort_dirty;

    53

byte _town_sort_order;

    54

const Town **_town_sort;

    55

    56

Town *_cleared_town;

    57

int _cleared_town_rating;

    58

    59

/* Initialize the town-pool */

    60

DEFINE_OLD_POOL_GENERIC(Town, Town)

    61

    62

Town::Town(TileIndex tile)

    63

{

    64

	if (tile != 0) _total_towns++;

    65

	this->xy = tile;

    66

}

    67

    68

Town::~Town()

    69

{

    70

	free(this->name);

    71

    72

	if (CleaningPool()) return;

    73

    74

	Industry *i;

    75

    76

	/* Delete town authority window

    77

	 * and remove from list of sorted towns */

    78

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    79

	_town_sort_dirty = true;

    80

	_total_towns--;

    81

    82

	/* Delete all industries belonging to the town */

    83

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

    84

    85

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

    86

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

    87

		switch (GetTileType(tile)) {

    88

			case MP_HOUSE:

    89

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

    90

				break;

    91

    92

			case MP_ROAD:

    93

			case MP_TUNNELBRIDGE:

    94

				if (IsTileOwner(tile, OWNER_TOWN) &&

    95

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

    96

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

    97

				break;

    98

    99

			default:

   100

				break;

   101

		}

   102

	}

   103

   104

	DeleteSubsidyWithTown(this->index);

   105

   106

	MarkWholeScreenDirty();

   107

   108

	this->xy = 0;

   109

}

   110

   111

/**

   112

 * Generate a random town road layout.

   113

 *

   114

 * The layout is based on the TileHash.

   115

 */

   116

void Town::InitializeLayout()

   117

{

   118

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

   119

   120

	/* Set invalid layouts to valid ones */

   121

	switch (this->layout) {

   122

		default: break;

   123

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

   124

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

   125

	}

   126

}

   127

   128

// Local

   129

static int _grow_town_result;

   130

   131

/* Describe the possible states */

   132

enum TownGrowthResult {

   133

	GROWTH_SUCCEED         = -1,

   134

	GROWTH_SEARCH_STOPPED  =  0

   135

//	GROWTH_SEARCH_RUNNING >=  1

   136

};

   137

   138

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

   139

   140

static void TownDrawHouseLift(const TileInfo *ti)

   141

{

   142

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

   143

}

   144

   145

typedef void TownDrawTileProc(const TileInfo *ti);

   146

static TownDrawTileProc *const _town_draw_tile_procs[1] = {

   147

	TownDrawHouseLift

   148

};

   149

   150

/**

   151

 * Return a random direction

   152

 *

   153

 * @return a random direction

   154

 */

   155

static inline DiagDirection RandomDiagDir()

   156

{

   157

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

   158

}

   159

   160

/**

   161

 * House Tile drawing handler.

   162

 * Part of the tile loop process

   163

 * @param ti TileInfo of the tile to draw

   164

 */

   165

static void DrawTile_Town(TileInfo *ti)

   166

{

   167

	HouseID house_id = GetHouseType(ti->tile);

   168

   169

	if (house_id >= NEW_HOUSE_OFFSET) {

   170

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

   171

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

   172

		 * house id is drawn instead. */

   173

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

   174

			DrawNewHouseTile(ti, house_id);

   175

			return;

   176

		} else {

   177

			house_id = GetHouseSpecs(house_id)->substitute_id;

   178

		}

   179

	}

   180

   181

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

   182

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

   183

   184

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

   185

   186

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

   187

   188

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

   189

	if (IsInvisibilitySet(TO_HOUSES)) return;

   190

   191

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

   192

	SpriteID image = dcts->building.sprite;

   193

	if (image != 0) {

   194

		AddSortableSpriteToDraw(image, dcts->building.pal,

   195

			ti->x + dcts->subtile_x,

   196

			ti->y + dcts->subtile_y,

   197

			dcts->width,

   198

			dcts->height,

   199

			dcts->dz,

   200

			ti->z,

   201

			IsTransparencySet(TO_HOUSES)

   202

		);

   203

   204

		if (IsTransparencySet(TO_HOUSES)) return;

   205

	}

   206

   207

	{

   208

		int proc = dcts->draw_proc - 1;

   209

   210

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

   211

	}

   212

}

   213

   214

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

   215

{

   216

	return GetTileMaxZ(tile);

   217

}

   218

   219

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   220

{

   221

	return FlatteningFoundation(tileh);

   222

}

   223

   224

/**

   225

 * Animate a tile for a town

   226

 * Only certain houses can be animated

   227

 * The newhouses animation superseeds regular ones

   228

 * @param tile TileIndex of the house to animate

   229

 */

   230

static void AnimateTile_Town(TileIndex tile)

   231

{

   232

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   233

		AnimateNewHouseTile(tile);

   234

		return;

   235

	}

   236

   237

	if (_tick_counter & 3) return;

   238

   239

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

   240

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

   241

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

   242

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

   243

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

   244

		DeleteAnimatedTile(tile);

   245

		return;

   246

	}

   247

   248

	if (!LiftHasDestination(tile)) {

   249

		uint i;

   250

   251

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

   252

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

   253

		 *  the height of 2 'normal' floors.

   254

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

   255

		do {

   256

			i = RandomRange(7);

   257

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

   258

   259

		SetLiftDestination(tile, i);

   260

	}

   261

   262

	int pos = GetLiftPosition(tile);

   263

	int dest = GetLiftDestination(tile) * 6;

   264

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

   265

	SetLiftPosition(tile, pos);

   266

   267

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

   268

   269

	MarkTileDirtyByTile(tile);

   270

}

   271

   272

/**

   273

 * Determines if a town is close to a tile

   274

 * @param tile TileIndex of the tile to query

   275

 * @param dist maximum distance to be accepted

   276

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

   277

 */

   278

static bool IsCloseToTown(TileIndex tile, uint dist)

   279

{

   280

	const Town *t;

   281

   282

	FOR_ALL_TOWNS(t) {

   283

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

   284

	}

   285

	return false;

   286

}

   287

   288

/**

   289

 * Marks the town sign as needing a repaint.

   290

 *

   291

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

   292

 *

   293

 * @param t Town requesting town sign for repaint

   294

 * @ingroup dirty

   295

 */

   296

static void MarkTownSignDirty(Town *t)

   297

{

   298

	MarkAllViewportsDirty(

   299

		t->sign.left - 6,

   300

		t->sign.top - 3,

   301

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

   302

		t->sign.top + 45

   303

	);

   304

}

   305

   306

/**

   307

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

   308

 * population (creation or growth or else)

   309

 * @param t Town to update

   310

 */

   311

void UpdateTownVirtCoord(Town *t)

   312

{

   313

	MarkTownSignDirty(t);

   314

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

   315

	SetDParam(0, t->index);

   316

	SetDParam(1, t->population);

   317

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

   318

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   319

	MarkTownSignDirty(t);

   320

}

   321

   322

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

   323

void UpdateAllTownVirtCoords()

   324

{

   325

	Town *t;

   326

	FOR_ALL_TOWNS(t) {

   327

		UpdateTownVirtCoord(t);

   328

	}

   329

}

   330

   331

/**

   332

 * Change the towns population

   333

 * @param t Town which polulation has changed

   334

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

   335

 */

   336

static void ChangePopulation(Town *t, int mod)

   337

{

   338

	t->population += mod;

   339

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   340

	UpdateTownVirtCoord(t);

   341

   342

	if (_town_sort_order & 2) _town_sort_dirty = true;

   343

}

   344

   345

/**

   346

 * Determines the world population

   347

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

   348

 * @return uint32 the calculated population of the world

   349

 */

   350

uint32 GetWorldPopulation()

   351

{

   352

	uint32 pop = 0;

   353

	const Town *t;

   354

   355

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

   356

	return pop;

   357

}

   358

   359

/**

   360

 * Helper function for house completion stages progression

   361

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

   362

 */

   363

static void MakeSingleHouseBigger(TileIndex tile)

   364

{

   365

	assert(IsTileType(tile, MP_HOUSE));

   366

   367

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

   368

	if (LiftHasDestination(tile)) return;

   369

   370

	/* progress in construction stages */

   371

	IncHouseConstructionTick(tile);

   372

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

   373

   374

	/* Check and/or  */

   375

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

   376

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

   377

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

   378

	}

   379

   380

	if (IsHouseCompleted(tile)) {

   381

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

   382

		 * building to the town. */

   383

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

   384

	}

   385

	MarkTileDirtyByTile(tile);

   386

}

   387

   388

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

   389

 * @param tile TileIndex of house

   390

 */

   391

static void MakeTownHouseBigger(TileIndex tile)

   392

{

   393

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

   394

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

   395

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

   396

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

   397

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

   398

}

   399

   400

/**

   401

 * Periodic tic handler for houses and town

   402

 * @param tile been asked to do its stuff

   403

 */

   404

static void TileLoop_Town(TileIndex tile)

   405

{

   406

	HouseID house_id = GetHouseType(tile);

   407

   408

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

   409

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

   410

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

   411

   412

	if (!IsHouseCompleted(tile)) {

   413

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

   414

		MakeTownHouseBigger(tile);

   415

		return;

   416

	}

   417

   418

	const HouseSpec *hs = GetHouseSpecs(house_id);

   419

   420

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

   421

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

   422

			house_id < NEW_HOUSE_OFFSET &&

   423

			!LiftHasDestination(tile) &&

   424

			Chance16(1, 2)) {

   425

		AddAnimatedTile(tile);

   426

	}

   427

   428

	Town *t = GetTownByTile(tile);

   429

	uint32 r = Random();

   430

   431

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

   432

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

   433

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

   434

   435

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

   436

   437

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

   438

			if (cargo == CT_INVALID) continue;

   439

   440

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

   441

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

   442

   443

			const CargoSpec *cs = GetCargo(cargo);

   444

			switch (cs->town_effect) {

   445

				case TE_PASSENGERS:

   446

					t->new_max_pass += amt;

   447

					t->new_act_pass += moved;

   448

					break;

   449

   450

				case TE_MAIL:

   451

					t->new_max_mail += amt;

   452

					t->new_act_mail += moved;

   453

					break;

   454

   455

				default:

   456

					break;

   457

			}

   458

		}

   459

	} else {

   460

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

   461

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

   462

   463

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

   464

			t->new_max_pass += amt;

   465

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

   466

		}

   467

   468

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

   469

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

   470

   471

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

   472

			t->new_max_mail += amt;

   473

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

   474

		}

   475

	}

   476

   477

	_current_player = OWNER_TOWN;

   478

   479

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   480

			HasBit(t->flags12, TOWN_IS_FUNDED) &&

   481

			CanDeleteHouse(tile) &&

   482

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

   483

			--t->time_until_rebuild == 0) {

   484

		t->time_until_rebuild = GB(r, 16, 8) + 192;

   485

   486

		ClearTownHouse(t, tile);

   487