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

    44

#include "table/strings.h"

    45

#include "table/sprites.h"

    46

#include "table/town_land.h"

    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

/**

   111

 * Generate a random town road layout.

   112

 *

   113

 * The layout is based on the TileHash.

   114

 */

   115

void Town::InitializeLayout()

   116

{

   117

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

   118

   119

	/* Set invalid layouts to valid ones */

   120

	switch (this->layout) {

   121

		default: break;

   122

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

   123

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

   124

	}

   125

}

   126

   127

// Local

   128

static int _grow_town_result;

   129

   130

/* Describe the possible states */

   131

enum TownGrowthResult {

   132

	GROWTH_SUCCEED         = -1,

   133

	GROWTH_SEARCH_STOPPED  =  0

   134

//	GROWTH_SEARCH_RUNNING >=  1

   135

};

   136

   137

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

   138

   139

static void TownDrawHouseLift(const TileInfo *ti)

   140

{

   141

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

   142

}

   143

   144

typedef void TownDrawTileProc(const TileInfo *ti);

   145

static TownDrawTileProc *const _town_draw_tile_procs[1] = {

   146

	TownDrawHouseLift

   147

};

   148

   149

/**

   150

 * Return a random direction

   151

 *

   152

 * @return a random direction

   153

 */

   154

static inline DiagDirection RandomDiagDir()

   155

{

   156

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

   157

}

   158

   159

/**

   160

 * House Tile drawing handler.

   161

 * Part of the tile loop process

   162

 * @param ti TileInfo of the tile to draw

   163

 */

   164

static void DrawTile_Town(TileInfo *ti)

   165

{

   166

	HouseID house_id = GetHouseType(ti->tile);

   167

   168

	if (house_id >= NEW_HOUSE_OFFSET) {

   169

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

   170

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

   171

		 * house id is drawn instead. */

   172

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

   173

			DrawNewHouseTile(ti, house_id);

   174

			return;

   175

		} else {

   176

			house_id = GetHouseSpecs(house_id)->substitute_id;

   177

		}

   178

	}

   179

   180

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

   181

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

   182

   183

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

   184

   185

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

   186

   187

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

   188

	if (IsInvisibilitySet(TO_HOUSES)) return;

   189

   190

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

   191

	SpriteID image = dcts->building.sprite;

   192

	if (image != 0) {

   193

		AddSortableSpriteToDraw(image, dcts->building.pal,

   194

			ti->x + dcts->subtile_x,

   195

			ti->y + dcts->subtile_y,

   196

			dcts->width,

   197

			dcts->height,

   198

			dcts->dz,

   199

			ti->z,

   200

			IsTransparencySet(TO_HOUSES)

   201

		);

   202

   203

		if (IsTransparencySet(TO_HOUSES)) return;

   204

	}

   205

   206

	{

   207

		int proc = dcts->draw_proc - 1;

   208

   209

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

   210

	}

   211

}

   212

   213

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

   214

{

   215

	return GetTileMaxZ(tile);

   216

}

   217

   218

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   219

{

   220

	return FlatteningFoundation(tileh);

   221

}

   222

   223

/**

   224

 * Animate a tile for a town

   225

 * Only certain houses can be animated

   226

 * The newhouses animation superseeds regular ones

   227

 * @param tile TileIndex of the house to animate

   228

 */

   229

static void AnimateTile_Town(TileIndex tile)

   230

{

   231

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   232

		AnimateNewHouseTile(tile);

   233

		return;

   234

	}

   235

   236

	if (_tick_counter & 3) return;

   237

   238

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

   239

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

   240

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

   241

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

   242

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

   243

		DeleteAnimatedTile(tile);

   244

		return;

   245

	}

   246

   247

	if (!LiftHasDestination(tile)) {

   248

		uint i;

   249

   250

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

   251

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

   252

		 *  the height of 2 'normal' floors.

   253

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

   254

		do {

   255

			i = RandomRange(7);

   256

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

   257

   258

		SetLiftDestination(tile, i);

   259

	}

   260

   261

	int pos = GetLiftPosition(tile);

   262

	int dest = GetLiftDestination(tile) * 6;

   263

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

   264

	SetLiftPosition(tile, pos);

   265

   266

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

   267

   268

	MarkTileDirtyByTile(tile);

   269

}

   270

   271

/**

   272

 * Determines if a town is close to a tile

   273

 * @param tile TileIndex of the tile to query

   274

 * @param dist maximum distance to be accepted

   275

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

   276

 */

   277

static bool IsCloseToTown(TileIndex tile, uint dist)

   278

{

   279

	const Town *t;

   280

   281

	FOR_ALL_TOWNS(t) {

   282

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

   283

	}

   284

	return false;

   285

}

   286

   287

/**

   288

 * Marks the town sign as needing a repaint.

   289

 *

   290

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

   291

 *

   292

 * @param t Town requesting town sign for repaint

   293

 * @ingroup dirty

   294

 */

   295

static void MarkTownSignDirty(Town *t)

   296

{

   297

	MarkAllViewportsDirty(

   298

		t->sign.left - 6,

   299

		t->sign.top - 3,

   300

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

   301

		t->sign.top + 45

   302

	);

   303

}

   304

   305

/**

   306

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

   307

 * population (creation or growth or else)

   308

 * @param t Town to update

   309

 */

   310

void UpdateTownVirtCoord(Town *t)

   311

{

   312

	MarkTownSignDirty(t);

   313

	Point 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 = 0;

   352

	const Town *t;

   353

   354

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

   355

	return pop;

   356

}

   357

   358

/**

   359

 * Helper function for house completion stages progression

   360

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

   361

 */

   362

static void MakeSingleHouseBigger(TileIndex tile)

   363

{

   364

	assert(IsTileType(tile, MP_HOUSE));

   365

   366

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

   367

	if (LiftHasDestination(tile)) return;

   368

   369

	/* progress in construction stages */

   370

	IncHouseConstructionTick(tile);

   371

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

   372

   373

	/* Check and/or  */

   374

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

   375

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

   376

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

   377

	}

   378

   379

	if (IsHouseCompleted(tile)) {

   380

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

   381

		 * building to the town. */

   382

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

   383

	}

   384

	MarkTileDirtyByTile(tile);

   385

}

   386

   387

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

   388

 * @param tile TileIndex of house

   389

 */

   390

static void MakeTownHouseBigger(TileIndex tile)

   391

{

   392

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

   393

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

   394

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

   395

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

   396

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

   397

}

   398

   399

/**

   400

 * Periodic tic handler for houses and town

   401

 * @param tile been asked to do its stuff

   402

 */

   403

static void TileLoop_Town(TileIndex tile)

   404

{

   405

	HouseID house_id = GetHouseType(tile);

   406

   407

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

   408

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

   409

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

   410

   411

	if (!IsHouseCompleted(tile)) {

   412

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

   413

		MakeTownHouseBigger(tile);

   414

		return;

   415

	}

   416

   417

	const HouseSpec *hs = GetHouseSpecs(house_id);

   418

   419

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

   420

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

   421

			house_id < NEW_HOUSE_OFFSET &&

   422

			!LiftHasDestination(tile) &&

   423

			Chance16(1, 2)) {

   424

		AddAnimatedTile(tile);

   425

	}

   426

   427

	Town *t = GetTownByTile(tile);

   428

	uint32 r = Random();

   429

   430

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

   431

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

   432

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

   433

   434

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

   435

   436

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

   437

			if (cargo == CT_INVALID) continue;

   438

   439

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

   440

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

   441

   442

			const CargoSpec *cs = GetCargo(cargo);

   443

			switch (cs->town_effect) {

   444

				case TE_PASSENGERS:

   445

					t->new_max_pass += amt;

   446

					t->new_act_pass += moved;

   447

					break;

   448

   449

				case TE_MAIL:

   450

					t->new_max_mail += amt;

   451

					t->new_act_mail += moved;

   452

					break;

   453

   454

				default:

   455

					break;

   456

			}

   457

		}

   458

	} else {

   459

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

   460

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

   461

   462

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

   463

			t->new_max_pass += amt;

   464

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

   465

		}

   466

   467

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

   468

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

   469

   470

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

   471

			t->new_max_mail += amt;

   472

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

   473

		}

   474

	}

   475

   476

	_current_player = OWNER_TOWN;

   477

   478

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   479

			HasBit(t->flags12, TOWN_IS_FUNDED) &&

   480

			CanDeleteHouse(tile) &&

   481

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

   482

			--t->time_until_rebuild == 0) {

   483

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

   484

   485

		ClearTownHouse(t, tile);

   486

   487

		/* Rebuild with another house? */