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"

    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) {

   166

		if (HASBIT(_transparent_opt, TO_HOUSES)) {

   167

			SETBIT(image, PALETTE_MODIFIER_TRANSPARENT);

   168

			pal = PALETTE_TO_TRANSPARENT;

   169

		} else {

   170

			pal = dcts->building.pal;

   171

		}

   172

   173

		AddSortableSpriteToDraw(image, pal,

   174

			ti->x + dcts->subtile_x,

   175

			ti->y + dcts->subtile_y,

   176

			dcts->width + 1,

   177

			dcts->height + 1,

   178

			dcts->dz,

   179

			ti->z

   180

		);

   181

   182

		if (HASBIT(_transparent_opt, TO_HOUSES)) return;

   183

	}

   184

   185

	{

   186

		int proc = dcts->draw_proc - 1;

   187

   188

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

   189

	}

   190

}

   191

   192

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

   193

{

   194

	return GetTileMaxZ(tile);

   195

}

   196

   197

static Slope GetSlopeTileh_Town(TileIndex tile, Slope tileh)

   198

{

   199

	return SLOPE_FLAT;

   200

}

   201

   202

/**

   203

 * Animate a tile for a town

   204

 * Only certain houses can be animated

   205

 * The newhouses animation superseeds regular ones

   206

 * @param tile TileIndex of the house to animate

   207

 */

   208

static void AnimateTile_Town(TileIndex tile)

   209

{

   210

	int pos, dest;

   211

   212

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   213

		AnimateNewHouseTile(tile);

   214

		return;

   215

	}

   216

   217

	if (_tick_counter & 3) return;

   218

   219

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

   220

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

   221

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

   222

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

   223

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

   224

		DeleteAnimatedTile(tile);

   225

		return;

   226

	}

   227

   228

	if (!LiftHasDestination(tile)) {

   229

		int i;

   230

   231

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

   232

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

   233

		 *  the height of 2 'normal' floors.

   234

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

   235

		do {

   236

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

   237

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

   238

   239

		SetLiftDestination(tile, i);

   240

	}

   241

   242

	pos = GetLiftPosition(tile);

   243

	dest = GetLiftDestination(tile) * 6;

   244

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

   245

	SetLiftPosition(tile, pos);

   246

   247

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

   248

   249

	MarkTileDirtyByTile(tile);

   250

}

   251

   252

static void UpdateTownRadius(Town *t);

   253

   254

/**

   255

 * Determines if a town is close to a tile

   256

 * @param tile TileIndex of the tile to query

   257

 * @param dist maximum distance to be accepted

   258

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

   259

 */

   260

static bool IsCloseToTown(TileIndex tile, uint dist)

   261

{

   262

	const Town* t;

   263

   264

	FOR_ALL_TOWNS(t) {

   265

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

   266

	}

   267

	return false;

   268

}

   269

   270

/**

   271

 * Marks the town sign as needing a repaint

   272

 * @param t Town requesting repaint

   273

 */

   274

static void MarkTownSignDirty(Town *t)

   275

{

   276

	MarkAllViewportsDirty(

   277

		t->sign.left - 6,

   278

		t->sign.top - 3,

   279

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

   280

		t->sign.top + 45

   281

	);

   282

}

   283

   284

/**

   285

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

   286

 * population (creation or growth or else)

   287

 * @param t Town to update

   288

 */

   289

void UpdateTownVirtCoord(Town *t)

   290

{

   291

	Point pt;

   292

   293

	MarkTownSignDirty(t);

   294

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

   295

	SetDParam(0, t->index);

   296

	SetDParam(1, t->population);

   297

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

   298

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   299

	MarkTownSignDirty(t);

   300

}

   301

   302

/**

   303

 * Change the towns population

   304

 * @param t Town which polulation has changed

   305

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

   306

 */

   307

static void ChangePopulation(Town *t, int mod)

   308

{

   309

	t->population += mod;

   310

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   311

	UpdateTownVirtCoord(t);

   312

   313

	if (_town_sort_order & 2) _town_sort_dirty = true;

   314

}

   315

   316

/**

   317

 * Determines the world population

   318

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

   319

 * @return uint32 the calculated population of the world

   320

 */

   321

uint32 GetWorldPopulation()

   322

{

   323

	uint32 pop;

   324

	const Town* t;

   325

   326

	pop = 0;

   327

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

   328

	return pop;

   329

}

   330

   331

/**

   332

 * Helper function for house completion stages progression

   333

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

   334

 */

   335

static void MakeSingleHouseBigger(TileIndex tile)

   336

{

   337

	assert(IsTileType(tile, MP_HOUSE));

   338

   339

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

   340

	if (LiftHasDestination(tile)) return;

   341

   342

	/* progress in construction stages */

   343

	IncHouseConstructionTick(tile);

   344

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

   345

   346

	/* Check and/or  */

   347

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

   349

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

   350

	}

   351

   352

	if (IsHouseCompleted(tile)) {

   353

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

   354

		 * building to the town. */

   355

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

   356

	}

   357

	MarkTileDirtyByTile(tile);

   358

}

   359

   360

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

   361

 * @param tile TileIndex of house

   362

 */

   363

static void MakeTownHouseBigger(TileIndex tile)

   364

{

   365

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

   366

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

   367

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

   368

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

   369

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

   370

}

   371

   372

/**

   373

 * Periodic tic handler for houses and town

   374

 * @param tile been asked to do its stuff

   375

 */

   376

static void TileLoop_Town(TileIndex tile)

   377

{

   378

	Town *t;

   379

	uint32 r;

   380

	HouseID house_id = GetHouseType(tile);

   381

	HouseSpec *hs = GetHouseSpecs(house_id);

   382

   383

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

   384

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

   385

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

   386

   387

	if (!IsHouseCompleted(tile)) {

   388

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

   389

		MakeTownHouseBigger(tile);

   390

		return;

   391

	}

   392

   393

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

   394

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

   395

			house_id < NEW_HOUSE_OFFSET &&

   396

			!LiftHasDestination(tile) &&

   397

			CHANCE16(1, 2))

   398

		AddAnimatedTile(tile);

   399

   400

	t = GetTownByTile(tile);

   401

   402

	r = Random();

   403

   404

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

   405

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

   406

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

   407

   408

			if (callback == CALLBACK_FAILED) break;

   409

			if (callback == 0x20FF) break;

   410

   411

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

   412

			if (cargo == CT_INVALID) continue;

   413

   414

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

   415

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

   416

   417

			const CargoSpec *cs = GetCargo(cargo);

   418

			switch (cs->town_effect) {

   419

				case TE_PASSENGERS:

   420

					t->new_max_pass += amt;

   421

					t->new_act_pass += moved;

   422

					break;

   423

   424

				case TE_MAIL:

   425

					t->new_max_mail += amt;

   426

					t->new_act_mail += moved;

   427

					break;

   428

   429

				default:

   430

					break;

   431

			}

   432

		}

   433

	} else {

   434

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

   435

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

   436

			uint moved;

   437

   438

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

   439

			t->new_max_pass += amt;

   440

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

   441

			t->new_act_pass += moved;

   442

		}

   443

   444

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

   445

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

   446

			uint moved;

   447

   448

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

   449

			t->new_max_mail += amt;

   450

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

   451

			t->new_act_mail += moved;

   452

		}

   453

	}

   454

   455

	_current_player = OWNER_TOWN;

   456

   457

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   458

			HASBIT(t->flags12, TOWN_IS_FUNDED) &&

   459

			CanDeleteHouse(tile) &&

   460

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

   461

			--t->time_until_rebuild == 0) {

   462

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

   463

   464

		ClearTownHouse(t, tile);

   465

   466

		/* Rebuild with another house? */

   467

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

   468

	}

   469

   470

	_current_player = OWNER_NONE;

   471

}

   472

   473

/**

   474

 * Unused handler

   475

 * @param tile unused

   476

 */

   477

static void ClickTile_Town(TileIndex tile)

   478

{

   479

	/* not used */

   480

}

   481

   483

{

   484

	int rating;

   486

	Town *t;

   487

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

   488

   489

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

   490

	if (!CanDeleteHouse(tile)) return CMD_ERROR;