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

    44

/**

    45

 * Called if a new block is added to the town-pool

    46

 */

    47

static void TownPoolNewBlock(uint start_item)

    48

{

    49

	Town *t;

    50

    51

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    52

	 * TODO - This is just a temporary stage, this will be removed. */

    53

	for (t = GetTown(start_item); t != NULL; t = (t->index + 1U < GetTownPoolSize()) ? GetTown(t->index + 1U) : NULL) t->index = start_item++;

    54

}

    55

    56

/* Initialize the town-pool */

    57

DEFINE_OLD_POOL(Town, Town, TownPoolNewBlock, NULL)

    58

    59

/**

    60

 * Removes a specific town as well as all industries

    61

 * under its "juridiction"

    62

 * @param t Town to remove

    63

 */

    64

void DestroyTown(Town *t)

    65

{

    66

	Industry *i;

    67

	TileIndex tile;

    68

    69

	/* Delete town authority window

    70

	 * and remove from list of sorted towns */

    71

	DeleteWindowById(WC_TOWN_VIEW, t->index);

    72

	_town_sort_dirty = true;

    73

	_total_towns--;

    74

    75

	/* Delete all industries belonging to the town */

    76

	FOR_ALL_INDUSTRIES(i) if (i->town == t) DeleteIndustry(i);

    77

    78

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

    79

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

    80

		switch (GetTileType(tile)) {

    81

			case MP_HOUSE:

    82

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

    83

				break;

    84

    85

			case MP_STREET:

    86

			case MP_TUNNELBRIDGE:

    87

				if (IsTileOwner(tile, OWNER_TOWN) &&

    88

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

    89

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

    90

				break;

    91

    92

			default:

    93

				break;

    94

		}

    95

	}

    96

    97

	DeleteName(t->townnametype);

    98

	DeleteSubsidyWithTown(t->index);

    99

   100

	MarkWholeScreenDirty();

   101

}

   102

   103

// Local

   104

static int _grow_town_result;

   105

   106

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

   107

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

   108

   109

static void TownDrawHouseLift(const TileInfo *ti)

   110

{

   111

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

   112

}

   113

   114

typedef void TownDrawTileProc(const TileInfo *ti);

   115

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   116

	TownDrawHouseLift

   117

};

   118

   119

uint OriginalTileRandomiser(uint x, uint y)

   120

{

   121

	uint variant;

   122

	variant  = x >> 4;

   123

	variant ^= x >> 6;

   124

	variant ^= y >> 4;

   125

	variant -= y >> 6;

   126

	variant &= 3;

   127

	return variant;

   128

}

   129

   130

/**

   131

 * House Tile drawing handler.

   132

 * Part of the tile loop process

   133

 * @param ti TileInfo of the tile to draw

   134

 */

   135

static void DrawTile_Town(TileInfo *ti)

   136

{

   137

	const DrawBuildingsTileStruct *dcts;

   138

	SpriteID image;

   139

	SpriteID pal;

   140

	HouseID house_id = GetHouseType(ti->tile);

   141

   142

	if (house_id >= NEW_HOUSE_OFFSET) {

   143

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

   144

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

   145

		 * house id is drawn instead. */

   146

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

   147

			DrawNewHouseTile(ti, house_id);

   148

			return;

   149

		} else {

   150

			house_id = GetHouseSpecs(house_id)->substitute_id;

   151

		}

   152

	}

   153

   154

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

   155

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

   156

   157

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

   158

   159

	image = dcts->ground.sprite;

   160

	pal   = dcts->ground.pal;

   161

	DrawGroundSprite(image, pal);

   162

   163

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

   164

	image = dcts->building.sprite;

   165

	if (image != 0) {

   167

			ti->x + dcts->subtile_x,

   168

			ti->y + dcts->subtile_y,

   169

			dcts->width + 1,

   170

			dcts->height + 1,

   171

			dcts->dz,

   174

		);

   175

   176

		if (HASBIT(_transparent_opt, TO_HOUSES)) return;

   177

	}

   178

   179

	{

   180

		int proc = dcts->draw_proc - 1;

   181

   182

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

   183

	}

   184

}

   185

   186

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

   187

{

   188

	return GetTileMaxZ(tile);

   189

}

   190

   191

static Slope GetSlopeTileh_Town(TileIndex tile, Slope tileh)

   192

{

   193

	return SLOPE_FLAT;

   194

}

   195

   196

/**

   197

 * Animate a tile for a town

   198

 * Only certain houses can be animated

   199

 * The newhouses animation superseeds regular ones

   200

 * @param tile TileIndex of the house to animate

   201

 */

   202

static void AnimateTile_Town(TileIndex tile)

   203

{

   204

	int pos, dest;

   205

   206

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   207

		AnimateNewHouseTile(tile);

   208

		return;

   209

	}

   210

   211

	if (_tick_counter & 3) return;

   212

   213

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

   214

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

   215

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

   216

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

   217

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

   218

		DeleteAnimatedTile(tile);

   219

		return;

   220

	}

   221

   222

	if (!LiftHasDestination(tile)) {

   223

		int i;

   224

   225

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

   226

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

   227

		 *  the height of 2 'normal' floors.

   228

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

   229

		do {

   230

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

   231

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

   232

   233

		SetLiftDestination(tile, i);

   234

	}

   235

   236

	pos = GetLiftPosition(tile);

   237

	dest = GetLiftDestination(tile) * 6;

   238

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

   239

	SetLiftPosition(tile, pos);

   240

   241

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

   242

   243

	MarkTileDirtyByTile(tile);

   244

}

   245

   246

static void UpdateTownRadius(Town *t);

   247

   248

/**

   249

 * Determines if a town is close to a tile

   250

 * @param tile TileIndex of the tile to query

   251

 * @param dist maximum distance to be accepted

   252

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

   253

 */

   254

static bool IsCloseToTown(TileIndex tile, uint dist)

   255

{

   256

	const Town* t;

   257

   258

	FOR_ALL_TOWNS(t) {

   259

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

   260

	}

   261

	return false;

   262

}

   263

   264

/**

   265

 * Marks the town sign as needing a repaint

   266

 * @param t Town requesting repaint

   267

 */

   268

static void MarkTownSignDirty(Town *t)

   269

{

   270

	MarkAllViewportsDirty(

   271

		t->sign.left - 6,

   272

		t->sign.top - 3,

   273

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

   274

		t->sign.top + 45

   275

	);

   276

}

   277

   278

/**

   279

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

   280

 * population (creation or growth or else)

   281

 * @param t Town to update

   282

 */

   283

void UpdateTownVirtCoord(Town *t)

   284

{

   285

	Point pt;

   286

   287

	MarkTownSignDirty(t);

   288

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

   289

	SetDParam(0, t->index);

   290

	SetDParam(1, t->population);

   291

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

   292

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   293

	MarkTownSignDirty(t);

   294

}

   295

   296

/**

   297

 * Change the towns population

   298

 * @param t Town which polulation has changed

   299

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

   300

 */

   301

static void ChangePopulation(Town *t, int mod)

   302

{

   303

	t->population += mod;

   304

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   305

	UpdateTownVirtCoord(t);

   306

   307

	if (_town_sort_order & 2) _town_sort_dirty = true;

   308

}

   309

   310

/**

   311

 * Determines the world population

   312

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

   313

 * @return uint32 the calculated population of the world

   314

 */

   315

uint32 GetWorldPopulation()

   316

{

   317

	uint32 pop;

   318

	const Town* t;

   319

   320

	pop = 0;

   321

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

   322

	return pop;

   323

}

   324

   325

/**

   326

 * Helper function for house completion stages progression

   327

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

   328

 */

   329

static void MakeSingleHouseBigger(TileIndex tile)

   330

{

   331

	assert(IsTileType(tile, MP_HOUSE));

   332

   333

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

   334

	if (LiftHasDestination(tile)) return;

   335

   336

	/* progress in construction stages */

   337

	IncHouseConstructionTick(tile);

   338

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

   339

   340

	/* Check and/or  */

   341

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

   342

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

   343

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

   344

	}

   345

   346

	if (IsHouseCompleted(tile)) {

   347

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

   348

		 * building to the town. */

   349

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

   350

	}

   351

	MarkTileDirtyByTile(tile);

   352

}

   353

   354

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

   355

 * @param tile TileIndex of house

   356

 */

   357

static void MakeTownHouseBigger(TileIndex tile)

   358

{

   359

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

   360

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

   361

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

   362

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

   363

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

   364

}

   365

   366

/**

   367

 * Periodic tic handler for houses and town

   368

 * @param tile been asked to do its stuff

   369

 */

   370

static void TileLoop_Town(TileIndex tile)

   371

{

   372

	Town *t;

   373

	uint32 r;

   374

	HouseID house_id = GetHouseType(tile);

   375

	HouseSpec *hs = GetHouseSpecs(house_id);

   376

   377

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

   378

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

   379

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

   380

   381

	if (!IsHouseCompleted(tile)) {

   382

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

   383

		MakeTownHouseBigger(tile);

   384

		return;

   385

	}

   386

   387

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

   388

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

   389

			house_id < NEW_HOUSE_OFFSET &&

   390

			!LiftHasDestination(tile) &&

   391

			CHANCE16(1, 2))

   392

		AddAnimatedTile(tile);

   393

   394

	t = GetTownByTile(tile);

   395

   396

	r = Random();

   397

   398

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

   399

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

   400

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

   401

   402

			if (callback == CALLBACK_FAILED) break;

   403

			if (callback == 0x20FF) break;

   404

   405

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

   406

			if (cargo == CT_INVALID) continue;

   407

   408

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

   409

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

   410

   411

			const CargoSpec *cs = GetCargo(cargo);

   412

			switch (cs->town_effect) {

   413

				case TE_PASSENGERS:

   414

					t->new_max_pass += amt;

   415

					t->new_act_pass += moved;

   416

					break;

   417

   418

				case TE_MAIL:

   419

					t->new_max_mail += amt;

   420

					t->new_act_mail += moved;

   421

					break;

   422

   423

				default:

   424

					break;

   425

			}

   426

		}

   427

	} else {

   428

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

   429

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

   430

			uint moved;

   431

   432

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

   433

			t->new_max_pass += amt;

   434

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

   435

			t->new_act_pass += moved;

   436

		}

   437

   438

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

   439

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

   440

			uint moved;

   441

   442

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

   443

			t->new_max_mail += amt;

   444

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

   445

			t->new_act_mail += moved;

   446

		}

   447

	}

   448

   449

	_current_player = OWNER_TOWN;

   450

   451

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   452

			HASBIT(t->flags12, TOWN_IS_FUNDED) &&

   453

			CanDeleteHouse(tile) &&

   454

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

   455

			--t->time_until_rebuild == 0) {

   456

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

   457

   458

		ClearTownHouse(t, tile);

   459

   460

		/* Rebuild with another house? */

   461

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

   462

	}

   463

   464

	_current_player = OWNER_NONE;

   465

}

   466

   467

/**

   468

 * Unused handler

   469

 * @param tile unused

   470

 */

   471

static void ClickTile_Town(TileIndex tile)

   472

{

   473

	/* not used */

   474

}

   475

   476

static CommandCost ClearTile_Town(TileIndex tile, byte flags)

   477

{

   478

	int rating;

   479

	CommandCost cost;

   480

	Town *t;

   481

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

   482

   483

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

   484

	if (!CanDeleteHouse(tile)) return CMD_ERROR;

   485

   486

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

   487

   488

	rating = hs->remove_rating_decrease;

   489

	_cleared_town_rating += rating;

   490

	_cleared_town = t = GetTownByTile(tile);