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 "table/strings.h"

    12

#include "table/sprites.h"

    13

#include "map.h"

    14

#include "landscape.h"

    15

#include "tile.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

    45

/* Initialize the town-pool */

    46

DEFINE_OLD_POOL_GENERIC(Town, Town)

    47

    48

Town::Town(TileIndex tile)

    49

{

    50

	if (tile != 0) _total_towns++;

    51

	this->xy = tile;

    52

}

    53

    54

Town::~Town()

    55

{

    56

	DeleteName(this->townnametype);

    57

    58

	if (CleaningPool()) return;

    59

    60

	Industry *i;

    61

    62

	/* Delete town authority window

    63

	 * and remove from list of sorted towns */

    64

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    65

	_town_sort_dirty = true;

    66

	_total_towns--;

    67

    68

	/* Delete all industries belonging to the town */

    69

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

    70

    71

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

    72

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

    73

		switch (GetTileType(tile)) {

    74

			case MP_HOUSE:

    75

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

    76

				break;

    77

    78

			case MP_ROAD:

    79

			case MP_TUNNELBRIDGE:

    80

				if (IsTileOwner(tile, OWNER_TOWN) &&

    81

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

    82

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

    83

				break;

    84

    85

			default:

    86

				break;

    87

		}

    88

	}

    89

    90

	DeleteSubsidyWithTown(this->index);

    91

    92

	MarkWholeScreenDirty();

    93

    94

	this->xy = 0;

    95

}

    96

    97

// Local

    98

static int _grow_town_result;

    99

   100

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

   101

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

   102

   103

static void TownDrawHouseLift(const TileInfo *ti)

   104

{

   105

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

   106

}

   107

   108

typedef void TownDrawTileProc(const TileInfo *ti);

   109

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   110

	TownDrawHouseLift

   111

};

   112

   113

uint OriginalTileRandomiser(uint x, uint y)

   114

{

   115

	uint variant;

   116

	variant  = x >> 4;

   117

	variant ^= x >> 6;

   118

	variant ^= y >> 4;

   119

	variant -= y >> 6;

   120

	variant &= 3;

   121

	return variant;

   122

}

   123

   124

/**

   125

 * House Tile drawing handler.

   126

 * Part of the tile loop process

   127

 * @param ti TileInfo of the tile to draw

   128

 */

   129

static void DrawTile_Town(TileInfo *ti)

   130

{

   131

	const DrawBuildingsTileStruct *dcts;

   132

	SpriteID image;

   133

	SpriteID pal;

   134

	HouseID house_id = GetHouseType(ti->tile);

   135

   136

	if (house_id >= NEW_HOUSE_OFFSET) {

   137

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

   138

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

   139

		 * house id is drawn instead. */

   140

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

   141

			DrawNewHouseTile(ti, house_id);

   142

			return;

   143

		} else {

   144

			house_id = GetHouseSpecs(house_id)->substitute_id;

   145

		}

   146

	}

   147

   148

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

   149

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

   150

   151

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

   152

   153

	image = dcts->ground.sprite;

   154

	pal   = dcts->ground.pal;

   155

	DrawGroundSprite(image, pal);

   156

   157

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

   158

	image = dcts->building.sprite;

   159

	if (image != 0) {

   160

		AddSortableSpriteToDraw(image, dcts->building.pal,

   161

			ti->x + dcts->subtile_x,

   162

			ti->y + dcts->subtile_y,

   163

			dcts->width + 1,

   164

			dcts->height + 1,

   165

			dcts->dz,

   166

			ti->z,

   167

			HASBIT(_transparent_opt, TO_HOUSES)

   168

		);

   169

   170

		if (HASBIT(_transparent_opt, TO_HOUSES)) return;

   171

	}

   172

   173

	{

   174

		int proc = dcts->draw_proc - 1;

   175

   176

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

   177

	}

   178

}

   179

   180

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

   181

{

   182

	return GetTileMaxZ(tile);

   183

}

   184

   185

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   186

{

   187

	return FlatteningFoundation(tileh);

   188

}

   189

   190

/**

   191

 * Animate a tile for a town

   192

 * Only certain houses can be animated

   193

 * The newhouses animation superseeds regular ones

   194

 * @param tile TileIndex of the house to animate

   195

 */

   196

static void AnimateTile_Town(TileIndex tile)

   197

{

   198

	int pos, dest;

   199

   200

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   201

		AnimateNewHouseTile(tile);

   202

		return;

   203

	}

   204

   205

	if (_tick_counter & 3) return;

   206

   207

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

   208

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

   209

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

   210

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

   211

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

   212

		DeleteAnimatedTile(tile);

   213

		return;

   214

	}

   215

   216

	if (!LiftHasDestination(tile)) {

   217

		int i;

   218

   219

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

   220

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

   221

		 *  the height of 2 'normal' floors.

   222

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

   223

		do {

   224

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

   225

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

   226

   227

		SetLiftDestination(tile, i);

   228

	}

   229

   230

	pos = GetLiftPosition(tile);

   231

	dest = GetLiftDestination(tile) * 6;

   232

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

   233

	SetLiftPosition(tile, pos);

   234

   235

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

   236

   237

	MarkTileDirtyByTile(tile);

   238

}

   239

   240

static void UpdateTownRadius(Town *t);

   241

   242

/**

   243

 * Determines if a town is close to a tile

   244

 * @param tile TileIndex of the tile to query

   245

 * @param dist maximum distance to be accepted

   246

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

   247

 */

   248

static bool IsCloseToTown(TileIndex tile, uint dist)

   249

{

   250

	const Town* t;

   251

   252

	FOR_ALL_TOWNS(t) {

   253

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

   254

	}

   255

	return false;

   256

}

   257

   258

/**

   259

 * Marks the town sign as needing a repaint.

   260

 *

   261

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

   262

 *

   263

 * @param t Town requesting town sign for repaint

   264

 * @ingroup dirty

   265

 */

   266

static void MarkTownSignDirty(Town *t)

   267

{

   268

	MarkAllViewportsDirty(

   269

		t->sign.left - 6,

   270

		t->sign.top - 3,

   271

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

   272

		t->sign.top + 45

   273

	);

   274

}

   275

   276

/**

   277

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

   278

 * population (creation or growth or else)

   279

 * @param t Town to update

   280

 */

   281

void UpdateTownVirtCoord(Town *t)

   282

{

   283

	Point pt;

   284

   285

	MarkTownSignDirty(t);

   286

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

   287

	SetDParam(0, t->index);

   288

	SetDParam(1, t->population);

   289

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

   290

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   291

	MarkTownSignDirty(t);

   292

}

   293

   294

/**

   295

 * Change the towns population

   296

 * @param t Town which polulation has changed

   297

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

   298

 */

   299

static void ChangePopulation(Town *t, int mod)

   300

{

   301

	t->population += mod;

   302

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   303

	UpdateTownVirtCoord(t);

   304

   305

	if (_town_sort_order & 2) _town_sort_dirty = true;

   306

}

   307

   308

/**

   309

 * Determines the world population

   310

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

   311

 * @return uint32 the calculated population of the world

   312

 */

   313

uint32 GetWorldPopulation()

   314

{

   315

	uint32 pop;

   316

	const Town* t;

   317

   318

	pop = 0;

   319

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

   320

	return pop;

   321

}

   322

   323

/**

   324

 * Helper function for house completion stages progression

   325

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

   326

 */

   327

static void MakeSingleHouseBigger(TileIndex tile)

   328

{

   329

	assert(IsTileType(tile, MP_HOUSE));

   330

   331

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

   332

	if (LiftHasDestination(tile)) return;

   333

   334

	/* progress in construction stages */

   335

	IncHouseConstructionTick(tile);

   336

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

   337

   338

	/* Check and/or  */

   339

	if (HASBIT(GetHouseSpecs(GetHouseType(tile))->callback_mask, CBM_CONSTRUCTION_STATE_CHANGE)) {

   340

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

   341

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

   342

	}

   343

   344

	if (IsHouseCompleted(tile)) {

   345

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

   346

		 * building to the town. */

   347

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

   348

	}

   349

	MarkTileDirtyByTile(tile);

   350

}

   351

   352

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

   353

 * @param tile TileIndex of house

   354

 */

   355

static void MakeTownHouseBigger(TileIndex tile)

   356

{

   357

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

   358

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

   359

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

   360

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

   361

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

   362

}

   363

   364

/**

   365

 * Periodic tic handler for houses and town

   366

 * @param tile been asked to do its stuff

   367

 */

   368

static void TileLoop_Town(TileIndex tile)

   369

{

   370

	Town *t;

   371

	uint32 r;

   372

	HouseID house_id = GetHouseType(tile);

   373

	HouseSpec *hs = GetHouseSpecs(house_id);

   374

   375

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

   376

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

   377

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

   378

   379

	if (!IsHouseCompleted(tile)) {

   380

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

   381

		MakeTownHouseBigger(tile);

   382

		return;

   383

	}

   384

   385

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

   386

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

   387

			house_id < NEW_HOUSE_OFFSET &&

   388

			!LiftHasDestination(tile) &&

   389

			CHANCE16(1, 2))

   390

		AddAnimatedTile(tile);

   391

   392

	t = GetTownByTile(tile);

   393

   394

	r = Random();

   395

   396

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

   397

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

   398

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

   399

   400

			if (callback == CALLBACK_FAILED) break;

   401

			if (callback == 0x20FF) break;

   402

   403

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

   404

			if (cargo == CT_INVALID) continue;

   405

   406

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

   407

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

   408

   409

			const CargoSpec *cs = GetCargo(cargo);

   410

			switch (cs->town_effect) {

   411

				case TE_PASSENGERS:

   412

					t->new_max_pass += amt;

   413

					t->new_act_pass += moved;

   414

					break;

   415

   416

				case TE_MAIL:

   417

					t->new_max_mail += amt;

   418

					t->new_act_mail += moved;

   419

					break;

   420

   421

				default:

   422

					break;

   423

			}

   424

		}

   425

	} else {

   426

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

   427

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

   428

			uint moved;

   429

   430

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

   431

			t->new_max_pass += amt;

   432

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

   433

			t->new_act_pass += moved;

   434

		}

   435

   436

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

   437

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

   438

			uint moved;

   439

   440

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

   441

			t->new_max_mail += amt;

   442

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

   443

			t->new_act_mail += moved;

   444

		}

   445

	}

   446

   447

	_current_player = OWNER_TOWN;

   448

   449

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   450

			HASBIT(t->flags12, TOWN_IS_FUNDED) &&

   451

			CanDeleteHouse(tile) &&

   452

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

   453

			--t->time_until_rebuild == 0) {

   454

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

   455

   456

		ClearTownHouse(t, tile);

   457

   458

		/* Rebuild with another house? */

   459

		if (GB(r, 24, 8) >= 12) DoBuildTownHouse(t, tile);

   460

	}

   461

   462

	_current_player = OWNER_NONE;

   463

}

   464

   465

/**

   466

 * Unused handler

   467

 * @param tile unused

   468

 */

   469

static void ClickTile_Town(TileIndex tile)

   470

{

   471

	/* not used */

   472

}

   473

   474

static CommandCost ClearTile_Town(TileIndex tile, byte flags)

   475

{

   476

	int rating;

   477

	CommandCost cost;

   478

	Town *t;

   479

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

   480

   481

	if (flags&DC_AUTO && !(flags&DC_AI_BUILDING)) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   482

	if (!CanDeleteHouse(tile)) return CMD_ERROR;

   483

   484

	cost.AddCost(_price.remove_house * hs->removal_cost >> 8);

   485

   486

	rating = hs->remove_rating_decrease;

   487

	_cleared_town_rating += rating;

   488

	_cleared_town = t = GetTownByTile(tile);

   489