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"

    45

    46

/* Initialize the town-pool */

    47

DEFINE_OLD_POOL_GENERIC(Town, Town)

    48

    49

Town::Town(TileIndex tile)

    50

{

    51

	if (tile != 0) _total_towns++;

    52

	this->xy = tile;

    53

}

    54

    55

Town::~Town()

    56

{

    57

	DeleteName(this->townnametype);

    58

    59

	if (CleaningPool()) return;

    60

    61

	Industry *i;

    62

    63

	/* Delete town authority window

    64

	 * and remove from list of sorted towns */

    65

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    66

	_town_sort_dirty = true;

    67

	_total_towns--;

    68

    69

	/* Delete all industries belonging to the town */

    70

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

    71

    72

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

    73

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

    74

		switch (GetTileType(tile)) {

    75

			case MP_HOUSE:

    76

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

    77

				break;

    78

    79

			case MP_ROAD:

    80

			case MP_TUNNELBRIDGE:

    81

				if (IsTileOwner(tile, OWNER_TOWN) &&

    82

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

    83

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

    84

				break;

    85

    86

			default:

    87

				break;

    88

		}

    89

	}

    90

    91

	DeleteSubsidyWithTown(this->index);

    92

    93

	MarkWholeScreenDirty();

    94

    95

	this->xy = 0;

    96

}

    97

    98

// Local

    99

static int _grow_town_result;

   100

   108

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

   109

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

   110

   111

static void TownDrawHouseLift(const TileInfo *ti)

   112

{

   113

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

   114

}

   115

   116

typedef void TownDrawTileProc(const TileInfo *ti);

   117

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   118

	TownDrawHouseLift

   119

};

   120

   121

uint OriginalTileRandomiser(uint x, uint y)

   122

{

   123

	uint variant;

   124

	variant  = x >> 4;

   125

	variant ^= x >> 6;

   126

	variant ^= y >> 4;

   127

	variant -= y >> 6;

   128

	variant &= 3;

   129

	return variant;

   130

}

   131

   132

/**

   143

 * House Tile drawing handler.

   144

 * Part of the tile loop process

   145

 * @param ti TileInfo of the tile to draw

   146

 */

   147

static void DrawTile_Town(TileInfo *ti)

   148

{

   149

	const DrawBuildingsTileStruct *dcts;

   150

	SpriteID image;

   151

	SpriteID pal;

   152

	HouseID house_id = GetHouseType(ti->tile);

   153

   154

	if (house_id >= NEW_HOUSE_OFFSET) {

   155

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

   156

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

   157

		 * house id is drawn instead. */

   158

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

   159

			DrawNewHouseTile(ti, house_id);

   160

			return;

   161

		} else {

   162

			house_id = GetHouseSpecs(house_id)->substitute_id;

   163

		}

   164

	}

   165

   166

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

   167

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

   168

   169

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

   170

   171

	image = dcts->ground.sprite;

   172

	pal   = dcts->ground.pal;

   173

	DrawGroundSprite(image, pal);

   174

   175

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

   176

	image = dcts->building.sprite;

   177

	if (image != 0) {

   178

		AddSortableSpriteToDraw(image, dcts->building.pal,

   179

			ti->x + dcts->subtile_x,

   180

			ti->y + dcts->subtile_y,

   183

			dcts->dz,

   184

			ti->z,

   185

			HASBIT(_transparent_opt, TO_HOUSES)

   186

		);

   187

   188

		if (HASBIT(_transparent_opt, TO_HOUSES)) return;

   189

	}

   190

   191

	{

   192

		int proc = dcts->draw_proc - 1;

   193

   194

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

   195

	}

   196

}

   197

   198

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

   199

{

   200

	return GetTileMaxZ(tile);

   201

}

   202

   203

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   204

{

   205

	return FlatteningFoundation(tileh);

   206

}

   207

   208

/**

   209

 * Animate a tile for a town

   210

 * Only certain houses can be animated

   211

 * The newhouses animation superseeds regular ones

   212

 * @param tile TileIndex of the house to animate

   213

 */

   214

static void AnimateTile_Town(TileIndex tile)

   215

{

   216

	int pos, dest;

   217

   218

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   219

		AnimateNewHouseTile(tile);

   220

		return;

   221

	}

   222

   223

	if (_tick_counter & 3) return;

   224

   225

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

   226

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

   227

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

   228

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

   229

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

   230

		DeleteAnimatedTile(tile);

   231

		return;

   232

	}

   233

   234

	if (!LiftHasDestination(tile)) {

   235

		int i;

   236

   237

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

   238

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

   239

		 *  the height of 2 'normal' floors.

   240

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

   241

		do {

   242

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

   243

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

   244

   245

		SetLiftDestination(tile, i);

   246

	}

   247

   248

	pos = GetLiftPosition(tile);

   249

	dest = GetLiftDestination(tile) * 6;

   250

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

   251

	SetLiftPosition(tile, pos);

   252

   253

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

   254

   255

	MarkTileDirtyByTile(tile);

   256

}

   257

   258

static void UpdateTownRadius(Town *t);

   259

   260

/**

   261

 * Determines if a town is close to a tile

   262

 * @param tile TileIndex of the tile to query

   263

 * @param dist maximum distance to be accepted

   264

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

   265

 */

   266

static bool IsCloseToTown(TileIndex tile, uint dist)

   267

{

   268

	const Town* t;

   269

   270

	FOR_ALL_TOWNS(t) {

   271

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

   272

	}

   273

	return false;

   274

}

   275

   276

/**

   283

 */

   284

static void MarkTownSignDirty(Town *t)

   285

{

   286

	MarkAllViewportsDirty(

   287

		t->sign.left - 6,

   288

		t->sign.top - 3,

   289

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

   290

		t->sign.top + 45

   291

	);

   292

}

   293

   294

/**

   295

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

   296

 * population (creation or growth or else)

   297

 * @param t Town to update

   298

 */

   299

void UpdateTownVirtCoord(Town *t)

   300

{

   301

	Point pt;

   302

   303

	MarkTownSignDirty(t);

   304

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

   305

	SetDParam(0, t->index);

   306

	SetDParam(1, t->population);

   307

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

   308

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   309

	MarkTownSignDirty(t);

   310

}

   311

   312

/**

   313

 * Change the towns population

   314

 * @param t Town which polulation has changed

   315

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

   316

 */

   317

static void ChangePopulation(Town *t, int mod)

   318

{

   319

	t->population += mod;

   320

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   321

	UpdateTownVirtCoord(t);

   322

   323

	if (_town_sort_order & 2) _town_sort_dirty = true;

   324

}

   325

   326

/**

   327

 * Determines the world population

   328

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

   329

 * @return uint32 the calculated population of the world

   330

 */

   331

uint32 GetWorldPopulation()

   332

{

   333

	uint32 pop;

   334

	const Town* t;

   335

   336

	pop = 0;

   337

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

   338

	return pop;

   339

}

   340

   341

/**

   342

 * Helper function for house completion stages progression

   343

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

   344

 */

   345

static void MakeSingleHouseBigger(TileIndex tile)

   346

{

   347

	assert(IsTileType(tile, MP_HOUSE));

   348

   349

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

   350

	if (LiftHasDestination(tile)) return;

   351

   352

	/* progress in construction stages */

   353

	IncHouseConstructionTick(tile);

   354

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

   355

   356

	/* Check and/or  */

   358

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

   359

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

   360

	}

   361

   362

	if (IsHouseCompleted(tile)) {

   363

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

   364

		 * building to the town. */

   365

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

   366

	}

   367

	MarkTileDirtyByTile(tile);

   368

}

   369

   370

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

   371

 * @param tile TileIndex of house

   372

 */

   373

static void MakeTownHouseBigger(TileIndex tile)

   374

{

   375

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

   376

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

   377

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

   378

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

   379

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

   380

}

   381

   382

/**

   383

 * Periodic tic handler for houses and town

   384

 * @param tile been asked to do its stuff

   385

 */

   386

static void TileLoop_Town(TileIndex tile)

   387

{

   388

	Town *t;

   389

	uint32 r;

   390

	HouseID house_id = GetHouseType(tile);

   391

	HouseSpec *hs = GetHouseSpecs(house_id);

   392

   393

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

   394

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

   395

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

   396

   397

	if (!IsHouseCompleted(tile)) {

   398

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

   399

		MakeTownHouseBigger(tile);

   400

		return;

   401

	}

   402

   403

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

   404

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

   405

			house_id < NEW_HOUSE_OFFSET &&

   406

			!LiftHasDestination(tile) &&

   407

			CHANCE16(1, 2))

   408

		AddAnimatedTile(tile);

   409

   410

	t = GetTownByTile(tile);

   411

   412

	r = Random();

   413

   414

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

   415

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

   416

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

   417

   418

			if (callback == CALLBACK_FAILED) break;

   419

			if (callback == 0x20FF) break;

   420

   421

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

   422

			if (cargo == CT_INVALID) continue;

   423

   424

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

   425

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

   426

   427

			const CargoSpec *cs = GetCargo(cargo);

   428

			switch (cs->town_effect) {

   429

				case TE_PASSENGERS:

   430

					t->new_max_pass += amt;

   431

					t->new_act_pass += moved;

   432

					break;

   433

   434

				case TE_MAIL:

   435

					t->new_max_mail += amt;

   436

					t->new_act_mail += moved;

   437

					break;

   438

   439

				default:

   440

					break;

   441

			}

   442

		}

   443

	} else {

   444

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

   445

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

   446

			uint moved;

   447

   448

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

   449

			t->new_max_pass += amt;

   450

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

   451

			t->new_act_pass += moved;

   452

		}

   453

   454

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

   455

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

   456

			uint moved;

   457

   458

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

   459

			t->new_max_mail += amt;

   460

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

   461

			t->new_act_mail += moved;

   462

		}

   463

	}

   464

   465

	_current_player = OWNER_TOWN;

   466

   467

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   468

			HASBIT(t->flags12, TOWN_IS_FUNDED) &&

   469

			CanDeleteHouse(tile) &&

   470

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

   471

			--t->time_until_rebuild == 0) {

   472

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

   473

   474

		ClearTownHouse(t, tile);

   475

   476

		/* Rebuild with another house? */

   477

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

   478

	}

   479

   480

	_current_player = OWNER_NONE;

   481

}

   482

   483

/**

   484

 * Unused handler

   485

 * @param tile unused

   486

 */

   487

static void ClickTile_Town(TileIndex tile)

   488

{

   489

	/* not used */