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

#include "functions.h"

    49

#include "animated_tile_func.h"

    50

#include "date_func.h"

    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

bool _town_sort_dirty;

    60

byte _town_sort_order;

    61

const Town **_town_sort;

    62

    63

Town *_cleared_town;

    64

int _cleared_town_rating;

    65

    66

/* Initialize the town-pool */

    67

DEFINE_OLD_POOL_GENERIC(Town, Town)

    68

    69

Town::Town(TileIndex tile)

    70

{

    71

	if (tile != 0) _total_towns++;

    72

	this->xy = tile;

    73

}

    74

    75

Town::~Town()

    76

{

    77

	free(this->name);

    78

    79

	if (CleaningPool()) return;

    80

    81

	Industry *i;

    82

    83

	/* Delete town authority window

    84

	 * and remove from list of sorted towns */

    85

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    86

	_town_sort_dirty = true;

    87

	_total_towns--;

    88

    89

	/* Delete all industries belonging to the town */

    90

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

    91

    92

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

    93

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

    94

		switch (GetTileType(tile)) {

    95

			case MP_HOUSE:

    96

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

    97

				break;

    98

    99

			case MP_ROAD:

   100

			case MP_TUNNELBRIDGE:

   101

				if (IsTileOwner(tile, OWNER_TOWN) &&

   102

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

   103

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

   104

				break;

   105

   106

			default:

   107

				break;

   108

		}

   109

	}

   110

   111

	DeleteSubsidyWithTown(this->index);

   112

   113

	MarkWholeScreenDirty();

   114

   115

	this->xy = 0;

   116

}

   117

   118

/**

   119

 * Generate a random town road layout.

   120

 *

   121

 * The layout is based on the TileHash.

   122

 */

   123

void Town::InitializeLayout()

   124

{

   125

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

   126

   127

	/* Set invalid layouts to valid ones */

   128

	switch (this->layout) {

   129

		default: break;

   130

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

   131

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

   132

	}

   133

}

   134

   135

// Local

   136

static int _grow_town_result;

   137

   138

/* Describe the possible states */

   139

enum TownGrowthResult {

   140

	GROWTH_SUCCEED         = -1,

   141

	GROWTH_SEARCH_STOPPED  =  0

   142

//	GROWTH_SEARCH_RUNNING >=  1

   143

};

   144

   145

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

   146

   147

static void TownDrawHouseLift(const TileInfo *ti)

   148

{

   149

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

   150

}

   151

   152

typedef void TownDrawTileProc(const TileInfo *ti);

   153

static TownDrawTileProc *const _town_draw_tile_procs[1] = {

   154

	TownDrawHouseLift

   155

};

   156

   157

/**

   158

 * Return a random direction

   159

 *

   160

 * @return a random direction

   161

 */

   162

static inline DiagDirection RandomDiagDir()

   163

{

   164

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

   165

}

   166

   167

/**

   168

 * House Tile drawing handler.

   169

 * Part of the tile loop process

   170

 * @param ti TileInfo of the tile to draw

   171

 */

   172

static void DrawTile_Town(TileInfo *ti)

   173

{

   174

	HouseID house_id = GetHouseType(ti->tile);

   175

   176

	if (house_id >= NEW_HOUSE_OFFSET) {

   177

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

   178

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

   179

		 * house id is drawn instead. */

   180

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

   181

			DrawNewHouseTile(ti, house_id);

   182

			return;

   183

		} else {

   184

			house_id = GetHouseSpecs(house_id)->substitute_id;

   185

		}

   186

	}

   187

   188

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

   189

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

   190

   191

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

   192

   193

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

   194

   195

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

   196

	if (IsInvisibilitySet(TO_HOUSES)) return;

   197

   198

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

   199

	SpriteID image = dcts->building.sprite;

   200

	if (image != 0) {

   201

		AddSortableSpriteToDraw(image, dcts->building.pal,

   202

			ti->x + dcts->subtile_x,

   203

			ti->y + dcts->subtile_y,

   204

			dcts->width,

   205

			dcts->height,

   206

			dcts->dz,

   207

			ti->z,

   208

			IsTransparencySet(TO_HOUSES)

   209

		);

   210

   211

		if (IsTransparencySet(TO_HOUSES)) return;

   212

	}

   213

   214

	{

   215

		int proc = dcts->draw_proc - 1;

   216

   217

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

   218

	}

   219

}

   220

   221

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

   222

{

   223

	return GetTileMaxZ(tile);

   224

}

   225

   226

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   227

{

   228

	return FlatteningFoundation(tileh);

   229

}

   230

   231

/**

   232

 * Animate a tile for a town

   233

 * Only certain houses can be animated

   234

 * The newhouses animation superseeds regular ones

   235

 * @param tile TileIndex of the house to animate

   236

 */

   237

static void AnimateTile_Town(TileIndex tile)

   238

{

   239

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   240

		AnimateNewHouseTile(tile);

   241

		return;

   242

	}

   243

   244

	if (_tick_counter & 3) return;

   245

   246

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

   247

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

   248

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

   249

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

   250

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

   251

		DeleteAnimatedTile(tile);

   252

		return;

   253

	}

   254

   255

	if (!LiftHasDestination(tile)) {

   256

		uint i;

   257

   258

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

   259

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

   260

		 *  the height of 2 'normal' floors.

   261

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

   262

		do {

   263

			i = RandomRange(7);

   264

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

   265

   266

		SetLiftDestination(tile, i);

   267

	}

   268

   269

	int pos = GetLiftPosition(tile);

   270

	int dest = GetLiftDestination(tile) * 6;

   271

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

   272

	SetLiftPosition(tile, pos);

   273

   274

	if (pos == dest) {

   275

		HaltLift(tile);

   276

		DeleteAnimatedTile(tile);

   277

	}

   278

   279

	MarkTileDirtyByTile(tile);

   280

}

   281

   282

/**

   283

 * Determines if a town is close to a tile

   284

 * @param tile TileIndex of the tile to query

   285

 * @param dist maximum distance to be accepted

   286

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

   287

 */

   288

static bool IsCloseToTown(TileIndex tile, uint dist)

   289

{

   290

	const Town *t;

   291

   292

	FOR_ALL_TOWNS(t) {

   293

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

   294

	}

   295

	return false;

   296

}

   297

   298

/**

   299

 * Marks the town sign as needing a repaint.

   300

 *

   301

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

   302

 *

   303

 * @param t Town requesting town sign for repaint

   304

 * @ingroup dirty

   305

 */

   306

static void MarkTownSignDirty(Town *t)

   307

{

   308

	MarkAllViewportsDirty(

   309

		t->sign.left - 6,

   310

		t->sign.top - 3,

   311

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

   312

		t->sign.top + 45

   313

	);

   314

}

   315

   316

/**

   317

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

   318

 * population (creation or growth or else)

   319

 * @param t Town to update

   320

 */

   321

void UpdateTownVirtCoord(Town *t)

   322

{

   323

	MarkTownSignDirty(t);

   324

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

   325

	SetDParam(0, t->index);

   326

	SetDParam(1, t->population);

   327

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

   328

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   329

	MarkTownSignDirty(t);

   330

}

   331

   332

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

   333

void UpdateAllTownVirtCoords()

   334

{

   335

	Town *t;

   336

	FOR_ALL_TOWNS(t) {

   337

		UpdateTownVirtCoord(t);

   338

	}

   339

}

   340

   341

/**

   342

 * Change the towns population

   343

 * @param t Town which polulation has changed

   344

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

   345

 */

   346

static void ChangePopulation(Town *t, int mod)

   347

{

   348

	t->population += mod;

   349

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   350

	UpdateTownVirtCoord(t);

   351

   352

	if (_town_sort_order & 2) _town_sort_dirty = true;

   353

}

   354

   355

/**

   356

 * Determines the world population

   357

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

   358

 * @return uint32 the calculated population of the world

   359

 */

   360

uint32 GetWorldPopulation()

   361

{

   362

	uint32 pop = 0;

   363

	const Town *t;

   364

   365

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

   366

	return pop;

   367

}

   368

   369

/**

   370

 * Helper function for house completion stages progression

   371

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

   372

 */

   373

static void MakeSingleHouseBigger(TileIndex tile)

   374

{

   375

	assert(IsTileType(tile, MP_HOUSE));

   376

   377

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

   378

	if (LiftHasDestination(tile)) return;

   379

   380

	/* progress in construction stages */

   381

	IncHouseConstructionTick(tile);

   382

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

   383

   384

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

   385

   386

	/* Check and/or  */

   387

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

   388

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

   389

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

   390

	}

   391

   392

	if (IsHouseCompleted(tile)) {

   393

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

   394

		 * building to the town. */

   395

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

   396

		SetHouseConstructionYear(tile, _cur_year);

   397

	}

   398

	MarkTileDirtyByTile(tile);

   399

}

   400

   401

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

   402

 * @param tile TileIndex of house

   403

 */

   404

static void MakeTownHouseBigger(TileIndex tile)

   405

{

   406

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

   407

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

   408

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

   409

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

   410

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

   411

}

   412

   413

/**

   414

 * Periodic tic handler for houses and town

   415

 * @param tile been asked to do its stuff

   416

 */

   417

static void TileLoop_Town(TileIndex tile)

   418

{

   419

	HouseID house_id = GetHouseType(tile);

   420

   421

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

   422

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

   423

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

   424

   425

	if (!IsHouseCompleted(tile)) {

   426

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

   427

		MakeTownHouseBigger(tile);

   428

		return;

   429

	}

   430

   431

	const HouseSpec *hs = GetHouseSpecs(house_id);

   432

   433

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

   434

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

   435

			house_id < NEW_HOUSE_OFFSET &&

   436

			!LiftHasDestination(tile) &&

   437

			Chance16(1, 2)) {

   438

		AddAnimatedTile(tile);

   439

	}

   440

   441

	Town *t = GetTownByTile(tile);

   442

	uint32 r = Random();

   443

   444

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

   445

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

   446

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

   447

   448

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

   449

   450

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

   451

			if (cargo == CT_INVALID) continue;

   452

   453

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

   454

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

   455

   456

			const CargoSpec *cs = GetCargo(cargo);

   457

			switch (cs->town_effect) {

   458

				case TE_PASSENGERS:

   459

					t->new_max_pass += amt;

   460

					t->new_act_pass += moved;

   461

					break;

   462

   463

				case TE_MAIL:

   464

					t->new_max_mail += amt;

   465

					t->new_act_mail += moved;

   466

					break;

   467

   468

				default:

   469

					break;

   470

			}

   471

		}

   472

	} else {

   473

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

   474

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

   475

   476

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

   477

			t->new_max_pass += amt;

   478

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

   479

		}

   480

   481

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

   482

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

   483

   484

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

   485

			t->new_max_mail += amt;

   486

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

   487

		}