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

    43

/**

    44

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

    45

 */

    46

static void TownPoolNewBlock(uint start_item)

    47

{

    48

	Town *t;

    49

    50

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

    51

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

    52

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

    53

}

    54

    55

/* Initialize the town-pool */

    56

DEFINE_OLD_POOL(Town, Town, TownPoolNewBlock, NULL)

    57

    58

/**

    59

 * Removes a specific town as well as all industries

    60

 * under its "juridiction"

    61

 * @param t Town to remove

    62

 */

    63

void DestroyTown(Town *t)

    64

{

    65

	Industry *i;

    66

	TileIndex tile;

    67

    68

	/* Delete town authority window

    69

	 * and remove from list of sorted towns */

    70

	DeleteWindowById(WC_TOWN_VIEW, t->index);

    71

	_town_sort_dirty = true;

    72

	_total_towns--;

    73

    74

	/* Delete all industries belonging to the town */

    75

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

    76

    77

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

    78

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

    79

		switch (GetTileType(tile)) {

    80

			case MP_HOUSE:

    81

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

    82

				break;

    83

    84

			case MP_STREET:

    85

			case MP_TUNNELBRIDGE:

    86

				if (IsTileOwner(tile, OWNER_TOWN) &&

    87

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

    88

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

    89

				break;

    90

    91

			default:

    92

				break;

    93

		}

    94

	}

    95

    96

	DeleteName(t->townnametype);

    97

	DeleteSubsidyWithTown(t->index);

    98

    99

	MarkWholeScreenDirty();

   100

}

   101

   102

// Local

   103

static int _grow_town_result;

   104

   105

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

   106

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

   107

   108

static void TownDrawHouseLift(const TileInfo *ti)

   109

{

   110

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

   111

}

   112

   113

typedef void TownDrawTileProc(const TileInfo *ti);

   114

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   115

	TownDrawHouseLift

   116

};

   117

   118

uint OriginalTileRandomiser(uint x, uint y)

   119

{

   120

	uint variant;

   121

	variant  = x >> 4;

   122

	variant ^= x >> 6;

   123

	variant ^= y >> 4;

   124

	variant -= y >> 6;

   125

	variant &= 3;

   126

	return variant;

   127

}

   128

   129

/**

   130

 * House Tile drawing handler.

   131

 * Part of the tile loop process

   132

 * @param ti TileInfo of the tile to draw

   133

 */

   134

static void DrawTile_Town(TileInfo *ti)

   135

{

   136

	const DrawBuildingsTileStruct *dcts;

   137

	SpriteID image;

   138

	SpriteID pal;

   139

	HouseID house_id = GetHouseType(ti->tile);

   140

   141

	if (house_id >= NEW_HOUSE_OFFSET) {

   142

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

   143

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

   144

		 * house id is drawn instead. */

   145

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

   146

			DrawNewHouseTile(ti, house_id);

   147

			return;

   148

		} else {

   149

			house_id = GetHouseSpecs(house_id)->substitute_id;

   150

		}

   151

	}

   152

   153

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

   154

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

   155

   156

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

   157

   158

	image = dcts->ground.sprite;

   159

	pal   = dcts->ground.pal;

   160

	DrawGroundSprite(image, pal);

   161

   162

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

   163

	image = dcts->building.sprite;

   164

	if (image != 0) {

   165

		if (HASBIT(_transparent_opt, TO_HOUSES)) {

   166

			SETBIT(image, PALETTE_MODIFIER_TRANSPARENT);

   167

			pal = PALETTE_TO_TRANSPARENT;

   168

		} else {

   169

			pal = dcts->building.pal;

   170

		}

   171

   172

		AddSortableSpriteToDraw(image, pal,

   173

			ti->x + dcts->subtile_x,

   174

			ti->y + dcts->subtile_y,

   175

			dcts->width + 1,

   176

			dcts->height + 1,

   177

			dcts->dz,

   178

			ti->z

   179

		);

   180

   181

		if (HASBIT(_transparent_opt, TO_HOUSES)) return;

   182

	}

   183

   184

	{

   185

		int proc = dcts->draw_proc - 1;

   186

   187

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

   188

	}

   189

}

   190

   191

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

   192

{

   193

	return GetTileMaxZ(tile);

   194

}

   195

   196

static Slope GetSlopeTileh_Town(TileIndex tile, Slope tileh)

   197

{

   198

	return SLOPE_FLAT;

   199

}

   200

   201

/**

   202

 * Animate a tile for a town

   203

 * Only certain houses can be animated

   204

 * The newhouses animation superseeds regular ones

   205

 * @param tile TileIndex of the house to animate

   206

 */

   207

static void AnimateTile_Town(TileIndex tile)

   208

{

   209

	int pos, dest;

   210

   211

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   212

		AnimateNewHouseTile(tile);

   213

		return;

   214

	}

   215

   216

	if (_tick_counter & 3) return;

   217

   218

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

   219

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

   220

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

   221

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

   222

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

   223

		DeleteAnimatedTile(tile);

   224

		return;

   225

	}

   226

   227

	if (!LiftHasDestination(tile)) {

   228

		int i;

   229

   230

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

   231

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

   232

		 *  the height of 2 'normal' floors.

   233

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

   234

		do {

   235

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

   236

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

   237

   238

		SetLiftDestination(tile, i);

   239

	}

   240

   241

	pos = GetLiftPosition(tile);

   242

	dest = GetLiftDestination(tile) * 6;

   243

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

   244

	SetLiftPosition(tile, pos);

   245

   246

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

   247

   248

	MarkTileDirtyByTile(tile);

   249

}

   250

   251

static void UpdateTownRadius(Town *t);

   252

   253

/**

   254

 * Determines if a town is close to a tile

   255

 * @param tile TileIndex of the tile to query

   256

 * @param dist maximum distance to be accepted

   257

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

   258

 */

   259

static bool IsCloseToTown(TileIndex tile, uint dist)

   260

{

   261

	const Town* t;

   262

   263

	FOR_ALL_TOWNS(t) {

   264

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

   265

	}

   266

	return false;

   267

}

   268

   269

/**

   270

 * Marks the town sign as needing a repaint

   271

 * @param t Town requesting repaint

   272

 */

   273

static void MarkTownSignDirty(Town *t)

   274

{

   275

	MarkAllViewportsDirty(

   276

		t->sign.left - 6,

   277

		t->sign.top - 3,

   278

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

   279

		t->sign.top + 45

   280

	);

   281

}

   282

   283

/**

   284

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

   285

 * population (creation or growth or else)

   286

 * @param t Town to update

   287

 */

   288

void UpdateTownVirtCoord(Town *t)

   289

{

   290

	Point pt;

   291

   292

	MarkTownSignDirty(t);

   293

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

   294

	SetDParam(0, t->index);

   295

	SetDParam(1, t->population);

   296

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

   297

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   298

	MarkTownSignDirty(t);

   299

}

   300

   301

/**

   302

 * Change the towns population

   303

 * @param t Town which polulation has changed

   304

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

   305

 */

   306

static void ChangePopulation(Town *t, int mod)

   307

{

   308

	t->population += mod;

   309

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   310

	UpdateTownVirtCoord(t);

   311

   312

	if (_town_sort_order & 2) _town_sort_dirty = true;

   313

}

   314

   315

/**

   316

 * Determines the world population

   317

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

   318

 * @return uint32 the calculated population of the world

   319

 */

   320

uint32 GetWorldPopulation()

   321

{

   322

	uint32 pop;

   323

	const Town* t;

   324

   325

	pop = 0;

   326

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

   327

	return pop;

   328

}

   329

   330

/**

   331

 * Helper function for house completion stages progression

   332

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

   333

 */

   334

static void MakeSingleHouseBigger(TileIndex tile)

   335

{

   336

	assert(IsTileType(tile, MP_HOUSE));

   337

   338

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

   339

	if (LiftHasDestination(tile)) return;

   340

   341

	/* progress in construction stages */

   342

	IncHouseConstructionTick(tile);

   343

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

   344

   345

	/* Check and/or  */

   346

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

   347

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

   348

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

   349

	}

   350

   351

	if (IsHouseCompleted(tile)) {

   352

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

   353

		 * building to the town. */

   354

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

   355

	}

   356

	MarkTileDirtyByTile(tile);

   357

}

   358

   359

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

   360

 * @param tile TileIndex of house

   361

 */

   362

static void MakeTownHouseBigger(TileIndex tile)

   363

{

   364

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

   365

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

   366

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

   367

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

   368

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

   369

}

   370

   371

/**

   372

 * Periodic tic handler for houses and town

   373

 * @param tile been asked to do its stuff

   374

 */

   375

static void TileLoop_Town(TileIndex tile)

   376

{

   377

	Town *t;

   378

	uint32 r;

   379

	HouseID house_id = GetHouseType(tile);

   380

	HouseSpec *hs = GetHouseSpecs(house_id);

   381

   382

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

   383

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

   384

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

   385

   386

	if (!IsHouseCompleted(tile)) {

   387

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

   388

		MakeTownHouseBigger(tile);

   389

		return;

   390

	}

   391

   392

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

   393

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

   394

			house_id < NEW_HOUSE_OFFSET &&

   395

			!LiftHasDestination(tile) &&

   396

			CHANCE16(1, 2))

   397

		AddAnimatedTile(tile);

   398

   399

	t = GetTownByTile(tile);

   400

   401

	r = Random();

   402

   403

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

   404

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

   405

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

   406

   407

			if (callback == CALLBACK_FAILED) break;

   408

			if (callback == 0x20FF) break;

   409

   410

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

   411

			if (cargo == CT_INVALID) continue;

   412

   413

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

   414

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

   415

   416

			const CargoSpec *cs = GetCargo(cargo);

   417

			switch (cs->town_effect) {

   418

				case TE_PASSENGERS:

   419

					t->new_max_pass += amt;

   420

					t->new_act_pass += moved;

   421

					break;

   422

   423

				case TE_MAIL:

   424

					t->new_max_mail += amt;

   425

					t->new_act_mail += moved;

   426

					break;

   427

   428

				default:

   429

					break;

   430

			}

   431

		}

   432

	} else {

   433

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

   434

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

   435

			uint moved;

   436

   437

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

   438

			t->new_max_pass += amt;

   439

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

   440

			t->new_act_pass += moved;

   441

		}

   442

   443

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

   444

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

   445

			uint moved;

   446

   447

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

   448

			t->new_max_mail += amt;

   449

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

   450

			t->new_act_mail += moved;

   451

		}

   452

	}

   453

   454

	_current_player = OWNER_TOWN;

   455

   456

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   457

			HASBIT(t->flags12, TOWN_IS_FUNDED) &&

   458

			CanDeleteHouse(tile) &&

   459

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

   460

			--t->time_until_rebuild == 0) {

   461

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

   462

   463

		ClearTownHouse(t, tile);

   464

   465

		/* Rebuild with another house? */

   466

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

   467

	}

   468

   469

	_current_player = OWNER_NONE;

   470

}

   471

   472

/**

   473

 * Unused handler

   474

 * @param tile unused

   475

 */

   476

static void ClickTile_Town(TileIndex tile)

   477

{

   478

	/* not used */

   479

}

   480

   481

static CommandCost ClearTile_Town(TileIndex tile, byte flags)

   482

{

   483

	int rating;

   484

	CommandCost cost;

   485

	Town *t;

   486

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

   487

   488

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

   489

	if (!CanDeleteHouse(tile)) return CMD_ERROR;

   490