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

    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

   101

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

   102

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

   103

   104

static void TownDrawHouseLift(const TileInfo *ti)

   105

{

   106

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

   107

}

   108

   109

typedef void TownDrawTileProc(const TileInfo *ti);

   110

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   111

	TownDrawHouseLift

   112

};

   113

   114

uint OriginalTileRandomiser(uint x, uint y)

   115

{

   116

	uint variant;

   117

	variant  = x >> 4;

   118

	variant ^= x >> 6;

   119

	variant ^= y >> 4;

   120

	variant -= y >> 6;

   121

	variant &= 3;

   122

	return variant;

   123

}

   124

   125

/**

   126

 * Return a random direction

   127

 *

   128

 * @return a random direction

   129

 */

   130

static inline DiagDirection RandomDiagDir()

   131

{

   132

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

   133

}

   134

   135

/**

   136

 * Move a TileIndex into a diagonal direction.

   137

 *

   138

 * @param tile The current tile

   139

 * @param dir The direction in which we want to step

   140

 * @return the moved tile

   141

 */

   142

static inline TileIndex AddDiagDirToTileIndex(TileIndex tile, DiagDirection dir)

   143

{

   144

	return TILE_ADD(tile, TileOffsByDiagDir(dir));

   145

}

   146

   147

/**

   148

 * House Tile drawing handler.

   149

 * Part of the tile loop process

   150

 * @param ti TileInfo of the tile to draw

   151

 */

   152

static void DrawTile_Town(TileInfo *ti)

   153

{

   154

	const DrawBuildingsTileStruct *dcts;

   155

	SpriteID image;

   156

	SpriteID pal;

   157

	HouseID house_id = GetHouseType(ti->tile);

   158

   159

	if (house_id >= NEW_HOUSE_OFFSET) {

   160

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

   161

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

   162

		 * house id is drawn instead. */

   163

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

   164

			DrawNewHouseTile(ti, house_id);

   165

			return;

   166

		} else {

   167

			house_id = GetHouseSpecs(house_id)->substitute_id;

   168

		}

   169

	}

   170

   171

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

   172

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

   173

   174

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

   175

   176

	image = dcts->ground.sprite;

   177

	pal   = dcts->ground.pal;

   178

	DrawGroundSprite(image, pal);

   179

   180

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

   181

	image = dcts->building.sprite;

   182

	if (image != 0) {

   183

		AddSortableSpriteToDraw(image, dcts->building.pal,

   184

			ti->x + dcts->subtile_x,

   185

			ti->y + dcts->subtile_y,

   186

			dcts->width,

   187

			dcts->height,

   188

			dcts->dz,

   189

			ti->z,

   190

			HASBIT(_transparent_opt, TO_HOUSES)

   191

		);

   192

   193

		if (HASBIT(_transparent_opt, TO_HOUSES)) return;

   194

	}

   195

   196

	{

   197

		int proc = dcts->draw_proc - 1;

   198

   199

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

   200

	}

   201

}

   202

   203

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

   204

{

   205

	return GetTileMaxZ(tile);

   206

}

   207

   208

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   209

{

   210

	return FlatteningFoundation(tileh);

   211

}

   212

   213

/**

   214

 * Animate a tile for a town

   215

 * Only certain houses can be animated

   216

 * The newhouses animation superseeds regular ones

   217

 * @param tile TileIndex of the house to animate

   218

 */

   219

static void AnimateTile_Town(TileIndex tile)

   220

{

   221

	int pos, dest;

   222

   223

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   224

		AnimateNewHouseTile(tile);

   225

		return;

   226

	}

   227

   228

	if (_tick_counter & 3) return;

   229

   230

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

   231

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

   232

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

   233

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

   234

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

   235

		DeleteAnimatedTile(tile);

   236

		return;

   237

	}

   238

   239

	if (!LiftHasDestination(tile)) {

   240

		int i;

   241

   242

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

   243

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

   244

		 *  the height of 2 'normal' floors.

   245

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

   246

		do {

   247

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

   248

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

   249

   250

		SetLiftDestination(tile, i);

   251

	}

   252

   253

	pos = GetLiftPosition(tile);

   254

	dest = GetLiftDestination(tile) * 6;

   255

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

   256

	SetLiftPosition(tile, pos);

   257

   258

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

   259

   260

	MarkTileDirtyByTile(tile);

   261

}

   262

   263

static void UpdateTownRadius(Town *t);

   264

   265

/**

   266

 * Determines if a town is close to a tile

   267

 * @param tile TileIndex of the tile to query

   268

 * @param dist maximum distance to be accepted

   269

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

   270

 */

   271

static bool IsCloseToTown(TileIndex tile, uint dist)

   272

{

   273

	const Town* t;

   274

   275

	FOR_ALL_TOWNS(t) {

   276

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

   277

	}

   278

	return false;

   279

}

   280

   281

/**

   282

 * Marks the town sign as needing a repaint.

   283

 *

   284

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

   285

 *

   286

 * @param t Town requesting town sign for repaint

   287

 * @ingroup dirty

   288

 */

   289

static void MarkTownSignDirty(Town *t)

   290

{

   291

	MarkAllViewportsDirty(

   292

		t->sign.left - 6,

   293

		t->sign.top - 3,

   294

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

   295

		t->sign.top + 45

   296

	);

   297

}

   298

   299

/**

   300

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

   301

 * population (creation or growth or else)

   302

 * @param t Town to update

   303

 */

   304

void UpdateTownVirtCoord(Town *t)

   305

{

   306

	Point pt;

   307

   308

	MarkTownSignDirty(t);

   309

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

   310

	SetDParam(0, t->index);

   311

	SetDParam(1, t->population);

   312

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

   313

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   314

	MarkTownSignDirty(t);

   315

}

   316

   317

/**

   318

 * Change the towns population

   319

 * @param t Town which polulation has changed

   320

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

   321

 */

   322

static void ChangePopulation(Town *t, int mod)

   323

{

   324

	t->population += mod;

   325

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   326

	UpdateTownVirtCoord(t);

   327

   328

	if (_town_sort_order & 2) _town_sort_dirty = true;

   329

}

   330

   331

/**

   332

 * Determines the world population

   333

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

   334

 * @return uint32 the calculated population of the world

   335

 */

   336

uint32 GetWorldPopulation()

   337

{

   338

	uint32 pop;

   339

	const Town* t;

   340

   341

	pop = 0;

   342

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

   343

	return pop;

   344

}

   345

   346

/**

   347

 * Helper function for house completion stages progression

   348

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

   349

 */

   350

static void MakeSingleHouseBigger(TileIndex tile)

   351

{

   352

	assert(IsTileType(tile, MP_HOUSE));

   353

   354

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

   355

	if (LiftHasDestination(tile)) return;

   356

   357

	/* progress in construction stages */

   358

	IncHouseConstructionTick(tile);

   359

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

   360

   361

	/* Check and/or  */

   362

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

   363

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

   364

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

   365

	}

   366

   367

	if (IsHouseCompleted(tile)) {

   368

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

   369

		 * building to the town. */

   370

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

   371

	}

   372

	MarkTileDirtyByTile(tile);

   373

}

   374

   375

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

   376

 * @param tile TileIndex of house

   377

 */

   378

static void MakeTownHouseBigger(TileIndex tile)

   379

{

   380

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

   381

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

   382

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

   383

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

   384

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

   385

}

   386

   387

/**

   388

 * Periodic tic handler for houses and town

   389

 * @param tile been asked to do its stuff

   390

 */

   391

static void TileLoop_Town(TileIndex tile)

   392

{

   393

	Town *t;

   394

	uint32 r;

   395

	HouseID house_id = GetHouseType(tile);

   396

	HouseSpec *hs = GetHouseSpecs(house_id);

   397

   398

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

   399

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

   400

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

   401

   402

	if (!IsHouseCompleted(tile)) {

   403

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

   404

		MakeTownHouseBigger(tile);

   405

		return;

   406

	}

   407

   408

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

   409

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

   410

			house_id < NEW_HOUSE_OFFSET &&

   411

			!LiftHasDestination(tile) &&

   412

			CHANCE16(1, 2))

   413

		AddAnimatedTile(tile);

   414

   415

	t = GetTownByTile(tile);

   416

   417

	r = Random();

   418

   419

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

   420

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

   421

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

   422

   423

			if (callback == CALLBACK_FAILED) break;

   424

			if (callback == 0x20FF) break;

   425

   426

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

   427

			if (cargo == CT_INVALID) continue;

   428

   429

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

   430

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

   431

   432

			const CargoSpec *cs = GetCargo(cargo);

   433

			switch (cs->town_effect) {

   434

				case TE_PASSENGERS:

   435

					t->new_max_pass += amt;

   436

					t->new_act_pass += moved;

   437

					break;

   438

   439

				case TE_MAIL:

   440

					t->new_max_mail += amt;

   441

					t->new_act_mail += moved;

   442

					break;

   443

   444

				default:

   445

					break;

   446

			}

   447

		}

   448

	} else {

   449

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

   450

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

   451

			uint moved;

   452

   453

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

   454

			t->new_max_pass += amt;

   455

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

   456

			t->new_act_pass += moved;

   457

		}

   458

   459

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

   460

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

   461

			uint moved;

   462

   463

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

   464

			t->new_max_mail += amt;

   465

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

   466

			t->new_act_mail += moved;

   467

		}

   468

	}

   469

   470

	_current_player = OWNER_TOWN;

   471

   472

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   473

			HASBIT(t->flags12, TOWN_IS_FUNDED) &&

   474

			CanDeleteHouse(tile) &&

   475

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

   476

			--t->time_until_rebuild == 0) {

   477

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

   478

   479

		ClearTownHouse(t, tile);

   480

   481

		/* Rebuild with another house? */

   482

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

   483

	}

   484

   485

	_current_player = OWNER_NONE;

   486

}

   487

   488

/**

   489

 * Unused handler