1

/* $Id$ */

     2

     3

/** @file newgrf_house.cpp Implementation of NewGRF houses. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "debug.h"

     9

#include "viewport_func.h"

    10

#include "landscape.h"

    11

#include "town.h"

    12

#include "town_map.h"

    13

#include "sprite.h"

    14

#include "newgrf.h"

    15

#include "newgrf_house.h"

    16

#include "newgrf_spritegroup.h"

    17

#include "newgrf_callbacks.h"

    18

#include "newgrf_town.h"

    19

#include "newgrf_sound.h"

    20

#include "newgrf_commons.h"

    21

#include "transparency.h"

    22

#include "functions.h"

    23

#include "player_func.h"

    24

#include "animated_tile_func.h"

    25

#include "date_func.h"

    26

    27

#include "table/strings.h"

    28

#include "table/sprites.h"

    29

#include "table/town_land.h"

    30

    31

static BuildingCounts    _building_counts;

    32

static HouseClassMapping _class_mapping[HOUSE_CLASS_MAX];

    33

    34

HouseOverrideManager _house_mngr(NEW_HOUSE_OFFSET, HOUSE_MAX, INVALID_HOUSE_ID);

    35

    36

/**

    37

 * Check and update town and house values.

    38

 *

    39

 * Checked are the HouseIDs. Updated are the

    40

 * town population the number of houses per

    41

 * town, the town radius and the max passengers

    42

 * of the town.

    43

 */

    44

void UpdateHousesAndTowns()

    45

{

    46

	Town *town;

    47

	InitializeBuildingCounts();

    48

    49

	/* Reset town population and num_houses */

    50

	FOR_ALL_TOWNS(town) {

    51

		town->population = 0;

    52

		town->num_houses = 0;

    53

	}

    54

    55

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

    56

		HouseID house_id;

    57

    58

		if (!IsTileType(t, MP_HOUSE)) continue;

    59

    60

		house_id = GetHouseType(t);

    61

		if (!GetHouseSpecs(house_id)->enabled && house_id >= NEW_HOUSE_OFFSET) {

    62

			/* The specs for this type of house are not available any more, so

    63

			 * replace it with the substitute original house type. */

    64

			house_id = _house_mngr.GetSubstituteID(house_id);

    65

			SetHouseType(t, house_id);

    66

		}

    67

    68

		town = GetTownByTile(t);

    69

		IncreaseBuildingCount(town, house_id);

    70

		if (IsHouseCompleted(t)) town->population += GetHouseSpecs(house_id)->population;

    71

    72

		/* Increase the number of houses for every house, but only once. */

    73

		if (GetHouseNorthPart(house_id) == 0) town->num_houses++;

    74

	}

    75

    76

	/* Update the population and num_house dependant values */

    77

	FOR_ALL_TOWNS(town) {

    78

		UpdateTownRadius(town);

    79

		UpdateTownMaxPass(town);

    80

	}

    81

}

    82

    83

HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid)

    84

{

    85

	/* Start from 1 because 0 means that no class has been assigned. */

    86

	for (int i = 1; i != lengthof(_class_mapping); i++) {

    87

		HouseClassMapping *map = &_class_mapping[i];

    88

    89

		if (map->class_id == grf_class_id && map->grfid == grfid) return (HouseClassID)i;

    90

    91

		if (map->class_id == 0 && map->grfid == 0) {

    92

			map->class_id = grf_class_id;

    93

			map->grfid    = grfid;

    94

			return (HouseClassID)i;

    95

		}

    96

	}

    97

	return HOUSE_NO_CLASS;

    98

}

    99

   100

void InitializeBuildingCounts()

   101

{

   102

	memset(&_building_counts, 0, sizeof(_building_counts));

   103

}

   104

   105

/**

   106

 * IncreaseBuildingCount()

   107

 * Increase the count of a building when it has been added by a town.

   108

 * @param t The town that the building is being built in

   109

 * @param house_id The id of the house being added

   110

 */

   111

void IncreaseBuildingCount(Town *t, HouseID house_id)

   112

{

   113

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   114

   115

	if (!_loaded_newgrf_features.has_newhouses) return;

   116

   117

	/* If there are 255 buildings of this type in this town, there are also

   118

	 * at least that many houses of the same class in the town, and

   119

	 * therefore on the map as well. */

   120

	if (t->building_counts.id_count[house_id] == 255) return;

   121

   122

	t->building_counts.id_count[house_id]++;

   123

	if (_building_counts.id_count[house_id] < 255) _building_counts.id_count[house_id]++;

   124

   125

	/* Similarly, if there are 255 houses of this class in this town, there

   126

	 * must be at least that number on the map too. */

   127

	if (class_id == HOUSE_NO_CLASS || t->building_counts.class_count[class_id] == 255) return;

   128

   129

	t->building_counts.class_count[class_id]++;

   130

	if (_building_counts.class_count[class_id] < 255) _building_counts.class_count[class_id]++;

   131

}

   132

   133

/**

   134

 * DecreaseBuildingCount()

   135

 * Decrease the number of a building when it is deleted.

   136

 * @param t The town that the building was built in

   137

 * @param house_id The id of the house being removed

   138

 */

   139

void DecreaseBuildingCount(Town *t, HouseID house_id)

   140

{

   141

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   142

   143

	if (!_loaded_newgrf_features.has_newhouses) return;

   144

   145

	if (t->building_counts.id_count[house_id] > 0) t->building_counts.id_count[house_id]--;

   146

	if (_building_counts.id_count[house_id] > 0)   _building_counts.id_count[house_id]--;

   147

   148

	if (class_id == HOUSE_NO_CLASS) return;

   149

   150

	if (t->building_counts.class_count[class_id] > 0) t->building_counts.class_count[class_id]--;

   151

	if (_building_counts.class_count[class_id] > 0)   _building_counts.class_count[class_id]--;

   152

}

   153

   154

static uint32 HouseGetRandomBits(const ResolverObject *object)

   155

{

   156

	const TileIndex tile = object->u.house.tile;

   157

	return (tile == INVALID_TILE || !IsTileType(tile, MP_HOUSE)) ? 0 : GetHouseRandomBits(tile);

   158

}

   159

   160

static uint32 HouseGetTriggers(const ResolverObject *object)

   161

{

   162

	const TileIndex tile = object->u.house.tile;

   163

	return (tile == INVALID_TILE || !IsTileType(tile, MP_HOUSE)) ? 0 : GetHouseTriggers(tile);

   164

}

   165

   166

static void HouseSetTriggers(const ResolverObject *object, int triggers)

   167

{

   168

	const TileIndex tile = object->u.house.tile;

   169

	if (IsTileType(tile, MP_HOUSE)) SetHouseTriggers(tile, triggers);

   170

}

   171

   172

static uint32 GetNumHouses(HouseID house_id, const Town *town)

   173

{

   174

	uint8 map_id_count, town_id_count, map_class_count, town_class_count;

   175

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   176

   177

	map_id_count     = _building_counts.id_count[house_id];

   178

	map_class_count  = _building_counts.class_count[class_id];

   179

	town_id_count    = town->building_counts.id_count[house_id];

   180

	town_class_count = town->building_counts.class_count[class_id];

   181

   182

	return map_class_count << 24 | town_class_count << 16 | map_id_count << 8 | town_id_count;

   183

}

   184

   185

static uint32 GetGRFParameter(HouseID house_id, byte parameter)

   186

{

   187

	const HouseSpec *hs = GetHouseSpecs(house_id);

   188

	const GRFFile *file = hs->grffile;

   189

   190

	if (parameter >= file->param_end) return 0;

   191

	return file->param[parameter];

   192

}

   193

   194

uint32 GetNearbyTileInformation(byte parameter, TileIndex tile)

   195

{

   196

	tile = GetNearbyTile(parameter, tile);

   197

	return GetNearbyTileInformation(tile);

   198

}

   199

   200

/** Structure with user-data for SearchNearbyHouseXXX - functions */

   201

typedef struct {

   202

	const HouseSpec *hs;  ///< Specs of the house, that startet the search

   203

	TileIndex north_tile; ///< Northern tile of the house.

   204

} SearchNearbyHouseData;

   205

   206

/** Callback function to search a house by its HouseID

   207

 * @param tile TileIndex to be examined

   208

 * @param user_data SearchNearbyHouseData

   209

 * @return true or false, if found or not

   210

 */

   211

static bool SearchNearbyHouseID(TileIndex tile, void *user_data)

   212

{

   213

	if (IsTileType(tile, MP_HOUSE)) {

   214

		HouseID house = GetHouseType(tile); // tile been examined

   215

		const HouseSpec *hs = GetHouseSpecs(house);

   216

		if (hs->grffile != NULL) { // must be one from a grf file

   217

			SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;

   218

   219

			TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!

   220

			if (north_tile == nbhd->north_tile) return false; // Always ignore origin house

   221

   222

			return hs->local_id == nbhd->hs->local_id &&  // same local id as the one requested

   223

				hs->grffile->grfid == nbhd->hs->grffile->grfid;  // from the same grf

   224

		}

   225

	}

   226

	return false;

   227

}

   228

   229

/** Callback function to search a house by its classID

   230

 * @param tile TileIndex to be examined

   231

 * @param user_data SearchNearbyHouseData

   232

 * @return true or false, if found or not

   233

 */

   234

static bool SearchNearbyHouseClass(TileIndex tile, void *user_data)

   235

{

   236

	if (IsTileType(tile, MP_HOUSE)) {

   237

		HouseID house = GetHouseType(tile); // tile been examined

   238

		const HouseSpec *hs = GetHouseSpecs(house);

   239

		if (hs->grffile != NULL) { // must be one from a grf file

   240

			SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;

   241

   242

			TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!

   243

			if (north_tile == nbhd->north_tile) return false; // Always ignore origin house

   244

   245

			return hs->class_id == nbhd->hs->class_id &&  // same classid as the one requested

   246

				hs->grffile->grfid == nbhd->hs->grffile->grfid;  // from the same grf

   247

		}

   248

	}

   249

	return false;

   250

}

   251

   252

/** Callback function to search a house by its grfID

   253

 * @param tile TileIndex to be examined

   254

 * @param user_data SearchNearbyHouseData

   255

 * @return true or false, if found or not

   256

 */

   257

static bool SearchNearbyHouseGRFID(TileIndex tile, void *user_data)

   258

{

   259

	if (IsTileType(tile, MP_HOUSE)) {

   260

		HouseID house = GetHouseType(tile); // tile been examined

   261

		const HouseSpec *hs = GetHouseSpecs(house);

   262

		if (hs->grffile != NULL) { // must be one from a grf file

   263

			SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;

   264

   265

			TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!

   266

			if (north_tile == nbhd->north_tile) return false; // Always ignore origin house

   267

   268

			return hs->grffile->grfid == nbhd->hs->grffile->grfid;  // from the same grf

   269

		}

   270

	}

   271

	return false;

   272

}

   273

   274

/** This function will activate a search around a central tile, looking for some houses

   275

 * that fit the requested characteristics

   276

 * @param parameter that is given by the callback.

   277

 *                  bits 0..6 radius of the search

   278

 *                  bits 7..8 search type i.e.: 0 = houseID/ 1 = classID/ 2 = grfID

   279

 * @param tile TileIndex from which to start the search

   280

 * @param house the HouseID that is associated to the house, the callback is called for

   281

 * @return the Manhattan distance from the center tile, if any, and 0 if failure

   282

 */

   283

static uint32 GetDistanceFromNearbyHouse(uint8 parameter, TileIndex tile, HouseID house)

   284

{

   285

	static TestTileOnSearchProc * const search_procs[3] = {

   286

		SearchNearbyHouseID,

   287

		SearchNearbyHouseClass,

   288

		SearchNearbyHouseGRFID,

   289

	};

   290

	TileIndex found_tile = tile;

   291

	uint8 searchtype = GB(parameter, 6, 2);

   292

	uint8 searchradius = GB(parameter, 0, 6);

   293

	if (searchtype >= lengthof(search_procs)) return 0;  // do not run on ill-defined code

   294

	if (searchradius < 1) return 0; // do not use a too low radius

   295

   296

	SearchNearbyHouseData nbhd;

   297

	nbhd.hs = GetHouseSpecs(house);

   298

	nbhd.north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!

   299

   300

	/* Use a pointer for the tile to start the search. Will be required for calculating the distance*/

   301

	if (CircularTileSearch(&found_tile, 2 * searchradius + 1, search_procs[searchtype], &nbhd)) {

   302

		return DistanceManhattan(found_tile, tile);

   303

	}

   304

	return 0;

   305

}

   306

   307

/**

   308

 * HouseGetVariable():

   309

 *

   310

 * Used by the resolver to get values for feature 07 deterministic spritegroups.

   311

 */

   312

static uint32 HouseGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)

   313

{

   314

	const Town *town = object->u.house.town;

   315

	TileIndex tile   = object->u.house.tile;

   316

	HouseID house_id = object->u.house.house_id;

   317

   318

	if (object->scope == VSG_SCOPE_PARENT) {

   319

		return TownGetVariable(variable, parameter, available, town);

   320

	}

   321

   322

	switch (variable) {

   323

		/* Construction stage. */

   324

		case 0x40: return (IsTileType(tile, MP_HOUSE) ? GetHouseBuildingStage(tile) : 0) | TileHash2Bit(TileX(tile), TileY(tile)) << 2;

   325

   326

		/* Building age. */

   327

		case 0x41: return Clamp(_cur_year - GetHouseConstructionYear(tile), 0, 0xFF);

   328

   329

		/* Town zone */

   330

		case 0x42: return GetTownRadiusGroup(town, tile);

   331

   332

		/* Terrain type */

   333

		case 0x43: return GetTerrainType(tile);

   334

   335

		/* Number of this type of building on the map. */

   336

		case 0x44: return GetNumHouses(house_id, town);

   337

   338

		/* Whether the town is being created or just expanded. */

   339

		case 0x45: return _generating_world ? 1 : 0;

   340

   341

		/* Current animation frame. */

   342

		case 0x46: return IsTileType(tile, MP_HOUSE) ? GetHouseAnimationFrame(tile) : 0;

   343

   344

   345

		/* Building counts for old houses with id = parameter. */

   346

		case 0x60: return GetNumHouses(parameter, town);

   347

   348

		/* Building counts for new houses with id = parameter. */

   349

		case 0x61: {

   350

			const HouseSpec *hs = GetHouseSpecs(house_id);

   351

			if (hs->grffile == NULL) return 0;

   352

   353

			HouseID new_house = _house_mngr.GetID(parameter, hs->grffile->grfid);

   354

			return new_house == INVALID_HOUSE_ID ? 0 : GetNumHouses(new_house, town);

   355

		}

   356

   357

		/* Land info for nearby tiles. */

   358

		case 0x62: return GetNearbyTileInformation(parameter, tile);

   359

   360

		/* Current animation frame of nearby house tiles */

   361

		case 0x63: {

   362

			TileIndex testtile = GetNearbyTile(parameter, tile);

   363

			return IsTileType(testtile, MP_HOUSE) ? GetHouseAnimationFrame(testtile) : 0;

   364

		}

   365

   366

		/* Cargo acceptance history of nearby stations */

   367

		/*case 0x64: not implemented yet */

   368

   369

		/* Distance test for some house types */

   370

		case 0x65: return GetDistanceFromNearbyHouse(parameter, tile, object->u.house.house_id);

   371

   372

		/* Read GRF parameter */

   373

		case 0x7F: return GetGRFParameter(object->u.house.house_id, parameter);

   374

	}

   375

   376

	DEBUG(grf, 1, "Unhandled house property 0x%X", variable);

   377

   378

	*available = false;

   379

	return UINT_MAX;

   380

}

   381

   382

static const SpriteGroup *HouseResolveReal(const ResolverObject *object, const SpriteGroup *group)

   383

{

   384

	/* Houses do not have 'real' groups */

   385

	return NULL;

   386

}

   387

   388

/**

   389

 * NewHouseResolver():

   390

 *

   391

 * Returns a resolver object to be used with feature 07 spritegroups.

   392

 */

   393

static void NewHouseResolver(ResolverObject *res, HouseID house_id, TileIndex tile, Town *town)

   394

{

   395

	res->GetRandomBits = HouseGetRandomBits;

   396

	res->GetTriggers   = HouseGetTriggers;

   397

	res->SetTriggers   = HouseSetTriggers;

   398

	res->GetVariable   = HouseGetVariable;

   399

	res->ResolveReal   = HouseResolveReal;

   400

   401

	res->u.house.tile     = tile;

   402

	res->u.house.town     = town;

   403

	res->u.house.house_id = house_id;

   404

   405

	res->callback        = CBID_NO_CALLBACK;

   406

	res->callback_param1 = 0;

   407

	res->callback_param2 = 0;

   408

	res->last_value      = 0;

   409

	res->trigger         = 0;

   410

	res->reseed          = 0;

   411

	res->count           = 0;

   412

}

   413

   414

uint16 GetHouseCallback(CallbackID callback, uint32 param1, uint32 param2, HouseID house_id, Town *town, TileIndex tile)

   415

{

   416

	ResolverObject object;

   417

	const SpriteGroup *group;

   418

   419

	NewHouseResolver(&object, house_id, tile, town);

   420

	object.callback = callback;

   421

	object.callback_param1 = param1;

   422

	object.callback_param2 = param2;

   423

   424

	group = Resolve(GetHouseSpecs(house_id)->spritegroup, &object);

   425

	if (group == NULL || group->type != SGT_CALLBACK) return CALLBACK_FAILED;

   426

   427

	return group->g.callback.result;

   428

}

   429

   430

void DrawTileLayout(const TileInfo *ti, const SpriteGroup *group, byte stage, HouseID house_id)

   431

{

   432

	const DrawTileSprites *dts = group->g.layout.dts;

   433

	const DrawTileSeqStruct *dtss;

   434

   435

	SpriteID image = dts->ground.sprite;

   436

	SpriteID pal   = dts->ground.pal;

   437

   438

	if (IS_CUSTOM_SPRITE(image)) image += stage;

   439

   440

	if (GB(image, 0, SPRITE_WIDTH) != 0) DrawGroundSprite(image, pal);

   441

   442

	foreach_draw_tile_seq(dtss, dts->seq) {

   443

		if (GB(dtss->image.sprite, 0, SPRITE_WIDTH) == 0) continue;

   444

   445

		image = dtss->image.sprite;

   446

		pal   = dtss->image.pal;

   447

   448

		/* Stop drawing sprite sequence once we meet a sprite that doesn't have to be opaque */

   449

		if (IsInvisibilitySet(TO_HOUSES) && !HasBit(image, SPRITE_MODIFIER_OPAQUE)) return;

   450

   451

		if (IS_CUSTOM_SPRITE(image)) image += stage;

   452

   453

		if ((HasBit(image, SPRITE_MODIFIER_OPAQUE) || !IsTransparencySet(TO_HOUSES)) && HasBit(image, PALETTE_MODIFIER_COLOR)) {

   454

			if (pal == 0) {

   455

				const HouseSpec *hs = GetHouseSpecs(house_id);

   456

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

   457

					uint16 callback = GetHouseCallback(CBID_HOUSE_COLOUR, 0, 0, house_id, GetTownByTile(ti->tile), ti->tile);

   458

					if (callback != CALLBACK_FAILED) {

   459

						/* If bit 14 is set, we should use a 2cc colour map, else use the callback value. */

   460

						pal = HasBit(callback, 14) ? GB(callback, 0, 8) + SPR_2CCMAP_BASE : callback;

   461

					}

   462

				} else {

   463

					pal = hs->random_colour[TileHash2Bit(ti->x, ti->y)] + PALETTE_RECOLOR_START;

   464

				}

   465

			}

   466

		} else {

   467

			pal = PAL_NONE;

   468

		}

   469

   470

		if ((byte)dtss->delta_z != 0x80) {

   471

			AddSortableSpriteToDraw(

   472

				image, pal,

   473

				ti->x + dtss->delta_x, ti->y + dtss->delta_y,

   474

				dtss->size_x, dtss->size_y,

   475

				dtss->size_z, ti->z + dtss->delta_z,

   476

				IsTransparencySet(TO_HOUSES)

   477

			);

   478

		} else {

   479

			AddChildSpriteScreen(image, pal, (byte)dtss->delta_x, (byte)dtss->delta_y, IsTransparencySet(TO_HOUSES));

   480

		}

   481

	}

   482

}

   483

   484

void DrawNewHouseTile(TileInfo *ti, HouseID house_id)

   485

{

   486

	const HouseSpec *hs = GetHouseSpecs(house_id);

   487

	const SpriteGroup *group;

   488

	ResolverObject object;

   489

   490

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

   491

   492

	NewHouseResolver(&object, house_id, ti->tile, GetTownByTile(ti->tile));

   493

   494

	group = Resolve(hs->spritegroup, &object);

   495

	if (group == NULL || group->type != SGT_TILELAYOUT) {

   496

		/* XXX: This is for debugging purposes really, and shouldn't stay. */

   497

		DrawGroundSprite(SPR_SHADOW_CELL, PAL_NONE);

   498

	} else {

   499

		/* Limit the building stage to the number of stages supplied. */

   500

		byte stage = GetHouseBuildingStage(ti->tile);

   501

		stage = Clamp(stage - 4 + group->g.layout.num_sprites, 0, group->g.layout.num_sprites - 1);

   502

		DrawTileLayout(ti, group, stage, house_id);

   503

	}

   504

}

   505

   506

void AnimateNewHouseTile(TileIndex tile)

   507

{

   508

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