1

/* $Id$ */

     2

     3

/** @file town_cmd.cpp */

     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 "misc/autoptr.hpp"

    35

#include "autoslope.h"

    36

#include "waypoint.h"

    37

#include "transparency.h"

    38

#include "tunnelbridge_map.h"

    39

#include "strings_func.h"

    40

#include "window_func.h"

    41

#include "string_func.h"

    42

#include "newgrf_cargo.h"

    43

    44

#include "table/strings.h"

    45

#include "table/sprites.h"

    46

#include "table/town_land.h"

    47

    48

uint _total_towns;

    49

HouseSpec _house_specs[HOUSE_MAX];

    50

    51

bool _town_sort_dirty;

    52

byte _town_sort_order;

    53

const Town **_town_sort;

    54

    55

Town *_cleared_town;

    56

int _cleared_town_rating;

    57

    58

/* Initialize the town-pool */

    59

DEFINE_OLD_POOL_GENERIC(Town, Town)

    60

    61

Town::Town(TileIndex tile)

    62

{

    63

	if (tile != 0) _total_towns++;

    64

	this->xy = tile;

    65

}

    66

    67

Town::~Town()

    68

{

    69

	free(this->name);

    70

    71

	if (CleaningPool()) return;

    72

    73

	Industry *i;

    74

    75

	/* Delete town authority window

    76

	 * and remove from list of sorted towns */

    77

	DeleteWindowById(WC_TOWN_VIEW, this->index);

    78

	_town_sort_dirty = true;

    79

	_total_towns--;

    80

    81

	/* Delete all industries belonging to the town */

    82

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

    83

    84

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

    85

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

    86

		switch (GetTileType(tile)) {

    87

			case MP_HOUSE:

    88

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

    89

				break;

    90

    91

			case MP_ROAD:

    92

			case MP_TUNNELBRIDGE:

    93

				if (IsTileOwner(tile, OWNER_TOWN) &&

    94

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

    95

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

    96

				break;

    97

    98

			default:

    99

				break;

   100

		}

   101

	}

   102

   103

	DeleteSubsidyWithTown(this->index);

   104

   105

	MarkWholeScreenDirty();

   106

   107

	this->xy = 0;

   108

}

   109

   110

// Local

   111

static int _grow_town_result;

   112

   113

/* Describe the possible states */

   114

enum TownGrowthResult {

   115

	GROWTH_SUCCEED         = -1,

   116

	GROWTH_SEARCH_STOPPED  =  0

   117

//	GROWTH_SEARCH_RUNNING >=  1

   118

};

   119

   120

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

   121

   122

static void TownDrawHouseLift(const TileInfo *ti)

   123

{

   124

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

   125

}

   126

   127

typedef void TownDrawTileProc(const TileInfo *ti);

   128

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   129

	TownDrawHouseLift

   130

};

   131

   140

{

   147

}

   148

   149

/**

   150

 * Return a random direction

   151

 *

   152

 * @return a random direction

   153

 */

   154

static inline DiagDirection RandomDiagDir()

   155

{

   156

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

   157

}

   158

   159

/**

   160

 * House Tile drawing handler.

   161

 * Part of the tile loop process

   162

 * @param ti TileInfo of the tile to draw

   163

 */

   164

static void DrawTile_Town(TileInfo *ti)

   165

{

   166

	const DrawBuildingsTileStruct *dcts;

   167

	SpriteID image;

   168

	SpriteID pal;

   169

	HouseID house_id = GetHouseType(ti->tile);

   170

   171

	if (house_id >= NEW_HOUSE_OFFSET) {

   172

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

   173

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

   174

		 * house id is drawn instead. */

   175

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

   176

			DrawNewHouseTile(ti, house_id);

   177

			return;

   178

		} else {

   179

			house_id = GetHouseSpecs(house_id)->substitute_id;

   180

		}

   181

	}

   182

   183

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

   185

   186

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

   187

   188

	image = dcts->ground.sprite;

   189

	pal   = dcts->ground.pal;

   190

	DrawGroundSprite(image, pal);

   191

   192

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

   193

	image = dcts->building.sprite;

   194

	if (image != 0) {

   195

		AddSortableSpriteToDraw(image, dcts->building.pal,

   196

			ti->x + dcts->subtile_x,

   197

			ti->y + dcts->subtile_y,

   198

			dcts->width,

   199

			dcts->height,

   200

			dcts->dz,

   201

			ti->z,

   202

			IsTransparencySet(TO_HOUSES)

   203

		);

   204

   205

		if (IsTransparencySet(TO_HOUSES)) return;

   206

	}

   207

   208

	{

   209

		int proc = dcts->draw_proc - 1;

   210

   211

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

   212

	}

   213

}

   214

   215

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

   216

{

   217

	return GetTileMaxZ(tile);

   218

}

   219

   220

static Foundation GetFoundation_Town(TileIndex tile, Slope tileh)

   221

{

   222

	return FlatteningFoundation(tileh);

   223

}

   224

   225

/**

   226

 * Animate a tile for a town

   227

 * Only certain houses can be animated

   228

 * The newhouses animation superseeds regular ones

   229

 * @param tile TileIndex of the house to animate

   230

 */

   231

static void AnimateTile_Town(TileIndex tile)

   232

{

   233

	int pos, dest;

   234

   235

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   236

		AnimateNewHouseTile(tile);

   237

		return;

   238

	}

   239

   240

	if (_tick_counter & 3) return;

   241

   242

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

   243

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

   244

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

   245

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

   246

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

   247

		DeleteAnimatedTile(tile);

   248

		return;

   249

	}

   250

   251

	if (!LiftHasDestination(tile)) {

   252

		int i;

   253

   254

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

   255

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

   256

		 *  the height of 2 'normal' floors.

   257

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

   258

		do {

   259

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

   260

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

   261

   262

		SetLiftDestination(tile, i);

   263

	}

   264

   265

	pos = GetLiftPosition(tile);

   266

	dest = GetLiftDestination(tile) * 6;

   267

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

   268

	SetLiftPosition(tile, pos);

   269

   270

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

   271

   272

	MarkTileDirtyByTile(tile);

   273

}

   274

   275

/**

   276

 * Determines if a town is close to a tile

   277

 * @param tile TileIndex of the tile to query

   278

 * @param dist maximum distance to be accepted

   279

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

   280

 */

   281

static bool IsCloseToTown(TileIndex tile, uint dist)

   282

{

   283

	const Town* t;

   284

   285

	FOR_ALL_TOWNS(t) {

   286

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

   287

	}

   288

	return false;

   289

}

   290

   291

/**

   292

 * Marks the town sign as needing a repaint.

   293

 *

   294

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

   295

 *

   296

 * @param t Town requesting town sign for repaint

   297

 * @ingroup dirty

   298

 */

   299

static void MarkTownSignDirty(Town *t)

   300

{

   301

	MarkAllViewportsDirty(

   302

		t->sign.left - 6,

   303

		t->sign.top - 3,

   304

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

   305

		t->sign.top + 45

   306

	);

   307

}

   308

   309

/**

   310

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

   311

 * population (creation or growth or else)

   312

 * @param t Town to update

   313

 */

   314

void UpdateTownVirtCoord(Town *t)

   315

{

   316

	Point pt;

   317

   318

	MarkTownSignDirty(t);

   319

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

   320

	SetDParam(0, t->index);

   321

	SetDParam(1, t->population);

   322

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

   323

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   324

	MarkTownSignDirty(t);

   325

}

   326

   327

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

   328

void UpdateAllTownVirtCoords()

   329

{

   330

	Town *t;

   331

	FOR_ALL_TOWNS(t) {

   332

		UpdateTownVirtCoord(t);

   333

	}

   334

}

   335

   336

/**

   337

 * Change the towns population

   338

 * @param t Town which polulation has changed

   339

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

   340

 */

   341

static void ChangePopulation(Town *t, int mod)

   342

{

   343

	t->population += mod;

   344

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   345

	UpdateTownVirtCoord(t);

   346

   347

	if (_town_sort_order & 2) _town_sort_dirty = true;

   348

}

   349

   350

/**

   351

 * Determines the world population

   352

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

   353

 * @return uint32 the calculated population of the world

   354

 */

   355

uint32 GetWorldPopulation()

   356

{

   357

	uint32 pop;

   358

	const Town* t;

   359

   360

	pop = 0;

   361

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

   362

	return pop;

   363

}

   364

   365

/**

   366

 * Helper function for house completion stages progression

   367

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

   368

 */

   369

static void MakeSingleHouseBigger(TileIndex tile)

   370

{

   371

	assert(IsTileType(tile, MP_HOUSE));

   372

   373

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

   374

	if (LiftHasDestination(tile)) return;

   375

   376

	/* progress in construction stages */

   377

	IncHouseConstructionTick(tile);

   378

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

   379

   380

	/* Check and/or  */

   381

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

   382

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

   383

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

   384

	}

   385

   386

	if (IsHouseCompleted(tile)) {

   387

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

   388

		 * building to the town. */

   389

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

   390

	}

   391

	MarkTileDirtyByTile(tile);

   392

}

   393

   394

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

   395

 * @param tile TileIndex of house

   396

 */

   397

static void MakeTownHouseBigger(TileIndex tile)

   398

{

   399

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

   400

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

   401

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

   402

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

   403

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

   404

}

   405

   406

/**

   407

 * Periodic tic handler for houses and town

   408

 * @param tile been asked to do its stuff

   409

 */

   410

static void TileLoop_Town(TileIndex tile)

   411

{

   412

	Town *t;

   413

	uint32 r;

   414

	HouseID house_id = GetHouseType(tile);

   415

	HouseSpec *hs = GetHouseSpecs(house_id);

   416

   417

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

   418

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

   419

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

   420

   421

	if (!IsHouseCompleted(tile)) {

   422

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

   423

		MakeTownHouseBigger(tile);

   424

		return;

   425

	}

   426

   427

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

   428

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

   429

			house_id < NEW_HOUSE_OFFSET &&

   430

			!LiftHasDestination(tile) &&

   431

			Chance16(1, 2))

   432

		AddAnimatedTile(tile);

   433

   434

	t = GetTownByTile(tile);

   435

   436

	r = Random();

   437

   438

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

   439

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

   440

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

   441

   442

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

   443

   444

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

   445

			if (cargo == CT_INVALID) continue;

   446

   447

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

   448

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

   449

   450

			const CargoSpec *cs = GetCargo(cargo);

   451

			switch (cs->town_effect) {

   452

				case TE_PASSENGERS:

   453

					t->new_max_pass += amt;

   454

					t->new_act_pass += moved;

   455

					break;

   456

   457

				case TE_MAIL:

   458

					t->new_max_mail += amt;

   459

					t->new_act_mail += moved;

   460

					break;

   461

   462

				default:

   463

					break;

   464

			}

   465

		}

   466

	} else {

   467

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

   468

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

   469

			uint moved;

   470

   471

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

   472

			t->new_max_pass += amt;

   473

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

   474

			t->new_act_pass += moved;

   475

		}

   476

   477

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

   478

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

   479

			uint moved;

   480

   481

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

   482

			t->new_max_mail += amt;

   483

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

   484

			t->new_act_mail += moved;

   485

		}

   486

	}

   487

   488

	_current_player = OWNER_TOWN;