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 "table/strings.h"

    12

#include "table/sprites.h"

    13

#include "landscape.h"

    14

#include "town_map.h"

    15

#include "tunnel_map.h"

    16

#include "viewport.h"

    17

#include "town.h"

    18

#include "command_func.h"

    19

#include "industry.h"

    20

#include "station.h"

    21

#include "player.h"

    22

#include "news.h"

    23

#include "saveload.h"

    24

#include "gui.h"

    25

#include "unmovable_map.h"

    26

#include "water_map.h"

    27

#include "variables.h"

    28

#include "bridge.h"

    29

#include "bridge_map.h"

    30

#include "table/town_land.h"

    31

#include "genworld.h"

    32

#include "newgrf.h"

    33

#include "newgrf_callbacks.h"

    34

#include "newgrf_house.h"

    35

#include "newgrf_commons.h"

    36

#include "newgrf_townname.h"

    37

#include "misc/autoptr.hpp"

    38

#include "autoslope.h"

    39

#include "waypoint.h"

    40

#include "transparency.h"

    41

#include "tunnelbridge_map.h"

    42

#include "strings_func.h"

    43

#include "string.h"

    44

#include "window_func.h"

    45

    46

    47

/* Initialize the town-pool */

    48

DEFINE_OLD_POOL_GENERIC(Town, Town)

    49

    50

Town::Town(TileIndex tile)

    51

{

    52

	if (tile != 0) _total_towns++;

    53

	this->xy = tile;

    54

}

    55

    56

Town::~Town()

    57

{

    58

	DeleteName(this->townnametype);

    59

    60

	if (CleaningPool()) return;

    61

    62

	Industry *i;

    63

    64

	/* Delete town authority window

    65

	 * and remove from list of sorted towns */

    66

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    67

	_town_sort_dirty = true;

    68

	_total_towns--;

    69

    70

	/* Delete all industries belonging to the town */

    71

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

    72

    73

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

    74

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

    75

		switch (GetTileType(tile)) {

    76

			case MP_HOUSE:

    77

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

    78

				break;

    79

    80

			case MP_ROAD:

    81

			case MP_TUNNELBRIDGE:

    82

				if (IsTileOwner(tile, OWNER_TOWN) &&

    83

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

    84

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

    85

				break;

    86

    87

			default:

    88

				break;

    89

		}

    90

	}

    91

    92

	DeleteSubsidyWithTown(this->index);

    93

    94

	MarkWholeScreenDirty();

    95

    96

	this->xy = 0;

    97

}

    98

    99

// Local

   100

static int _grow_town_result;

   101

   102

/* Describe the possible states */

   103

enum TownGrowthResult {

   104

	GROWTH_SUCCEED         = -1,

   105

	GROWTH_SEARCH_STOPPED  =  0

   106

//	GROWTH_SEARCH_RUNNING >=  1

   107

};

   108

   109

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

   110

static void DoBuildTownHouse(Town *t, TileIndex tile);

   111

   112

static void TownDrawHouseLift(const TileInfo *ti)

   113

{

   114

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

   115

}

   116

   117

typedef void TownDrawTileProc(const TileInfo *ti);

   118

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   119

	TownDrawHouseLift

   120

};

   121

   122

uint OriginalTileRandomiser(uint x, uint y)

   123

{

   124

	uint variant;

   125

	variant  = x >> 4;

   126

	variant ^= x >> 6;

   127

	variant ^= y >> 4;

   128

	variant -= y >> 6;

   129

	variant &= 3;

   130

	return variant;

   131

}

   132

   133

/**

   134

 * Return a random direction

   135

 *

   136

 * @return a random direction

   137

 */

   138

static inline DiagDirection RandomDiagDir()

   139

{

   140

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

   141

}

   142

   143

/**

   144

 * House Tile drawing handler.

   145

 * Part of the tile loop process

   146

 * @param ti TileInfo of the tile to draw

   147

 */

   148

static void DrawTile_Town(TileInfo *ti)

   149

{

   150

	const DrawBuildingsTileStruct *dcts;

   151

	SpriteID image;

   152

	SpriteID pal;

   153

	HouseID house_id = GetHouseType(ti->tile);

   154

   155

	if (house_id >= NEW_HOUSE_OFFSET) {

   156

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

   157

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

   158

		 * house id is drawn instead. */

   159

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

   160

			DrawNewHouseTile(ti, house_id);

   161

			return;

   162

		} else {

   163

			house_id = GetHouseSpecs(house_id)->substitute_id;

   164

		}

   165

	}

   166

   167

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

   168

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

   169

   170

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

   171

   172

	image = dcts->ground.sprite;

   173

	pal   = dcts->ground.pal;

   174

	DrawGroundSprite(image, pal);

   175

   176

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

   177

	image = dcts->building.sprite;

   178

	if (image != 0) {

   179

		AddSortableSpriteToDraw(image, dcts->building.pal,

   180

			ti->x + dcts->subtile_x,

   181

			ti->y + dcts->subtile_y,

   182

			dcts->width,

   183

			dcts->height,

   184

			dcts->dz,

   185

			ti->z,

   186

			IsTransparencySet(TO_HOUSES)

   187

		);

   188

   189

		if (IsTransparencySet(TO_HOUSES)) return;

   190

	}

   191

   192

	{

   193

		int proc = dcts->draw_proc - 1;

   194

   195

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

   196

	}

   197

}

   198

   199

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

   200

{

   201

	return GetTileMaxZ(tile);

   202

}

   203

   204

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   205

{

   206

	return FlatteningFoundation(tileh);

   207

}

   208

   209

/**

   210

 * Animate a tile for a town

   211

 * Only certain houses can be animated

   212

 * The newhouses animation superseeds regular ones

   213

 * @param tile TileIndex of the house to animate

   214

 */

   215

static void AnimateTile_Town(TileIndex tile)

   216

{

   217

	int pos, dest;

   218

   219

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   220

		AnimateNewHouseTile(tile);

   221

		return;

   222

	}

   223

   224

	if (_tick_counter & 3) return;

   225

   226

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

   227

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

   228

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

   229

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

   230

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

   231

		DeleteAnimatedTile(tile);

   232

		return;

   233

	}

   234

   235

	if (!LiftHasDestination(tile)) {

   236

		int i;

   237

   238

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

   239

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

   240

		 *  the height of 2 'normal' floors.

   241

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

   242

		do {

   243

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

   244

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

   245

   246

		SetLiftDestination(tile, i);

   247

	}

   248

   249

	pos = GetLiftPosition(tile);

   250

	dest = GetLiftDestination(tile) * 6;

   251

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

   252

	SetLiftPosition(tile, pos);

   253

   254

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

   255

   256

	MarkTileDirtyByTile(tile);

   257

}

   258

   259

static void UpdateTownRadius(Town *t);

   260

   261

/**

   262

 * Determines if a town is close to a tile

   263

 * @param tile TileIndex of the tile to query

   264

 * @param dist maximum distance to be accepted

   265

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

   266

 */

   267

static bool IsCloseToTown(TileIndex tile, uint dist)

   268

{

   269

	const Town* t;

   270

   271

	FOR_ALL_TOWNS(t) {

   272

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

   273

	}

   274

	return false;

   275

}

   276

   277

/**

   278

 * Marks the town sign as needing a repaint.

   279

 *

   280

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

   281

 *

   282

 * @param t Town requesting town sign for repaint

   283

 * @ingroup dirty

   284

 */

   285

static void MarkTownSignDirty(Town *t)

   286

{

   287

	MarkAllViewportsDirty(

   288

		t->sign.left - 6,

   289

		t->sign.top - 3,

   290

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

   291

		t->sign.top + 45

   292

	);

   293

}

   294

   295

/**

   296

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

   297

 * population (creation or growth or else)

   298

 * @param t Town to update

   299

 */

   300

void UpdateTownVirtCoord(Town *t)

   301

{

   302

	Point pt;

   303

   304

	MarkTownSignDirty(t);

   305

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

   306

	SetDParam(0, t->index);

   307

	SetDParam(1, t->population);

   308

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

   309

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   310

	MarkTownSignDirty(t);

   311

}

   312

   313

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

   314

void UpdateAllTownVirtCoords()

   315

{

   316

	Town *t;

   317

	FOR_ALL_TOWNS(t) {

   318

		UpdateTownVirtCoord(t);

   319

	}

   320

}

   321

   322

/**

   323

 * Change the towns population

   324

 * @param t Town which polulation has changed

   325

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

   326

 */

   327

static void ChangePopulation(Town *t, int mod)

   328

{

   329

	t->population += mod;

   330

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   331

	UpdateTownVirtCoord(t);

   332

   333

	if (_town_sort_order & 2) _town_sort_dirty = true;

   334

}

   335

   336

/**

   337

 * Determines the world population

   338

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

   339

 * @return uint32 the calculated population of the world

   340

 */

   341

uint32 GetWorldPopulation()

   342

{

   343

	uint32 pop;

   344

	const Town* t;

   345

   346

	pop = 0;

   347

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

   348

	return pop;

   349

}

   350

   351

/**

   352

 * Helper function for house completion stages progression

   353

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

   354

 */

   355

static void MakeSingleHouseBigger(TileIndex tile)

   356

{

   357

	assert(IsTileType(tile, MP_HOUSE));

   358

   359

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

   360

	if (LiftHasDestination(tile)) return;

   361

   362

	/* progress in construction stages */

   363

	IncHouseConstructionTick(tile);

   364

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

   365

   366

	/* Check and/or  */

   367

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

   368

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

   369

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

   370

	}

   371

   372

	if (IsHouseCompleted(tile)) {

   373

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

   374

		 * building to the town. */

   375

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

   376

	}

   377

	MarkTileDirtyByTile(tile);

   378

}

   379

   380

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

   381

 * @param tile TileIndex of house

   382

 */

   383

static void MakeTownHouseBigger(TileIndex tile)

   384

{

   385

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

   386

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

   387

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

   388

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

   389

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

   390

}

   391

   392

/**

   393

 * Periodic tic handler for houses and town

   394

 * @param tile been asked to do its stuff

   395

 */

   396

static void TileLoop_Town(TileIndex tile)

   397

{

   398

	Town *t;

   399

	uint32 r;

   400

	HouseID house_id = GetHouseType(tile);

   401

	HouseSpec *hs = GetHouseSpecs(house_id);

   402

   403

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

   404

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

   405

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

   406

   407

	if (!IsHouseCompleted(tile)) {

   408

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

   409

		MakeTownHouseBigger(tile);

   410

		return;

   411

	}

   412

   413

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

   414

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

   415

			house_id < NEW_HOUSE_OFFSET &&

   416

			!LiftHasDestination(tile) &&

   417

			Chance16(1, 2))

   418

		AddAnimatedTile(tile);

   419

   420

	t = GetTownByTile(tile);

   421

   422

	r = Random();

   423

   424

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

   425

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

   426

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

   427

   428

			if (callback == CALLBACK_FAILED) break;

   429

			if (callback == 0x20FF) break;

   430

   431

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

   432

			if (cargo == CT_INVALID) continue;

   433

   434

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

   435

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

   436

   437

			const CargoSpec *cs = GetCargo(cargo);

   438

			switch (cs->town_effect) {

   439

				case TE_PASSENGERS:

   440

					t->new_max_pass += amt;

   441

					t->new_act_pass += moved;

   442

					break;

   443

   444

				case TE_MAIL:

   445

					t->new_max_mail += amt;

   446

					t->new_act_mail += moved;

   447

					break;

   448

   449

				default:

   450

					break;

   451

			}

   452

		}

   453

	} else {

   454

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

   455

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

   456

			uint moved;

   457

   458

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

   459

			t->new_max_pass += amt;

   460

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

   461

			t->new_act_pass += moved;

   462

		}

   463

   464

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

   465

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

   466

			uint moved;

   467

   468

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

   469

			t->new_max_mail += amt;

   470

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

   471

			t->new_act_mail += moved;

   472

		}

   473

	}

   474

   475

	_current_player = OWNER_TOWN;

   476

   477

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   478

			HasBit(t->flags12, TOWN_IS_FUNDED) &&

   479

			CanDeleteHouse(tile) &&

   480

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

   481

			--t->time_until_rebuild == 0) {

   482

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

   483

   484

		ClearTownHouse(t, tile);

   485

   486

		/* Rebuild with another house? */

   487

		if (GB(r, 24, 8) >= 12) DoBuildTownHouse(t, tile);

   488

	}