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

#include "autoslope.h"

    45

#include "waypoint.h"

    46

#include "transparency.h"

    47

    48

/* Initialize the town-pool */

    49

DEFINE_OLD_POOL_GENERIC(Town, Town)

    50

    51

Town::Town(TileIndex tile)

    52

{

    53

	if (tile != 0) _total_towns++;

    54

	this->xy = tile;

    55

}

    56

    57

Town::~Town()

    58

{

    59

	DeleteName(this->townnametype);

    60

    61

	if (CleaningPool()) return;

    62

    63

	Industry *i;

    64

    65

	/* Delete town authority window

    66

	 * and remove from list of sorted towns */

    67

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    68

	_town_sort_dirty = true;

    69

	_total_towns--;

    70

    71

	/* Delete all industries belonging to the town */

    72

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

    73

    74

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

    75

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

    76

		switch (GetTileType(tile)) {

    77

			case MP_HOUSE:

    78

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

    79

				break;

    80

    81

			case MP_ROAD:

    82

			case MP_TUNNELBRIDGE:

    83

				if (IsTileOwner(tile, OWNER_TOWN) &&

    84

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

    85

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

    86

				break;

    87

    88

			default:

    89

				break;

    90

		}

    91

	}

    92

    93

	DeleteSubsidyWithTown(this->index);

    94

    95

	MarkWholeScreenDirty();

    96

    97

	this->xy = 0;

    98

}

    99

   100

// Local

   101

static int _grow_town_result;

   102

   103

/* Describe the possible states */

   104

enum TownGrowthResult {

   105

	GROWTH_SUCCEED         = -1,

   106

	GROWTH_SEARCH_STOPPED  =  0

   107

//	GROWTH_SEARCH_RUNNING >=  1

   108

};

   109

   110

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

   111

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

   112

   113

static void TownDrawHouseLift(const TileInfo *ti)

   114

{

   115

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

   116

}

   117

   118

typedef void TownDrawTileProc(const TileInfo *ti);

   119

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   120

	TownDrawHouseLift

   121

};

   122

   123

uint OriginalTileRandomiser(uint x, uint y)

   124

{

   125

	uint variant;

   126

	variant  = x >> 4;

   127

	variant ^= x >> 6;

   128

	variant ^= y >> 4;

   129

	variant -= y >> 6;

   130

	variant &= 3;

   131

	return variant;

   132

}

   133

   134

/**

   135

 * Return a random direction

   136

 *

   137

 * @return a random direction

   138

 */

   139

static inline DiagDirection RandomDiagDir()

   140

{

   141

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

   142

}

   143

   144

/**

   145

 * House Tile drawing handler.

   146

 * Part of the tile loop process

   147

 * @param ti TileInfo of the tile to draw

   148

 */

   149

static void DrawTile_Town(TileInfo *ti)

   150

{

   151

	const DrawBuildingsTileStruct *dcts;

   152

	SpriteID image;

   153

	SpriteID pal;

   154

	HouseID house_id = GetHouseType(ti->tile);

   155

   156

	if (house_id >= NEW_HOUSE_OFFSET) {

   157

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

   158

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

   159

		 * house id is drawn instead. */

   160

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

   161

			DrawNewHouseTile(ti, house_id);

   162

			return;

   163

		} else {

   164

			house_id = GetHouseSpecs(house_id)->substitute_id;

   165

		}

   166

	}

   167

   168

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

   169

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

   170

   171

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

   172

   173

	image = dcts->ground.sprite;

   174

	pal   = dcts->ground.pal;

   175

	DrawGroundSprite(image, pal);

   176

   177

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

   178

	image = dcts->building.sprite;

   179

	if (image != 0) {

   180

		AddSortableSpriteToDraw(image, dcts->building.pal,

   181

			ti->x + dcts->subtile_x,

   182

			ti->y + dcts->subtile_y,

   183

			dcts->width,

   184

			dcts->height,

   185

			dcts->dz,

   186

			ti->z,

   187

			IsTransparencySet(TO_HOUSES)

   188

		);

   189

   190

		if (IsTransparencySet(TO_HOUSES)) return;

   191

	}

   192

   193

	{

   194

		int proc = dcts->draw_proc - 1;

   195

   196

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

   197

	}

   198

}

   199

   200

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

   201

{

   202

	return GetTileMaxZ(tile);

   203

}

   204

   205

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   206

{

   207

	return FlatteningFoundation(tileh);

   208

}

   209

   210

/**

   211

 * Animate a tile for a town

   212

 * Only certain houses can be animated

   213

 * The newhouses animation superseeds regular ones

   214

 * @param tile TileIndex of the house to animate

   215

 */

   216

static void AnimateTile_Town(TileIndex tile)

   217

{

   218

	int pos, dest;

   219

   220

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   221

		AnimateNewHouseTile(tile);

   222

		return;

   223

	}

   224

   225

	if (_tick_counter & 3) return;

   226

   227

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

   228

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

   229

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

   230

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

   231

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

   232

		DeleteAnimatedTile(tile);

   233

		return;

   234

	}

   235

   236

	if (!LiftHasDestination(tile)) {

   237

		int i;

   238

   239

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

   240

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

   241

		 *  the height of 2 'normal' floors.

   242

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

   243

		do {

   244

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

   245

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

   246

   247

		SetLiftDestination(tile, i);

   248

	}

   249

   250

	pos = GetLiftPosition(tile);

   251

	dest = GetLiftDestination(tile) * 6;

   252

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

   253

	SetLiftPosition(tile, pos);

   254

   255

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

   256

   257

	MarkTileDirtyByTile(tile);

   258

}

   259

   260

static void UpdateTownRadius(Town *t);

   261

   262

/**

   263

 * Determines if a town is close to a tile

   264

 * @param tile TileIndex of the tile to query

   265

 * @param dist maximum distance to be accepted

   266

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

   267

 */

   268

static bool IsCloseToTown(TileIndex tile, uint dist)

   269

{

   270

	const Town* t;

   271

   272

	FOR_ALL_TOWNS(t) {

   273

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

   274

	}

   275

	return false;

   276

}

   277

   278

/**

   279

 * Marks the town sign as needing a repaint.

   280

 *

   281

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

   282

 *

   283

 * @param t Town requesting town sign for repaint

   284

 * @ingroup dirty

   285

 */

   286

static void MarkTownSignDirty(Town *t)

   287

{

   288

	MarkAllViewportsDirty(

   289

		t->sign.left - 6,

   290

		t->sign.top - 3,

   291

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

   292

		t->sign.top + 45

   293

	);

   294

}

   295

   296

/**

   297

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

   298

 * population (creation or growth or else)

   299

 * @param t Town to update

   300

 */

   301

void UpdateTownVirtCoord(Town *t)

   302

{

   303

	Point pt;

   304

   305

	MarkTownSignDirty(t);

   306

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

   307

	SetDParam(0, t->index);

   308

	SetDParam(1, t->population);

   309

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

   310

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   311

	MarkTownSignDirty(t);

   312

}

   313

   314

/**

   315

 * Change the towns population

   316

 * @param t Town which polulation has changed

   317

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

   318

 */

   319

static void ChangePopulation(Town *t, int mod)

   320

{

   321

	t->population += mod;

   322

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   323

	UpdateTownVirtCoord(t);

   324

   325

	if (_town_sort_order & 2) _town_sort_dirty = true;

   326

}

   327

   328

/**

   329

 * Determines the world population

   330

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

   331

 * @return uint32 the calculated population of the world

   332

 */

   333

uint32 GetWorldPopulation()

   334

{

   335

	uint32 pop;

   336

	const Town* t;

   337

   338

	pop = 0;

   339

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

   340

	return pop;

   341

}

   342

   343

/**

   344

 * Helper function for house completion stages progression

   345

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

   346

 */

   347

static void MakeSingleHouseBigger(TileIndex tile)

   348

{

   349

	assert(IsTileType(tile, MP_HOUSE));

   350

   351

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

   352

	if (LiftHasDestination(tile)) return;

   353

   354

	/* progress in construction stages */

   355

	IncHouseConstructionTick(tile);

   356

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

   357

   358

	/* Check and/or  */

   359

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

   360

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

   361

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

   362

	}

   363

   364

	if (IsHouseCompleted(tile)) {

   365

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

   366

		 * building to the town. */

   367

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

   368

	}

   369

	MarkTileDirtyByTile(tile);

   370

}

   371

   372

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

   373

 * @param tile TileIndex of house

   374

 */

   375

static void MakeTownHouseBigger(TileIndex tile)

   376

{

   377

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

   378

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

   379

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

   380

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

   381

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

   382

}

   383

   384

/**

   385

 * Periodic tic handler for houses and town

   386

 * @param tile been asked to do its stuff

   387

 */

   388

static void TileLoop_Town(TileIndex tile)

   389

{

   390

	Town *t;

   391

	uint32 r;

   392

	HouseID house_id = GetHouseType(tile);

   393

	HouseSpec *hs = GetHouseSpecs(house_id);

   394

   395

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

   396

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

   397

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

   398

   399

	if (!IsHouseCompleted(tile)) {

   400

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

   401

		MakeTownHouseBigger(tile);

   402

		return;

   403

	}

   404

   405

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

   406

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

   407

			house_id < NEW_HOUSE_OFFSET &&

   408

			!LiftHasDestination(tile) &&

   409

			CHANCE16(1, 2))

   410

		AddAnimatedTile(tile);

   411

   412

	t = GetTownByTile(tile);

   413

   414

	r = Random();

   415

   416

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

   417

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

   418

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

   419

   420

			if (callback == CALLBACK_FAILED) break;

   421

			if (callback == 0x20FF) break;

   422

   423

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

   424

			if (cargo == CT_INVALID) continue;

   425

   426

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

   427

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

   428

   429

			const CargoSpec *cs = GetCargo(cargo);

   430

			switch (cs->town_effect) {

   431

				case TE_PASSENGERS:

   432

					t->new_max_pass += amt;

   433

					t->new_act_pass += moved;

   434

					break;

   435

   436

				case TE_MAIL:

   437

					t->new_max_mail += amt;

   438

					t->new_act_mail += moved;

   439

					break;

   440

   441

				default:

   442

					break;

   443

			}

   444

		}

   445

	} else {

   446

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

   447

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

   448

			uint moved;

   449

   450

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

   451

			t->new_max_pass += amt;

   452

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

   453

			t->new_act_pass += moved;

   454

		}

   455

   456

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

   457

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

   458

			uint moved;

   459

   460

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

   461

			t->new_max_mail += amt;

   462

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

   463

			t->new_act_mail += moved;

   464

		}

   465

	}

   466

   467

	_current_player = OWNER_TOWN;

   468

   469

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   470

			HasBit(t->flags12, TOWN_IS_FUNDED) &&

   471

			CanDeleteHouse(tile) &&

   472

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

   473

			--t->time_until_rebuild == 0) {

   474

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

   475

   476

		ClearTownHouse(t, tile);

   477

   478

		/* Rebuild with another house? */

   479

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

   480

	}

   481

   482

	_current_player = OWNER_NONE;

   483

}

   484

   485

/**

   486

 * Unused handler

   487

 * @param tile unused

   488

 */

   489

static void ClickTile_Town(TileIndex tile)