1

/* $Id$ */

     2

     3

/** @file town_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "debug.h"

     9

#include "strings.h"

    10

#include "road_map.h"

    11

#include "road_internal.h" /* Cleaning up road bits */

    12

#include "table/strings.h"

    13

#include "table/sprites.h"

    14

#include "map.h"

    15

#include "landscape.h"

    16

#include "town_map.h"

    17

#include "tunnel_map.h"

    18

#include "viewport.h"

    19

#include "town.h"

    20

#include "command.h"

    21

#include "gfx.h"

    22

#include "industry.h"

    23

#include "station.h"

    24

#include "vehicle.h"

    25

#include "player.h"

    26

#include "news.h"

    27

#include "saveload.h"

    28

#include "economy.h"

    29

#include "gui.h"

    30

#include "unmovable_map.h"

    31

#include "water_map.h"

    32

#include "variables.h"

    33

#include "bridge.h"

    34

#include "bridge_map.h"

    35

#include "date.h"

    36

#include "table/town_land.h"

    37

#include "genworld.h"

    38

#include "newgrf.h"

    39

#include "newgrf_callbacks.h"

    40

#include "newgrf_house.h"

    41

#include "newgrf_commons.h"

    42

#include "newgrf_townname.h"

    43

#include "misc/autoptr.hpp"

    44

#include "autoslope.h"

    45

#include "waypoint.h"

    46

#include "transparency.h"

    47

#include "tunnelbridge_map.h"

    48

    49

    50

/* Initialize the town-pool */

    51

DEFINE_OLD_POOL_GENERIC(Town, Town)

    52

    53

Town::Town(TileIndex tile)

    54

{

    55

	if (tile != 0) _total_towns++;

    56

	this->xy = tile;

    57

}

    58

    59

Town::~Town()

    60

{

    61

	DeleteName(this->townnametype);

    62

    63

	if (CleaningPool()) return;

    64

    65

	Industry *i;

    66

    67

	/* Delete town authority window

    68

	 * and remove from list of sorted towns */

    69

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    70

	_town_sort_dirty = true;

    71

	_total_towns--;

    72

    73

	/* Delete all industries belonging to the town */

    74

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

    75

    76

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

    77

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

    78

		switch (GetTileType(tile)) {

    79

			case MP_HOUSE:

    80

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

    81

				break;

    82

    83

			case MP_ROAD:

    84

			case MP_TUNNELBRIDGE:

    85

				if (IsTileOwner(tile, OWNER_TOWN) &&

    86

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

    87

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

    88

				break;

    89

    90

			default:

    91

				break;

    92

		}

    93

	}

    94

    95

	DeleteSubsidyWithTown(this->index);

    96

    97

	MarkWholeScreenDirty();

    98

    99

	this->xy = 0;

   100

}

   101

   102

// Local

   103

static int _grow_town_result;

   104

   105

/* Describe the possible states */

   106

enum TownGrowthResult {

   107

	GROWTH_SUCCEED         = -1,

   108

	GROWTH_SEARCH_STOPPED  =  0

   109

//	GROWTH_SEARCH_RUNNING >=  1

   110

};

   111

   112

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

   113

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

   114

   115

static void TownDrawHouseLift(const TileInfo *ti)

   116

{

   117

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

   118

}

   119

   120

typedef void TownDrawTileProc(const TileInfo *ti);

   121

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   122

	TownDrawHouseLift

   123

};

   124

   125

uint OriginalTileRandomiser(uint x, uint y)

   126

{

   127

	uint variant;

   128

	variant  = x >> 4;

   129

	variant ^= x >> 6;

   130

	variant ^= y >> 4;

   131

	variant -= y >> 6;

   132

	variant &= 3;

   133

	return variant;

   134

}

   135

   136

/**

   137

 * Return a random direction

   138

 *

   139

 * @return a random direction

   140

 */

   141

static inline DiagDirection RandomDiagDir()

   142

{

   143

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

   144

}

   145

   146

/**

   147

 * House Tile drawing handler.

   148

 * Part of the tile loop process

   149

 * @param ti TileInfo of the tile to draw

   150

 */

   151

static void DrawTile_Town(TileInfo *ti)

   152

{

   153

	const DrawBuildingsTileStruct *dcts;

   154

	SpriteID image;

   155

	SpriteID pal;

   156

	HouseID house_id = GetHouseType(ti->tile);

   157

   158

	if (house_id >= NEW_HOUSE_OFFSET) {

   159

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

   160

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

   161

		 * house id is drawn instead. */

   162

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

   163

			DrawNewHouseTile(ti, house_id);

   164

			return;

   165

		} else {

   166

			house_id = GetHouseSpecs(house_id)->substitute_id;

   167

		}

   168

	}

   169

   170

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

   171

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

   172

   173

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

   174

   175

	image = dcts->ground.sprite;

   176

	pal   = dcts->ground.pal;

   177

	DrawGroundSprite(image, pal);

   178

   179

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

   180

	image = dcts->building.sprite;

   181

	if (image != 0) {

   182

		AddSortableSpriteToDraw(image, dcts->building.pal,

   183

			ti->x + dcts->subtile_x,

   184

			ti->y + dcts->subtile_y,

   185

			dcts->width,

   186

			dcts->height,

   187

			dcts->dz,

   188

			ti->z,

   189

			IsTransparencySet(TO_HOUSES)

   190

		);

   191

   192

		if (IsTransparencySet(TO_HOUSES)) return;

   193

	}

   194

   195

	{

   196

		int proc = dcts->draw_proc - 1;

   197

   198

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

   199

	}

   200

}

   201

   202

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

   203

{

   204

	return GetTileMaxZ(tile);

   205

}

   206

   207

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   208

{

   209

	return FlatteningFoundation(tileh);

   210

}

   211

   212

/**

   213

 * Animate a tile for a town

   214

 * Only certain houses can be animated

   215

 * The newhouses animation superseeds regular ones

   216

 * @param tile TileIndex of the house to animate

   217

 */

   218

static void AnimateTile_Town(TileIndex tile)

   219

{

   220

	int pos, dest;

   221

   222

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   223

		AnimateNewHouseTile(tile);

   224

		return;

   225

	}

   226

   227

	if (_tick_counter & 3) return;

   228

   229

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

   230

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

   231

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

   232

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

   233

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

   234

		DeleteAnimatedTile(tile);

   235

		return;

   236

	}

   237

   238

	if (!LiftHasDestination(tile)) {

   239

		int i;

   240

   241

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

   242

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

   243

		 *  the height of 2 'normal' floors.

   244

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

   245

		do {

   246

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

   247

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

   248

   249

		SetLiftDestination(tile, i);

   250

	}

   251

   252

	pos = GetLiftPosition(tile);

   253

	dest = GetLiftDestination(tile) * 6;

   254

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

   255

	SetLiftPosition(tile, pos);

   256

   257

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

   258

   259

	MarkTileDirtyByTile(tile);

   260

}

   261

   262

static void UpdateTownRadius(Town *t);

   263

   264

/**

   265

 * Determines if a town is close to a tile

   266

 * @param tile TileIndex of the tile to query

   267

 * @param dist maximum distance to be accepted

   268

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

   269

 */

   270

static bool IsCloseToTown(TileIndex tile, uint dist)

   271

{

   272

	const Town* t;

   273

   274

	FOR_ALL_TOWNS(t) {

   275

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

   276

	}

   277

	return false;

   278

}

   279

   280

/**

   281

 * Marks the town sign as needing a repaint.

   282

 *

   283

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

   284

 *

   285

 * @param t Town requesting town sign for repaint

   286

 * @ingroup dirty

   287

 */

   288

static void MarkTownSignDirty(Town *t)

   289

{

   290

	MarkAllViewportsDirty(

   291

		t->sign.left - 6,

   292

		t->sign.top - 3,

   293

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

   294

		t->sign.top + 45

   295

	);

   296

}

   297

   298

/**

   299

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

   300

 * population (creation or growth or else)

   301

 * @param t Town to update

   302

 */

   303

void UpdateTownVirtCoord(Town *t)

   304

{

   305

	Point pt;

   306

   307

	MarkTownSignDirty(t);

   308

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

   309

	SetDParam(0, t->index);

   310

	SetDParam(1, t->population);

   311

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

   312

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   313

	MarkTownSignDirty(t);

   314

}

   315

   316

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

   317

void UpdateAllTownVirtCoords()

   318

{

   319

	Town *t;

   320

	FOR_ALL_TOWNS(t) {

   321

		UpdateTownVirtCoord(t);

   322

	}

   323

}

   324

   325

/**

   326

 * Change the towns population

   327

 * @param t Town which polulation has changed

   328

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

   329

 */

   330

static void ChangePopulation(Town *t, int mod)

   331

{

   332

	t->population += mod;

   333

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   334

	UpdateTownVirtCoord(t);

   335

   336

	if (_town_sort_order & 2) _town_sort_dirty = true;

   337

}

   338

   339

/**

   340

 * Determines the world population

   341

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

   342

 * @return uint32 the calculated population of the world

   343

 */

   344

uint32 GetWorldPopulation()

   345

{

   346

	uint32 pop;

   347

	const Town* t;

   348

   349

	pop = 0;

   350

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

   351

	return pop;

   352

}

   353

   354

/**

   355

 * Helper function for house completion stages progression

   356

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

   357

 */

   358

static void MakeSingleHouseBigger(TileIndex tile)

   359

{

   360

	assert(IsTileType(tile, MP_HOUSE));

   361

   362

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

   363

	if (LiftHasDestination(tile)) return;

   364

   365

	/* progress in construction stages */

   366

	IncHouseConstructionTick(tile);

   367

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

   368

   369

	/* Check and/or  */

   370

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

   371

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

   372

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

   373

	}

   374

   375

	if (IsHouseCompleted(tile)) {

   376

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

   377

		 * building to the town. */

   378

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

   379

	}

   380

	MarkTileDirtyByTile(tile);

   381

}

   382

   383

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

   384

 * @param tile TileIndex of house

   385

 */

   386

static void MakeTownHouseBigger(TileIndex tile)

   387

{

   388

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

   389

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

   390

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

   391

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

   392

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

   393

}

   394

   395

/**

   396

 * Periodic tic handler for houses and town

   397

 * @param tile been asked to do its stuff

   398

 */

   399

static void TileLoop_Town(TileIndex tile)

   400

{

   401

	Town *t;

   402

	uint32 r;

   403

	HouseID house_id = GetHouseType(tile);

   404

	HouseSpec *hs = GetHouseSpecs(house_id);

   405

   406

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

   407

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

   408

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

   409

   410

	if (!IsHouseCompleted(tile)) {

   411

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

   412

		MakeTownHouseBigger(tile);

   413

		return;

   414

	}

   415

   416

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

   417

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

   418

			house_id < NEW_HOUSE_OFFSET &&

   419

			!LiftHasDestination(tile) &&

   420

			Chance16(1, 2))

   421

		AddAnimatedTile(tile);

   422

   423

	t = GetTownByTile(tile);

   424

   425

	r = Random();

   426

   427

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

   428

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

   429

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

   430

   431

			if (callback == CALLBACK_FAILED) break;

   432

			if (callback == 0x20FF) break;

   433

   434

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

   435

			if (cargo == CT_INVALID) continue;

   436

   437

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

   438

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

   439

   440

			const CargoSpec *cs = GetCargo(cargo);

   441

			switch (cs->town_effect) {

   442

				case TE_PASSENGERS:

   443

					t->new_max_pass += amt;

   444

					t->new_act_pass += moved;

   445

					break;

   446

   447

				case TE_MAIL:

   448

					t->new_max_mail += amt;

   449

					t->new_act_mail += moved;

   450

					break;

   451

   452

				default:

   453

					break;

   454

			}

   455

		}

   456

	} else {

   457

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

   458

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

   459

			uint moved;

   460

   461

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

   462

			t->new_max_pass += amt;

   463

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

   464

			t->new_act_pass += moved;

   465

		}

   466

   467

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

   468

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

   469

			uint moved;

   470

   471

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

   472

			t->new_max_mail += amt;

   473

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

   474

			t->new_act_mail += moved;

   475

		}

   476

	}

   477

   478

	_current_player = OWNER_TOWN;

   479

   480

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   481

			HasBit(t->flags12, TOWN_IS_FUNDED) &&

   482

			CanDeleteHouse(tile) &&

   483

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

   484

			--t->time_until_rebuild == 0) {

   485

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

   486

   487

		ClearTownHouse(t, tile);

   488

   489

		/* Rebuild with another house? */