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

    42

/**

    43

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

    44

 */

    45

static void TownPoolNewBlock(uint start_item)

    46

{

    47

	Town *t;

    48

    49

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

    50

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

    51

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

    52

}

    53

    54

/* Initialize the town-pool */

    55

DEFINE_OLD_POOL(Town, Town, TownPoolNewBlock, NULL)

    56

    57

/**

    58

 * Removes a specific town as well as all industries

    59

 * under its "juridiction"

    60

 * @param t Town to remove

    61

 */

    62

void DestroyTown(Town *t)

    63

{

    64

	Industry *i;

    65

	TileIndex tile;

    66

    67

	/* Delete town authority window

    68

	 * and remove from list of sorted towns */

    69

	DeleteWindowById(WC_TOWN_VIEW, t->index);

    70

	_town_sort_dirty = true;

    71

	_total_towns--;

    72

    73

	/* Delete all industries belonging to the town */

    74

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

    75

    76

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

    77

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

    78

		switch (GetTileType(tile)) {

    79

			case MP_HOUSE:

    80

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

    81

				break;

    82

    83

			case MP_STREET:

    84

			case MP_TUNNELBRIDGE:

    85

				if (IsTileOwner(tile, OWNER_TOWN) &&

    86

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

    87

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

    88

				break;

    89

    90

			default:

    91

				break;

    92

		}

    93

	}

    94

    95

	DeleteName(t->townnametype);

    96

	DeleteSubsidyWithTown(t->index);

    97

    98

	MarkWholeScreenDirty();

    99

}

   100

   101

// Local

   102

static int _grow_town_result;

   103

   104

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

   105

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

   106

   107

static void TownDrawHouseLift(const TileInfo *ti)

   108

{

   109

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

   110

}

   111

   112

typedef void TownDrawTileProc(const TileInfo *ti);

   113

static TownDrawTileProc * const _town_draw_tile_procs[1] = {

   114

	TownDrawHouseLift

   115

};

   116

   117

uint OriginalTileRandomiser(uint x, uint y)

   118

{

   119

	uint variant;

   120

	variant  = x >> 4;

   121

	variant ^= x >> 6;

   122

	variant ^= y >> 4;

   123

	variant -= y >> 6;

   124

	variant &= 3;

   125

	return variant;

   126

}

   127

   128

/**

   129

 * House Tile drawing handler.

   130

 * Part of the tile loop process

   131

 * @param ti TileInfo of the tile to draw

   132

 */

   133

static void DrawTile_Town(TileInfo *ti)

   134

{

   135

	const DrawBuildingsTileStruct *dcts;

   136

	SpriteID image;

   137

	SpriteID pal;

   138

	HouseID house_id = GetHouseType(ti->tile);

   139

   140

	if (house_id >= NEW_HOUSE_OFFSET) {

   141

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

   142

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

   143

		 * house id is drawn instead. */

   144

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

   145

			DrawNewHouseTile(ti, house_id);

   146

			return;

   147

		} else {

   148

			house_id = GetHouseSpecs(house_id)->substitute_id;

   149

		}

   150

	}

   151

   152

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

   153

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

   154

   155

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

   156

   157

	image = dcts->ground.sprite;

   158

	pal   = dcts->ground.pal;

   159

	DrawGroundSprite(image, pal);

   160

   161

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

   162

	image = dcts->building.sprite;

   163

	if (image != 0) {

   164

		if (HASBIT(_transparent_opt, TO_HOUSES)) {

   165

			SETBIT(image, PALETTE_MODIFIER_TRANSPARENT);

   166

			pal = PALETTE_TO_TRANSPARENT;

   167

		} else {

   168

			pal = dcts->building.pal;

   169

		}

   170

   171

		AddSortableSpriteToDraw(image, pal,

   172

			ti->x + dcts->subtile_x,

   173

			ti->y + dcts->subtile_y,

   174

			dcts->width + 1,

   175

			dcts->height + 1,

   176

			dcts->dz,

   177

			ti->z

   178

		);

   179

   180

		if (HASBIT(_transparent_opt, TO_HOUSES)) return;

   181

	}

   182

   183

	{

   184

		int proc = dcts->draw_proc - 1;

   185

   186

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

   187

	}

   188

}

   189

   190

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

   191

{

   192

	return GetTileMaxZ(tile);

   193

}

   194

   195

static Slope GetSlopeTileh_Town(TileIndex tile, Slope tileh)

   196

{

   197

	return SLOPE_FLAT;

   198

}

   199

   200

/**

   201

 * Animate a tile for a town

   202

 * Only certain houses can be animated

   203

 * The newhouses animation superseeds regular ones

   204

 * @param tile TileIndex of the house to animate

   205

 */

   206

static void AnimateTile_Town(TileIndex tile)

   207

{

   208

	int pos, dest;

   209

   210

	if (GetHouseType(tile) >= NEW_HOUSE_OFFSET) {

   211

		AnimateNewHouseTile(tile);

   212

		return;

   213

	}

   214

   215

	if (_tick_counter & 3) return;

   216

   217

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

   218

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

   219

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

   220

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

   221

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

   222

		DeleteAnimatedTile(tile);

   223

		return;

   224

	}

   225

   226

	if (!LiftHasDestination(tile)) {

   227

		int i;

   228

   229

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

   230

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

   231

		 *  the height of 2 'normal' floors.

   232

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

   233

		do {

   234

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

   235

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

   236

   237

		SetLiftDestination(tile, i);

   238

	}

   239

   240

	pos = GetLiftPosition(tile);

   241

	dest = GetLiftDestination(tile) * 6;

   242

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

   243

	SetLiftPosition(tile, pos);

   244

   245

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

   246

   247

	MarkTileDirtyByTile(tile);

   248

}

   249

   250

static void UpdateTownRadius(Town *t);

   251

   252

/**

   253

 * Determines if a town is close to a tile

   254

 * @param tile TileIndex of the tile to query

   255

 * @param dist maximum distance to be accepted

   256

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

   257

 */

   258

static bool IsCloseToTown(TileIndex tile, uint dist)

   259

{

   260

	const Town* t;

   261

   262

	FOR_ALL_TOWNS(t) {

   263

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

   264

	}

   265

	return false;

   266

}

   267

   268

/**

   269

 * Marks the town sign as needing a repaint

   270

 * @param t Town requesting repaint

   271

 */

   272

static void MarkTownSignDirty(Town *t)

   273

{

   274

	MarkAllViewportsDirty(

   275

		t->sign.left - 6,

   276

		t->sign.top - 3,

   277

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

   278

		t->sign.top + 45

   279

	);

   280

}

   281

   282

/**

   283

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

   284

 * population (creation or growth or else)

   285

 * @param t Town to update

   286

 */

   287

void UpdateTownVirtCoord(Town *t)

   288

{

   289

	Point pt;

   290

   291

	MarkTownSignDirty(t);

   292

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

   293

	SetDParam(0, t->index);

   294

	SetDParam(1, t->population);

   295

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

   296

		_patches.population_in_label ? STR_TOWN_LABEL_POP : STR_TOWN_LABEL);

   297

	MarkTownSignDirty(t);

   298

}

   299

   300

/**

   301

 * Change the towns population

   302

 * @param t Town which polulation has changed

   303

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

   304

 */

   305

static void ChangePopulation(Town *t, int mod)

   306

{

   307

	t->population += mod;

   308

	InvalidateWindow(WC_TOWN_VIEW, t->index);

   309

	UpdateTownVirtCoord(t);

   310

   311

	if (_town_sort_order & 2) _town_sort_dirty = true;

   312

}

   313

   314

/**

   315

 * Determines the world population

   316

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

   317

 * @return uint32 the calculated population of the world

   318

 */

   319

uint32 GetWorldPopulation()

   320

{

   321

	uint32 pop;

   322

	const Town* t;

   323

   324

	pop = 0;

   325

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

   326

	return pop;

   327

}

   328

   329

/**

   330

 * Helper function for house completion stages progression

   331

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

   332

 */

   333

static void MakeSingleHouseBigger(TileIndex tile)

   334

{

   335

	assert(IsTileType(tile, MP_HOUSE));

   336

   337

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

   338

	if (LiftHasDestination(tile)) return;

   339

   340

	/* progress in construction stages */

   341

	IncHouseConstructionTick(tile);

   342

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

   343

   344

	/* Check and/or  */

   345

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

   346

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

   347

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

   348

	}

   349

   350

	if (IsHouseCompleted(tile)) {

   351

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

   352

		 * building to the town. */

   353

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

   354

	}

   355

	MarkTileDirtyByTile(tile);

   356

}

   357

   358

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

   359

 * @param tile TileIndex of house

   360

 */

   361

static void MakeTownHouseBigger(TileIndex tile)

   362

{

   363

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

   364

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

   365

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

   366

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

   367

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

   368

}

   369

   370

/**

   371

 * Periodic tic handler for houses and town

   372

 * @param tile been asked to do its stuff

   373

 */

   374

static void TileLoop_Town(TileIndex tile)

   375

{

   376

	Town *t;

   377

	uint32 r;

   378

	HouseID house_id = GetHouseType(tile);

   379

	HouseSpec *hs = GetHouseSpecs(house_id);

   380

   381

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

   382

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

   383

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

   384

   385

	if (!IsHouseCompleted(tile)) {

   386

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

   387

		MakeTownHouseBigger(tile);

   388

		return;

   389

	}

   390

   391

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

   392

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

   393

			house_id < NEW_HOUSE_OFFSET &&

   394

			!LiftHasDestination(tile) &&

   395

			CHANCE16(1, 2))

   396

		AddAnimatedTile(tile);

   397

   398

	t = GetTownByTile(tile);

   399

   400

	r = Random();

   401

   402

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

   403

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

   404

		uint moved;

   405

   406

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

   407

		t->new_max_pass += amt;

   408

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

   409

		t->new_act_pass += moved;

   410

	}

   411

   412

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

   413

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

   414

		uint moved;

   415

   416

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

   417

		t->new_max_mail += amt;

   418

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

   419

		t->new_act_mail += moved;

   420

	}

   421

   422

	_current_player = OWNER_TOWN;

   423

   424

	if (hs->building_flags & BUILDING_HAS_1_TILE &&

   425

			HASBIT(t->flags12, TOWN_IS_FUNDED) &&

   426

			CanDeleteHouse(tile) &&

   427

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

   428

			--t->time_until_rebuild == 0) {

   429

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

   430

   431

		ClearTownHouse(t, tile);

   432

   433

		/* Rebuild with another house? */

   434

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

   435

	}

   436

   437

	_current_player = OWNER_NONE;

   438

}

   439

   440

/**

   441

 * Unused handler

   442

 * @param tile unused

   443

 */

   444

static void ClickTile_Town(TileIndex tile)

   445

{

   446

	/* not used */

   447

}

   448

   449

static int32 ClearTile_Town(TileIndex tile, byte flags)

   450

{

   451

	int rating;

   452

	int32 cost;

   453

	Town *t;

   454

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

   455

   456

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

   457

	if (!CanDeleteHouse(tile)) return CMD_ERROR;

   458

   459

	cost = _price.remove_house * hs->removal_cost >> 8;

   460

   461

	rating = hs->remove_rating_decrease;

   462

	_cleared_town_rating += rating;

   463

	_cleared_town = t = GetTownByTile(tile);

   464

   465

	if (IsValidPlayer(_current_player)) {

   466

		if (rating > t->ratings[_current_player] && !(flags & DC_NO_TOWN_RATING) && !_cheats.magic_bulldozer.value) {

   467

			SetDParam(0, t->index);

   468

			return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   469

		}

   470

	}

   471

   472

	if (flags & DC_EXEC) {

   473

		ChangeTownRating(t, -rating, RATING_HOUSE_MINIMUM);

   474

		ClearTownHouse(t, tile);

   475

	}

   476

   477

	return cost;

   478

}

   479

   480

static void GetAcceptedCargo_Town(TileIndex tile, AcceptedCargo ac)

   481

{

   482

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

   483

	CargoID accepts[3];

   484

   485

	/* Set the initial accepted cargo types */

   486

	for (uint8 i = 0; i < lengthof(accepts); i++) {

   487

		accepts[i] = hs->accepts_cargo[i];

   488

	}

   489

   490

	/* Check for custom accepted cargo types */

   491