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

bool _town_sort_dirty;

    59

byte _town_sort_order;

    60

const Town **_town_sort;

    61

    62

Town *_cleared_town;

    63

int _cleared_town_rating;

    64

    65

/* Initialize the town-pool */

    66

DEFINE_OLD_POOL_GENERIC(Town, Town)

    67

    68

Town::Town(TileIndex tile)

    69

{

    70

	if (tile != 0) _total_towns++;

    71

	this->xy = tile;

    72

}

    73

    74

Town::~Town()

    75

{

    76

	free(this->name);

    77

    78

	if (CleaningPool()) return;

    79

    80

	Industry *i;

    81

    82

	/* Delete town authority window

    83

	 * and remove from list of sorted towns */

    84

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    85

	_town_sort_dirty = true;

    86

	_total_towns--;

    87

    88

	/* Delete all industries belonging to the town */

    89

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

    90

    91

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

    92

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

    93

		switch (GetTileType(tile)) {

    94

			case MP_HOUSE:

    95

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

    96

				break;

    97

    98

			case MP_ROAD:

    99

			case MP_TUNNELBRIDGE:

   100

				if (IsTileOwner(tile, OWNER_TOWN) &&

   101

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

   102

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

   103

				break;

   104

   105

			default:

   106

				break;

   107

		}

   108

	}

   109

   110

	DeleteSubsidyWithTown(this->index);

   111

   112

	MarkWholeScreenDirty();

   113

   114

	this->xy = 0;

   115

}

   116

   117

/**

   118

 * Generate a random town road layout.

   119

 *

   120

 * The layout is based on the TileHash.

   121

 */

   122

void Town::InitializeLayout()

   123

{

   124

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

   125

   126

	/* Set invalid layouts to valid ones */

   127

	switch (this->layout) {

   128

		default: break;

   129

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

   130

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

   131

	}

   132

}

   133

   134

// Local

   135

static int _grow_town_result;

   136

   137

/* Describe the possible states */

   138

enum TownGrowthResult {

   139

	GROWTH_SUCCEED         = -1,

   140

	GROWTH_SEARCH_STOPPED  =  0

   141

//	GROWTH_SEARCH_RUNNING >=  1

   142

};

   143

   144

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

   145

   146

static void TownDrawHouseLift(const TileInfo *ti)

   147

{

   148

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

   149

}

   150

   151

typedef void TownDrawTileProc(const TileInfo *ti);

   152

static TownDrawTileProc *const _town_draw_tile_procs[1] = {

   153

	TownDrawHouseLift

   154

};

   155

   156

/**

   157

 * Return a random direction

   158

 *

   159

 * @return a random direction

   160

 */

   161

static inline DiagDirection RandomDiagDir()

   162

{

   163

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

   164

}

   165

   166

/**

   167

 * House Tile drawing handler.

   168

 * Part of the tile loop process

   169

 * @param ti TileInfo of the tile to draw

   170

 */

   171

static void DrawTile_Town(TileInfo *ti)

   172

{

   173

	HouseID house_id = GetHouseType(ti->tile);

   174

   175

	if (house_id >= NEW_HOUSE_OFFSET) {

   176

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

   177

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

   178

		 * house id is drawn instead. */

   179

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

   180

			DrawNewHouseTile(ti, house_id);

   181

			return;

   182

		} else {

   183

			house_id = GetHouseSpecs(house_id)->substitute_id;

   184

		}

   185

	}

   186

   187

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

   188

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

   189

   190

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

   191

   192

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

   193

   194

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

   195

	if (IsInvisibilitySet(TO_HOUSES)) return;

   196

   197

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

   198

	SpriteID image = dcts->building.sprite;

   199

	if (image != 0) {

   200

		AddSortableSpriteToDraw(image, dcts->building.pal,

   201

			ti->x + dcts->subtile_x,

   202

			ti->y + dcts->subtile_y,

   203

			dcts->width,

   204

			dcts->height,

   205

			dcts->dz,

   206

			ti->z,

   207

			IsTransparencySet(TO_HOUSES)

   208

		);

   209

   210

		if (IsTransparencySet(TO_HOUSES)) return;

   211

	}

   212

   213

	{

   214

		int proc = dcts->draw_proc - 1;

   215

   216

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

   217

	}

   218

}

   219

   220

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

   221

{

   222

	return GetTileMaxZ(tile);

   223

}

   224

   225

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   226

{

   227

	return FlatteningFoundation(tileh);

   228

}

   229

   230

/**

   231

 * Animate a tile for a town

   232

 * Only certain houses can be animated

   233

 * The newhouses animation superseeds regular ones

   234

 * @param tile TileIndex of the house to animate

   235

 */

   236

static void AnimateTile_Town(TileIndex tile)

   237

{

   238

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   239

		AnimateNewHouseTile(tile);

   240

		return;

   241

	}

   242

   243

	if (_tick_counter & 3) return;

   244

   245

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

   246

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

   247

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

   248

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

   249

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

   250

		DeleteAnimatedTile(tile);

   251

		return;

   252

	}

   253

   254

	if (!LiftHasDestination(tile)) {

   255

		uint i;

   256

   257

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

   258

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

   259

		 *  the height of 2 'normal' floors.

   260

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

   261

		do {

   262

			i = RandomRange(7);

   263

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

   264

   265

		SetLiftDestination(tile, i);

   266

	}

   267

   268

	int pos = GetLiftPosition(tile);

   269

	int dest = GetLiftDestination(tile) * 6;

   270

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

   271

	SetLiftPosition(tile, pos);

   272

   273

	if (pos == dest) {

   274

		HaltLift(tile);

   275

		DeleteAnimatedTile(tile);

   276

	}

   277

   278

	MarkTileDirtyByTile(tile);

   279

}

   280

   281

/**

   282

 * Determines if a town is close to a tile

   283

 * @param tile TileIndex of the tile to query

   284

 * @param dist maximum distance to be accepted

   285

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

   286

 */

   287

static bool IsCloseToTown(TileIndex tile, uint dist)

   288

{

   289

	const Town *t;

   290

   291

	FOR_ALL_TOWNS(t) {

   292

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

   293

	}

   294

	return false;

   295

}

   296

   297

/**

   298

 * Marks the town sign as needing a repaint.

   299

 *

   300

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

   301

 *

   302

 * @param t Town requesting town sign for repaint

   303

 * @ingroup dirty

   304

 */

   305

static void MarkTownSignDirty(Town *t)

   306

{

   307

	MarkAllViewportsDirty(

   308

		t->sign.left - 6,

   309

		t->sign.top - 3,

   310

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

   311

		t->sign.top + 45

   312

	);

   313

}

   314

   315

/**

   316

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

   317

 * population (creation or growth or else)

   318

 * @param t Town to update

   319

 */

   320

void UpdateTownVirtCoord(Town *t)

   321

{

   322

	MarkTownSignDirty(t);

   323

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

   324

	SetDParam(0, t->index);

   325

	SetDParam(1, t->population);

   326

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

   328

	MarkTownSignDirty(t);

   329

}

   330

   331

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

   332

void UpdateAllTownVirtCoords()

   333

{

   334

	Town *t;

   335

	FOR_ALL_TOWNS(t) {

   336

		UpdateTownVirtCoord(t);

   337

	}

   338

}

   339

   340

/**

   341

 * Change the towns population

   342

 * @param t Town which polulation has changed

   343

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

   344

 */

   345

static void ChangePopulation(Town *t, int mod)

   346

{

   347

	t->population += mod;

   348

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   349

	UpdateTownVirtCoord(t);

   350

   351

	if (_town_sort_order & 2) _town_sort_dirty = true;

   352

}

   353

   354

/**

   355

 * Determines the world population

   356

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

   357

 * @return uint32 the calculated population of the world

   358

 */

   359

uint32 GetWorldPopulation()

   360

{

   361

	uint32 pop = 0;

   362

	const Town *t;

   363

   364

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

   365

	return pop;

   366

}

   367

   368

/**

   369

 * Helper function for house completion stages progression

   370

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

   371

 */

   372

static void MakeSingleHouseBigger(TileIndex tile)

   373

{

   374

	assert(IsTileType(tile, MP_HOUSE));

   375

   376

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

   377

	if (LiftHasDestination(tile)) return;

   378

   379

	/* progress in construction stages */

   380

	IncHouseConstructionTick(tile);

   381

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

   382

   383

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

   384

   385

	/* Check and/or  */

   386

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

   387

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

   388

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

   389

	}

   390

   391

	if (IsHouseCompleted(tile)) {

   392

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

   393

		 * building to the town. */

   394

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

   395

		SetHouseConstructionYear(tile, _cur_year);

   396

	}

   397

	MarkTileDirtyByTile(tile);

   398

}

   399

   400

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

   401

 * @param tile TileIndex of house

   402

 */

   403

static void MakeTownHouseBigger(TileIndex tile)

   404

{

   405

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

   406

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

   407

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

   408

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

   409

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

   410

}

   411

   412

/**

   413

 * Periodic tic handler for houses and town

   414

 * @param tile been asked to do its stuff

   415

 */

   416

static void TileLoop_Town(TileIndex tile)

   417

{

   418

	HouseID house_id = GetHouseType(tile);

   419

   420

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

   421

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

   422

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

   423

   424

	if (!IsHouseCompleted(tile)) {

   425

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

   426

		MakeTownHouseBigger(tile);

   427

		return;

   428

	}

   429

   430

	const HouseSpec *hs = GetHouseSpecs(house_id);

   431

   432

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

   433

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

   434

			house_id < NEW_HOUSE_OFFSET &&

   435

			!LiftHasDestination(tile) &&

   436

			Chance16(1, 2)) {

   437

		AddAnimatedTile(tile);

   438

	}

   439

   440

	Town *t = GetTownByTile(tile);

   441

	uint32 r = Random();

   442

   443

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

   444

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

   445

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

   446

   447

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

   448

   449

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

   450

			if (cargo == CT_INVALID) continue;

   451

   452

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

   453

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

   454

   455

			const CargoSpec *cs = GetCargo(cargo);

   456

			switch (cs->town_effect) {

   457

				case TE_PASSENGERS:

   458

					t->new_max_pass += amt;

   459

					t->new_act_pass += moved;

   460

					break;

   461

   462

				case TE_MAIL:

   463

					t->new_max_mail += amt;

   464

					t->new_act_mail += moved;

   465

					break;

   466

   467

				default:

   468

					break;

   469

			}

   470

		}

   471

	} else {

   472

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

   473

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

   474

   475

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

   476

			t->new_max_pass += amt;

   477

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

   478

		}

   479

   480

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

   481

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

   482

   483

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

   484

			t->new_max_mail += amt;

   485

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

   486

		}

   487

	}