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

    19

#include "player_base.h"

    20

#include "news.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

    43

#include "table/strings.h"

    44

#include "table/sprites.h"

    45

#include "table/town_land.h"

    46

    47

uint _total_towns;

    48

HouseSpec _house_specs[HOUSE_MAX];

    49

    50

bool _town_sort_dirty;

    51

byte _town_sort_order;

    52

const Town **_town_sort;

    53

    54

Town *_cleared_town;

    55

int _cleared_town_rating;

    56

    57

/* Initialize the town-pool */

    58

DEFINE_OLD_POOL_GENERIC(Town, Town)

    59

    60

Town::Town(TileIndex tile)

    61

{

    62

	if (tile != 0) _total_towns++;

    63

	this->xy = tile;

    64

}

    65

    66

Town::~Town()

    67

{

    68

	free(this->name);

    69

    70

	if (CleaningPool()) return;

    71

    72

	Industry *i;

    73

    74

	/* Delete town authority window

    75

	 * and remove from list of sorted towns */

    76

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    77

	_town_sort_dirty = true;

    78

	_total_towns--;

    79

    80

	/* Delete all industries belonging to the town */

    81

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

    82

    83

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

    84

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

    85

		switch (GetTileType(tile)) {

    86

			case MP_HOUSE:

    87

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

    88

				break;

    89

    90

			case MP_ROAD:

    91

			case MP_TUNNELBRIDGE:

    92

				if (IsTileOwner(tile, OWNER_TOWN) &&

    93

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

    94

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

    95

				break;

    96

    97

			default:

    98

				break;

    99

		}

   100

	}

   101

   102

	DeleteSubsidyWithTown(this->index);

   103

   104

	MarkWholeScreenDirty();

   105

   106

	this->xy = 0;

   107

}

   108

   109

// Local

   110

static int _grow_town_result;

   111

   112

/* Describe the possible states */

   113

enum TownGrowthResult {

   114

	GROWTH_SUCCEED         = -1,

   115

	GROWTH_SEARCH_STOPPED  =  0

   116

//	GROWTH_SEARCH_RUNNING >=  1

   117

};

   118

   119

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

   120

   121

static void TownDrawHouseLift(const TileInfo *ti)

   122

{

   123

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

   124

}

   125

   126

typedef void TownDrawTileProc(const TileInfo *ti);

   127

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   128

	TownDrawHouseLift

   129

};

   130

   131

uint OriginalTileRandomiser(uint x, uint y)

   132

{

   133

	uint variant;

   134

	variant  = x >> 4;

   135

	variant ^= x >> 6;

   136

	variant ^= y >> 4;

   137

	variant -= y >> 6;

   138

	variant &= 3;

   139

	return variant;

   140

}

   141

   142

/**

   143

 * Return a random direction

   144

 *

   145

 * @return a random direction

   146

 */

   147

static inline DiagDirection RandomDiagDir()

   148

{

   149

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

   150

}

   151

   152

/**

   153

 * House Tile drawing handler.

   154

 * Part of the tile loop process

   155

 * @param ti TileInfo of the tile to draw

   156

 */

   157

static void DrawTile_Town(TileInfo *ti)

   158

{

   159

	const DrawBuildingsTileStruct *dcts;

   160

	SpriteID image;

   161

	SpriteID pal;

   162

	HouseID house_id = GetHouseType(ti->tile);

   163

   164

	if (house_id >= NEW_HOUSE_OFFSET) {

   165

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

   166

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

   167

		 * house id is drawn instead. */

   168

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

   169

			DrawNewHouseTile(ti, house_id);

   170

			return;

   171

		} else {

   172

			house_id = GetHouseSpecs(house_id)->substitute_id;

   173

		}

   174

	}

   175

   176

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

   177

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

   178

   179

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

   180

   181

	image = dcts->ground.sprite;

   182

	pal   = dcts->ground.pal;

   183

	DrawGroundSprite(image, pal);

   184

   185

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

   186

	image = dcts->building.sprite;

   187

	if (image != 0) {

   188

		AddSortableSpriteToDraw(image, dcts->building.pal,

   189

			ti->x + dcts->subtile_x,

   190

			ti->y + dcts->subtile_y,

   191

			dcts->width,

   192

			dcts->height,

   193

			dcts->dz,

   194

			ti->z,

   195

			IsTransparencySet(TO_HOUSES)

   196

		);

   197

   198

		if (IsTransparencySet(TO_HOUSES)) return;

   199

	}

   200

   201

	{

   202

		int proc = dcts->draw_proc - 1;

   203

   204

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

   205

	}

   206

}

   207

   208

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

   209

{

   210

	return GetTileMaxZ(tile);

   211

}

   212

   213

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   214

{

   215

	return FlatteningFoundation(tileh);

   216

}

   217

   218

/**

   219

 * Animate a tile for a town

   220

 * Only certain houses can be animated

   221

 * The newhouses animation superseeds regular ones

   222

 * @param tile TileIndex of the house to animate

   223

 */

   224

static void AnimateTile_Town(TileIndex tile)

   225

{

   226

	int pos, dest;

   227

   228

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   229

		AnimateNewHouseTile(tile);

   230

		return;

   231

	}

   232

   233

	if (_tick_counter & 3) return;

   234

   235

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

   236

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

   237

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

   238

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

   239

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

   240

		DeleteAnimatedTile(tile);

   241

		return;

   242

	}

   243

   244

	if (!LiftHasDestination(tile)) {

   245

		int i;

   246

   247

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

   248

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

   249

		 *  the height of 2 'normal' floors.

   250

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

   251

		do {

   252

			i = (Random() & 7) - 1;

   253

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

   254

   255

		SetLiftDestination(tile, i);

   256

	}

   257

   258

	pos = GetLiftPosition(tile);

   259

	dest = GetLiftDestination(tile) * 6;

   260

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

   261

	SetLiftPosition(tile, pos);

   262

   263

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

   264

   265

	MarkTileDirtyByTile(tile);

   266

}

   267

   268

static void UpdateTownRadius(Town *t);

   269

   270

/**

   271

 * Determines if a town is close to a tile

   272

 * @param tile TileIndex of the tile to query

   273

 * @param dist maximum distance to be accepted

   274

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

   275

 */

   276

static bool IsCloseToTown(TileIndex tile, uint dist)

   277

{

   278

	const Town* t;

   279

   280

	FOR_ALL_TOWNS(t) {

   281

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

   282

	}

   283

	return false;

   284

}

   285

   286

/**

   287

 * Marks the town sign as needing a repaint.

   288

 *

   289

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

   290

 *

   291

 * @param t Town requesting town sign for repaint

   292

 * @ingroup dirty

   293

 */

   294

static void MarkTownSignDirty(Town *t)

   295

{

   296

	MarkAllViewportsDirty(

   297

		t->sign.left - 6,

   298

		t->sign.top - 3,

   299

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

   300

		t->sign.top + 45

   301

	);

   302

}

   303

   304

/**

   305

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

   306

 * population (creation or growth or else)

   307

 * @param t Town to update

   308

 */

   309

void UpdateTownVirtCoord(Town *t)

   310

{

   311

	Point pt;

   312

   313

	MarkTownSignDirty(t);

   314

	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;

   353

	const Town* t;

   354

   355

	pop = 0;

   356

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

   357

	return pop;

   358

}

   359

   360

/**

   361

 * Helper function for house completion stages progression

   362

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

   363

 */

   364

static void MakeSingleHouseBigger(TileIndex tile)

   365

{

   366

	assert(IsTileType(tile, MP_HOUSE));

   367

   368

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

   369

	if (LiftHasDestination(tile)) return;

   370

   371

	/* progress in construction stages */

   372

	IncHouseConstructionTick(tile);

   373

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

   374

   375

	/* Check and/or  */

   376

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

   377

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

   378

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

   379

	}

   380

   381

	if (IsHouseCompleted(tile)) {

   382

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

   383

		 * building to the town. */

   384

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

   385

	}

   386

	MarkTileDirtyByTile(tile);

   387

}

   388

   389

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

   390

 * @param tile TileIndex of house

   391

 */

   392

static void MakeTownHouseBigger(TileIndex tile)

   393

{

   394

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

   395

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

   396

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

   397

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

   398

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

   399

}

   400

   401

/**

   402

 * Periodic tic handler for houses and town

   403

 * @param tile been asked to do its stuff

   404

 */

   405

static void TileLoop_Town(TileIndex tile)

   406

{

   407

	Town *t;

   408

	uint32 r;

   409

	HouseID house_id = GetHouseType(tile);

   410

	HouseSpec *hs = GetHouseSpecs(house_id);

   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

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

   423

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

   424

			house_id < NEW_HOUSE_OFFSET &&

   425

			!LiftHasDestination(tile) &&

   426

			Chance16(1, 2))

   427

		AddAnimatedTile(tile);

   428

   429

	t = GetTownByTile(tile);

   430

   431

	r = Random();

   432

   433

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

   434

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

   435

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

   436

   437

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

   438

   439

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

   440

			if (cargo == CT_INVALID) continue;

   441

   442

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

   443

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

   444

   445

			const CargoSpec *cs = GetCargo(cargo);

   446

			switch (cs->town_effect) {

   447

				case TE_PASSENGERS:

   448

					t->new_max_pass += amt;

   449

					t->new_act_pass += moved;

   450

					break;

   451

   452

				case TE_MAIL:

   453

					t->new_max_mail += amt;

   454

					t->new_act_mail += moved;

   455

					break;

   456

   457

				default:

   458

					break;

   459

			}

   460

		}

   461

	} else {

   462

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

   463

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

   464

			uint moved;

   465

   466

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

   467

			t->new_max_pass += amt;

   468

			moved = MoveGoodsToStation(tile, 1, 1, CT_PASSENGERS, amt);

   469

			t->new_act_pass += moved;

   470

		}

   471

   472

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

   473

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

   474

			uint moved;

   475

   476

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

   477

			t->new_max_mail += amt;

   478

			moved = MoveGoodsToStation(tile, 1, 1, CT_MAIL, amt);

   479

			t->new_act_mail += moved;

   480

		}

   481

	}

   482

   483

	_current_player = OWNER_TOWN;

   484

   485

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   486

			HasBit(t->flags12, TOWN_IS_FUNDED) &&

   487

			CanDeleteHouse(tile) &&

   488

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

   489