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

    35

#include "waypoint.h"

    36

#include "transparency.h"

    37

#include "tunnelbridge_map.h"

    38

#include "strings_func.h"

    39

#include "window_func.h"

    40

#include "string_func.h"

    41

    42

#include "table/strings.h"

    43

#include "table/sprites.h"

    44

#include "table/town_land.h"

    45

    46

#include <map>

    47

    48

uint _total_towns;

    49

HouseSpec _house_specs[HOUSE_MAX];

    50

    51

bool _town_sort_dirty;

    52

byte _town_sort_order;

    53

const Town **_town_sort;

    54

    55

Town *_cleared_town;

    56

int _cleared_town_rating;

    57

    58

/* Initialize the town-pool */

    59

DEFINE_OLD_POOL_GENERIC(Town, Town)

    60

    61

Town::Town(TileIndex tile)

    62

{

    63

	if (tile != 0) _total_towns++;

    64

	this->xy = tile;

    65

}

    66

    67

Town::~Town()

    68

{

    69

	free(this->name);

    70

    71

	if (CleaningPool()) return;

    72

    73

	Industry *i;

    74

    75

	/* Delete town authority window

    76

	 * and remove from list of sorted towns */

    77

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    78

	_town_sort_dirty = true;

    79

	_total_towns--;

    80

    81

	/* Delete all industries belonging to the town */

    82

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

    83

    84

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

    85

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

    86

		switch (GetTileType(tile)) {

    87

			case MP_HOUSE:

    88

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

    89

				break;

    90

    91

			case MP_ROAD:

    92

			case MP_TUNNELBRIDGE:

    93

				if (IsTileOwner(tile, OWNER_TOWN) &&

    94

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

    95

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

    96

				break;

    97

    98

			default:

    99

				break;

   100

		}

   101

	}

   102

   103

	DeleteSubsidyWithTown(this->index);

   104

   105

	MarkWholeScreenDirty();

   106

   107

	this->xy = 0;

   108

}

   109

   110

// Local

   111

static int _grow_town_result;

   112

   113

/* Describe the possible states */

   114

enum TownGrowthResult {

   115

	GROWTH_SUCCEED         = -1,

   116

	GROWTH_SEARCH_STOPPED  =  0

   117

//	GROWTH_SEARCH_RUNNING >=  1

   118

};

   119

   120

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

   121

   122

static void TownDrawHouseLift(const TileInfo *ti)

   123

{

   124

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

   125

}

   126

   127

typedef void TownDrawTileProc(const TileInfo *ti);

   128

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   129

	TownDrawHouseLift

   130

};

   131

   132

uint OriginalTileRandomiser(uint x, uint y)

   133

{

   134

	uint variant;

   135

	variant  = x >> 4;

   136

	variant ^= x >> 6;

   137

	variant ^= y >> 4;

   138

	variant -= y >> 6;

   139

	variant &= 3;

   140

	return variant;

   141

}

   142

   143

/**

   144

 * Return a random direction

   145

 *

   146

 * @return a random direction

   147

 */

   148

static inline DiagDirection RandomDiagDir()

   149

{

   150

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

   151

}

   152

   153

/**

   154

 * House Tile drawing handler.

   155

 * Part of the tile loop process

   156

 * @param ti TileInfo of the tile to draw

   157

 */

   158

static void DrawTile_Town(TileInfo *ti)

   159

{

   160

	const DrawBuildingsTileStruct *dcts;

   161

	SpriteID image;

   162

	SpriteID pal;

   163

	HouseID house_id = GetHouseType(ti->tile);

   164

   165

	if (house_id >= NEW_HOUSE_OFFSET) {

   166

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

   167

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

   168

		 * house id is drawn instead. */

   169

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

   170

			DrawNewHouseTile(ti, house_id);

   171

			return;

   172

		} else {

   173

			house_id = GetHouseSpecs(house_id)->substitute_id;

   174

		}

   175

	}

   176

   177

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

   178

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

   179

   180

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

   181

   182

	image = dcts->ground.sprite;

   183

	pal   = dcts->ground.pal;

   184

	DrawGroundSprite(image, pal);

   185

   186

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

   187

	image = dcts->building.sprite;

   188

	if (image != 0) {

   189

		AddSortableSpriteToDraw(image, dcts->building.pal,

   190

			ti->x + dcts->subtile_x,

   191

			ti->y + dcts->subtile_y,

   192

			dcts->width,

   193

			dcts->height,

   194

			dcts->dz,

   195

			ti->z,

   196

			IsTransparencySet(TO_HOUSES)

   197

		);

   198

   199

		if (IsTransparencySet(TO_HOUSES)) return;

   200

	}

   201

   202

	{

   203

		int proc = dcts->draw_proc - 1;

   204

   205

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

   206

	}

   207

}

   208

   209

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

   210

{

   211

	return GetTileMaxZ(tile);

   212

}

   213

   214

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   215

{

   216

	return FlatteningFoundation(tileh);

   217

}

   218

   219

/**

   220

 * Animate a tile for a town

   221

 * Only certain houses can be animated

   222

 * The newhouses animation superseeds regular ones

   223

 * @param tile TileIndex of the house to animate

   224

 */

   225

static void AnimateTile_Town(TileIndex tile)

   226

{

   227

	int pos, dest;

   228

   229

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   230

		AnimateNewHouseTile(tile);

   231

		return;

   232

	}

   233

   234

	if (_tick_counter & 3) return;

   235

   236

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

   237

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

   238

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

   239

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

   240

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

   241

		DeleteAnimatedTile(tile);

   242

		return;

   243

	}

   244

   245

	if (!LiftHasDestination(tile)) {

   246

		int i;

   247

   248

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

   249

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

   250

		 *  the height of 2 'normal' floors.

   251

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

   252

		do {

   253

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

   254

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

   255

   256

		SetLiftDestination(tile, i);

   257

	}

   258

   259

	pos = GetLiftPosition(tile);

   260

	dest = GetLiftDestination(tile) * 6;

   261

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

   262

	SetLiftPosition(tile, pos);

   263

   264

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

   265

   266

	MarkTileDirtyByTile(tile);

   267

}

   268

   269

/**

   270

 * Determines if a town is close to a tile

   271

 * @param tile TileIndex of the tile to query

   272

 * @param dist maximum distance to be accepted

   273

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

   274

 */

   275

static bool IsCloseToTown(TileIndex tile, uint dist)

   276

{

   277

	const Town* t;

   278

   279

	FOR_ALL_TOWNS(t) {

   280

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

   281

	}

   282

	return false;

   283

}

   284

   285

/**

   286

 * Marks the town sign as needing a repaint.

   287

 *

   288

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

   289

 *

   290

 * @param t Town requesting town sign for repaint

   291

 * @ingroup dirty

   292

 */

   293

static void MarkTownSignDirty(Town *t)

   294

{

   295

	MarkAllViewportsDirty(

   296

		t->sign.left - 6,

   297

		t->sign.top - 3,

   298

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

   299

		t->sign.top + 45

   300

	);

   301

}

   302

   303

/**

   304

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

   305

 * population (creation or growth or else)

   306

 * @param t Town to update

   307

 */

   308

void UpdateTownVirtCoord(Town *t)

   309

{

   310

	Point pt;

   311

   312

	MarkTownSignDirty(t);

   313

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

   314

	SetDParam(0, t->index);

   315

	SetDParam(1, t->population);

   316

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

   317

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   318

	MarkTownSignDirty(t);

   319

}

   320

   321

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

   322

void UpdateAllTownVirtCoords()

   323

{

   324

	Town *t;

   325

	FOR_ALL_TOWNS(t) {

   326

		UpdateTownVirtCoord(t);

   327

	}

   328

}

   329

   330

/**

   331

 * Change the towns population

   332

 * @param t Town which polulation has changed

   333

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

   334

 */

   335

static void ChangePopulation(Town *t, int mod)

   336

{

   337

	t->population += mod;

   338

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   339

	UpdateTownVirtCoord(t);

   340

   341

	if (_town_sort_order & 2) _town_sort_dirty = true;

   342

}

   343

   344

/**

   345

 * Determines the world population

   346

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

   347

 * @return uint32 the calculated population of the world

   348

 */

   349

uint32 GetWorldPopulation()

   350

{

   351

	uint32 pop;

   352

	const Town* t;

   353

   354

	pop = 0;

   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

	Town *t;

   407

	uint32 r;

   408

	HouseID house_id = GetHouseType(tile);

   409

	HouseSpec *hs = GetHouseSpecs(house_id);

   410

   411

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

   412

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

   413

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

   414

   415

	if (!IsHouseCompleted(tile)) {

   416

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

   417

		MakeTownHouseBigger(tile);

   418

		return;

   419

	}

   420

   421

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

   422

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

   423

			house_id < NEW_HOUSE_OFFSET &&

   424

			!LiftHasDestination(tile) &&

   425

			Chance16(1, 2))

   426

		AddAnimatedTile(tile);

   427

   428

	t = GetTownByTile(tile);

   429

   430

	r = Random();

   431

   432

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

   433

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

   434

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

   435

   436

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

   437

   438

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

   439

			if (cargo == CT_INVALID) continue;

   440

   441

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

   442

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

   443

   444

			const CargoSpec *cs = GetCargo(cargo);

   445

			switch (cs->town_effect) {

   446

				case TE_PASSENGERS:

   447

					t->new_max_pass += amt;

   448

					t->new_act_pass += moved;

   449

					break;

   450

   451

				case TE_MAIL:

   452

					t->new_max_mail += amt;

   453

					t->new_act_mail += moved;

   454

					break;

   455

   456

				default:

   457

					break;

   458

			}

   459

		}

   460

	} else {

   461

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

   462

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

   463

			uint moved;

   464

   465

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

   466

			t->new_max_pass += amt;

   467

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

   468

			t->new_act_pass += moved;

   469

		}

   470

   471

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

   472

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

   473

			uint moved;

   474

   475

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

   476

			t->new_max_mail += amt;

   477

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

   478

			t->new_act_mail += moved;

   479

		}

   480

	}

   481

   482

	_current_player = OWNER_TOWN;

   483

   484

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   485

			HasBit(t->flags12, TOWN_IS_FUNDED) &&

   486

			CanDeleteHouse(tile) &&

   487

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