1

/* $Id$ */

     2

     3

/** @file town_cmd.cpp Handling of town tiles. */

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

#include "newgrf_cargo.h"

    42

#include "oldpool_func.h"

    43

#include "sprite.h"

    44

#include "economy_func.h"

    45

#include "station_func.h"

    46

#include "cheat_func.h"

    47

#include "functions.h"

    48

#include "animated_tile_func.h"

    49

#include "date_func.h"

    50

    51

#include "table/strings.h"

    52

#include "table/sprites.h"

    53

#include "table/town_land.h"

    54

    55

uint _total_towns;

    56

HouseSpec _house_specs[HOUSE_MAX];

    57

    58

Town *_cleared_town;

    59

int _cleared_town_rating;

    60

    61

/* Initialize the town-pool */

    62

DEFINE_OLD_POOL_GENERIC(Town, Town)

    63

    64

Town::Town(TileIndex tile)

    65

{

    66

	if (tile != 0) _total_towns++;

    67

	this->xy = tile;

    68

}

    69

    70

Town::~Town()

    71

{

    72

	free(this->name);

    73

    74

	if (CleaningPool()) return;

    75

    76

	Industry *i;

    77

    78

	/* Delete town authority window

    79

	 * and remove from list of sorted towns */

    80

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    81

	InvalidateWindowData(WC_TOWN_DIRECTORY, 0, 0);

    82

	_total_towns--;

    83

    84

	/* Delete all industries belonging to the town */

    85

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

    86

    87

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

    88

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

    89

		switch (GetTileType(tile)) {

    90

			case MP_HOUSE:

    91

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

    92

				break;

    93

    94

			case MP_ROAD:

    95

			case MP_TUNNELBRIDGE:

    96

				if (IsTileOwner(tile, OWNER_TOWN) &&

    97

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

    98

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

    99

				break;

   100

   101

			default:

   102

				break;

   103

		}

   104

	}

   105

   106

	DeleteSubsidyWithTown(this->index);

   107

   108

	MarkWholeScreenDirty();

   109

   110

	this->xy = 0;

   111

}

   112

   113

/**

   114

 * Generate a random town road layout.

   115

 *

   116

 * The layout is based on the TileHash.

   117

 */

   118

void Town::InitializeLayout()

   119

{

   120

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

   121

   122

	/* Set invalid layouts to valid ones */

   123

	switch (this->layout) {

   124

		default: break;

   125

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

   126

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

   127

	}

   128

}

   129

   130

// Local

   131

static int _grow_town_result;

   132

   133

/* Describe the possible states */

   134

enum TownGrowthResult {

   135

	GROWTH_SUCCEED         = -1,

   136

	GROWTH_SEARCH_STOPPED  =  0

   137

//	GROWTH_SEARCH_RUNNING >=  1

   138

};

   139

   140

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

   141

   142

static void TownDrawHouseLift(const TileInfo *ti)

   143

{

   144

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

   145

}

   146

   147

typedef void TownDrawTileProc(const TileInfo *ti);

   148

static TownDrawTileProc *const _town_draw_tile_procs[1] = {

   149

	TownDrawHouseLift

   150

};

   151

   152

/**

   153

 * Return a random direction

   154

 *

   155

 * @return a random direction

   156

 */

   157

static inline DiagDirection RandomDiagDir()

   158

{

   159

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

   160

}

   161

   162

/**

   163

 * House Tile drawing handler.

   164

 * Part of the tile loop process

   165

 * @param ti TileInfo of the tile to draw

   166

 */

   167

static void DrawTile_Town(TileInfo *ti)

   168

{

   169

	HouseID house_id = GetHouseType(ti->tile);

   170

   171

	if (house_id >= NEW_HOUSE_OFFSET) {

   172

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

   173

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

   174

		 * house id is drawn instead. */

   175

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

   176

			DrawNewHouseTile(ti, house_id);

   177

			return;

   178

		} else {

   179

			house_id = GetHouseSpecs(house_id)->substitute_id;

   180

		}

   181

	}

   182

   183

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

   184

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

   185

   186

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

   187

   188

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

   189

   190

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

   191

	if (IsInvisibilitySet(TO_HOUSES)) return;

   192

   193

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

   194

	SpriteID image = dcts->building.sprite;

   195

	if (image != 0) {

   196

		AddSortableSpriteToDraw(image, dcts->building.pal,

   197

			ti->x + dcts->subtile_x,

   198

			ti->y + dcts->subtile_y,

   199

			dcts->width,

   200

			dcts->height,

   201

			dcts->dz,

   202

			ti->z,

   203

			IsTransparencySet(TO_HOUSES)

   204

		);

   205

   206

		if (IsTransparencySet(TO_HOUSES)) return;

   207

	}

   208

   209

	{

   210

		int proc = dcts->draw_proc - 1;

   211

   212

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

   213

	}

   214

}

   215

   216

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

   217

{

   218

	return GetTileMaxZ(tile);

   219

}

   220

   221

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   222

{

   223

	return FlatteningFoundation(tileh);

   224

}

   225

   226

/**

   227

 * Animate a tile for a town

   228

 * Only certain houses can be animated

   229

 * The newhouses animation superseeds regular ones

   230

 * @param tile TileIndex of the house to animate

   231

 */

   232

static void AnimateTile_Town(TileIndex tile)

   233

{

   234

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   235

		AnimateNewHouseTile(tile);

   236

		return;

   237

	}

   238

   239

	if (_tick_counter & 3) return;

   240

   241

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

   242

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

   243

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

   244

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

   245

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

   246

		DeleteAnimatedTile(tile);

   247

		return;

   248

	}

   249

   250

	if (!LiftHasDestination(tile)) {

   251

		uint i;

   252

   253

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

   254

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

   255

		 *  the height of 2 'normal' floors.

   256

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

   257

		do {

   258

			i = RandomRange(7);

   259

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

   260

   261

		SetLiftDestination(tile, i);

   262

	}

   263

   264

	int pos = GetLiftPosition(tile);

   265

	int dest = GetLiftDestination(tile) * 6;

   266

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

   267

	SetLiftPosition(tile, pos);

   268

   269

	if (pos == dest) {

   270

		HaltLift(tile);

   271

		DeleteAnimatedTile(tile);

   272

	}

   273

   274

	MarkTileDirtyByTile(tile);

   275

}

   276

   277

/**

   278

 * Determines if a town is close to a tile

   279

 * @param tile TileIndex of the tile to query

   280

 * @param dist maximum distance to be accepted

   281

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

   282

 */

   283

static bool IsCloseToTown(TileIndex tile, uint dist)

   284

{

   285

	const Town *t;

   286

   287

	FOR_ALL_TOWNS(t) {

   288

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

   289

	}

   290

	return false;

   291

}

   292

   293

/**

   294

 * Marks the town sign as needing a repaint.

   295

 *

   296

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

   297

 *

   298

 * @param t Town requesting town sign for repaint

   299

 * @ingroup dirty

   300

 */

   301

static void MarkTownSignDirty(Town *t)

   302

{

   303

	MarkAllViewportsDirty(

   304

		t->sign.left - 6,

   305

		t->sign.top - 3,

   306

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

   307

		t->sign.top + 45

   308

	);

   309

}

   310

   311

/**

   312

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

   313

 * population (creation or growth or else)

   314

 * @param t Town to update

   315

 */

   316

void UpdateTownVirtCoord(Town *t)

   317

{

   318

	MarkTownSignDirty(t);

   319

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

   320

	SetDParam(0, t->index);

   321

	SetDParam(1, t->population);

   322

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

   323

		_settings_client.gui.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   324

	MarkTownSignDirty(t);

   325

}

   326

   327

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

   328

void UpdateAllTownVirtCoords()

   329

{

   330

	Town *t;

   331

	FOR_ALL_TOWNS(t) {

   332

		UpdateTownVirtCoord(t);

   333

	}

   334

}

   335

   336

/**

   337

 * Change the towns population

   338

 * @param t Town which polulation has changed

   339

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

   340

 */

   341

static void ChangePopulation(Town *t, int mod)

   342

{

   343

	t->population += mod;

   344

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   345

	UpdateTownVirtCoord(t);

   346

   347

	InvalidateWindowData(WC_TOWN_DIRECTORY, 0, 1);

   348

}

   349

   350

/**

   351

 * Determines the world population

   352

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

   353

 * @return uint32 the calculated population of the world

   354

 */

   355

uint32 GetWorldPopulation()

   356

{

   357

	uint32 pop = 0;

   358

	const Town *t;

   359

   360

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

   361

	return pop;

   362

}

   363

   364

/**

   365

 * Helper function for house completion stages progression

   366

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

   367

 */

   368

static void MakeSingleHouseBigger(TileIndex tile)

   369

{

   370

	assert(IsTileType(tile, MP_HOUSE));

   371

   372

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

   373

	if (LiftHasDestination(tile)) return;

   374

   375

	/* progress in construction stages */

   376

	IncHouseConstructionTick(tile);

   377

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

   378

   379

	const HouseSpec *hs = GetHouseSpecs(GetHouseType(tile));

   380

   381

	/* Check and/or  */

   382

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

   383

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

   384

		if (callback_res != CALLBACK_FAILED) ChangeHouseAnimationFrame(hs->grffile, tile, callback_res);

   385

	}

   386

   387

	if (IsHouseCompleted(tile)) {

   388

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

   389

		 * building to the town. */

   390

		ChangePopulation(GetTownByTile(tile), hs->population);

   391

		SetHouseConstructionYear(tile, _cur_year);

   392

	}

   393

	MarkTileDirtyByTile(tile);

   394

}

   395

   396

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

   397

 * @param tile TileIndex of house

   398

 */

   399

static void MakeTownHouseBigger(TileIndex tile)

   400

{

   401

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

   402

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

   403

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

   404

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

   405

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

   406

}

   407

   408

/**

   409

 * Periodic tic handler for houses and town

   410

 * @param tile been asked to do its stuff

   411

 */

   412

static void TileLoop_Town(TileIndex tile)

   413

{

   414

	HouseID house_id = GetHouseType(tile);

   415

   416

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

   417

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

   418

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

   419

   420

	if (!IsHouseCompleted(tile)) {

   421

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

   422

		MakeTownHouseBigger(tile);

   423

		return;

   424

	}

   425

   426

	const HouseSpec *hs = GetHouseSpecs(house_id);

   427

   428

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

   429

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

   430

			house_id < NEW_HOUSE_OFFSET &&

   431

			!LiftHasDestination(tile) &&

   432

			Chance16(1, 2)) {

   433

		AddAnimatedTile(tile);

   434

	}

   435

   436

	Town *t = GetTownByTile(tile);

   437

	uint32 r = Random();

   438

   439

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

   440

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

   441

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

   442

   443

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

   444

   445

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

   446

			if (cargo == CT_INVALID) continue;

   447

   448

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

   449

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

   450

   451

			const CargoSpec *cs = GetCargo(cargo);

   452

			switch (cs->town_effect) {

   453

				case TE_PASSENGERS:

   454

					t->new_max_pass += amt;

   455

					t->new_act_pass += moved;

   456

					break;

   457

   458

				case TE_MAIL:

   459

					t->new_max_mail += amt;

   460

					t->new_act_mail += moved;

   461

					break;

   462

   463

				default:

   464

					break;

   465

			}

   466

		}

   467

	} else {

   468

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

   469

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

   470

   471

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

   472

			t->new_max_pass += amt;

   473

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

   474

		}

   475

   476

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

   477

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

   478

   479

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

   480

			t->new_max_mail += amt;

   481

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

   482

		}

   483

	}

   484

   485

	_current_player = OWNER_TOWN;

   486

   487

	if (hs->building_flags & BUILDING_HAS_1_TILE &&