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 "company_func.h"

    24

#include "animated_tile_func.h"

    25

#include "date_func.h"

    26

#include "company_base.h"

    27

    28

#include "table/strings.h"

    29

#include "table/sprites.h"

    30

#include "table/town_land.h"

    31

    32

static BuildingCounts    _building_counts;

    33

static HouseClassMapping _class_mapping[HOUSE_CLASS_MAX];

    34

    35

HouseOverrideManager _house_mngr(NEW_HOUSE_OFFSET, HOUSE_MAX, INVALID_HOUSE_ID);

    36

    37

/**

    38

 * Check and update town and house values.

    39

 *

    40

 * Checked are the HouseIDs. Updated are the

    41

 * town population the number of houses per

    42

 * town, the town radius and the max passengers

    43

 * of the town.

    44

 */

    45

void UpdateHousesAndTowns()

    46

{

    47

	Town *town;

    48

	InitializeBuildingCounts();

    49

    50

	/* Reset town population and num_houses */

    51

	FOR_ALL_TOWNS(town) {

    52

		town->population = 0;

    53

		town->num_houses = 0;

    54

	}

    55

    56

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

    57

		HouseID house_id;

    58

    59

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

    60

    61

		house_id = GetHouseType(t);

    62

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

    63

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

    64

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

    65

			house_id = _house_mngr.GetSubstituteID(house_id);

    66

			SetHouseType(t, house_id);

    67

		}

    68

    69

		town = GetTownByTile(t);

    70

		IncreaseBuildingCount(town, house_id);

    71

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

    72

    73

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

    74

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

    75

	}

    76

    77

	/* Update the population and num_house dependant values */

    78

	FOR_ALL_TOWNS(town) {

    79

		UpdateTownRadius(town);

    80

		UpdateTownMaxPass(town);

    81

	}

    82

}

    83

    84

HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid)

    85

{

    86

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

    87

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

    88

		HouseClassMapping *map = &_class_mapping[i];

    89

    90

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

    91

    92

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

    93

			map->class_id = grf_class_id;

    94

			map->grfid    = grfid;

    95

			return (HouseClassID)i;

    96

		}

    97

	}

    98

	return HOUSE_NO_CLASS;

    99

}

   100

   101

void InitializeBuildingCounts()

   102

{

   103

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

   104

}

   105

   106

/**

   107

 * IncreaseBuildingCount()

   108

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

   109

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

   110

 * @param house_id The id of the house being added

   111

 */

   112

void IncreaseBuildingCount(Town *t, HouseID house_id)

   113

{

   114

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   115

   116

	if (!_loaded_newgrf_features.has_newhouses) return;

   117

   118

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

   119

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

   120

	 * therefore on the map as well. */

   121

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

   122

   123

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

   124

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

   125

   126

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

   127

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

   128

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

   129

   130

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

   131

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

   132

}

   133

   134

/**

   135

 * DecreaseBuildingCount()

   136

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

   137

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

   138

 * @param house_id The id of the house being removed

   139

 */

   140

void DecreaseBuildingCount(Town *t, HouseID house_id)

   141

{

   142

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   143

   144

	if (!_loaded_newgrf_features.has_newhouses) return;

   145

   146

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

   147

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

   148

   149

	if (class_id == HOUSE_NO_CLASS) return;

   150

   151

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

   152

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

   153

}

   154

   155

static uint32 HouseGetRandomBits(const ResolverObject *object)

   156

{

   157

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

   158

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

   159

}

   160

   161

static uint32 HouseGetTriggers(const ResolverObject *object)

   162

{

   163

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

   164

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

   165

}

   166

   167

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

   168

{

   169

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

   170

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

   171

}

   172

   173

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

   174

{

   175

	uint8 map_id_count, town_id_count, map_class_count, town_class_count;

   176

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   177

   178

	map_id_count     = _building_counts.id_count[house_id];

   179

	map_class_count  = _building_counts.class_count[class_id];

   180

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

   181

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

   182

   183

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

   184

}

   185

   186

uint32 GetNearbyTileInformation(byte parameter, TileIndex tile)

   187

{

   188

	tile = GetNearbyTile(parameter, tile);

   189

	return GetNearbyTileInformation(tile);

   190

}

   191

   192

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

   193

typedef struct {

   194

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

   195

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

   196

} SearchNearbyHouseData;

   197

   198

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

   199

 * @param tile TileIndex to be examined

   200

 * @param user_data SearchNearbyHouseData

   201

 * @return true or false, if found or not

   202

 */

   203

static bool SearchNearbyHouseID(TileIndex tile, void *user_data)

   204

{

   205

	if (IsTileType(tile, MP_HOUSE)) {

   206

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

   207

		const HouseSpec *hs = GetHouseSpecs(house);

   208

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

   209

			SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;

   210

   211

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

   212

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

   213

   214

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

   215

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

   216

		}

   217

	}

   218

	return false;

   219

}

   220

   221

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

   222

 * @param tile TileIndex to be examined

   223

 * @param user_data SearchNearbyHouseData

   224

 * @return true or false, if found or not

   225

 */

   226

static bool SearchNearbyHouseClass(TileIndex tile, void *user_data)

   227

{

   228

	if (IsTileType(tile, MP_HOUSE)) {

   229

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

   230

		const HouseSpec *hs = GetHouseSpecs(house);

   231

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

   232

			SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;

   233

   234

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

   235

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

   236

   237

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

   238

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

   239

		}

   240

	}

   241

	return false;

   242

}

   243

   244

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

   245

 * @param tile TileIndex to be examined

   246

 * @param user_data SearchNearbyHouseData

   247

 * @return true or false, if found or not

   248

 */

   249

static bool SearchNearbyHouseGRFID(TileIndex tile, void *user_data)

   250

{

   251

	if (IsTileType(tile, MP_HOUSE)) {

   252

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

   253

		const HouseSpec *hs = GetHouseSpecs(house);

   254

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

   255

			SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;

   256

   257

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

   258

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

   259

   260

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

   261

		}

   262

	}

   263

	return false;

   264

}

   265

   266

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

   267

 * that fit the requested characteristics

   268

 * @param parameter that is given by the callback.

   269

 *                  bits 0..6 radius of the search

   270

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

   271

 * @param tile TileIndex from which to start the search

   272

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

   273

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

   274

 */

   275

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

   276

{

   277

	static TestTileOnSearchProc * const search_procs[3] = {

   278

		SearchNearbyHouseID,

   279

		SearchNearbyHouseClass,

   280

		SearchNearbyHouseGRFID,

   281

	};

   282

	TileIndex found_tile = tile;

   283

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

   284

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

   285

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

   286

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

   287

   288

	SearchNearbyHouseData nbhd;

   289

	nbhd.hs = GetHouseSpecs(house);

   290

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

   291

   292

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

   293

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

   294

		return DistanceManhattan(found_tile, tile);

   295

	}

   296

	return 0;

   297

}

   298

   299

/**

   300

 * HouseGetVariable():

   301

 *

   302

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

   303

 */

   304

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

   305

{

   306

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

   307

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

   308

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

   309

   310

	if (object->scope == VSG_SCOPE_PARENT) {

   311

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

   312

	}

   313

   314

	switch (variable) {

   315

		/* Construction stage. */

   316

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

   317

   318

		/* Building age. */

   319

		case 0x41: return GetHouseAge(tile);

   320

   321

		/* Town zone */

   322

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

   323

   324

		/* Terrain type */

   325

		case 0x43: return GetTerrainType(tile);

   326

   327

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

   328

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

   329

   330

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

   331

		case 0x45: return _generating_world ? 1 : 0;

   332

   333

		/* Current animation frame. */

   334

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

   335

   336

		/* Position of the house */

   337

		case 0x47: return TileY(tile) << 16 | TileX(tile);

   338

   339

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

   340

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

   341

   342

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

   343

		case 0x61: {

   344

			const HouseSpec *hs = GetHouseSpecs(house_id);

   345

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

   346

   347

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

   348

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

   349

		}

   350

   351

		/* Land info for nearby tiles. */

   352

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

   353

   354

		/* Current animation frame of nearby house tiles */

   355

		case 0x63: {

   356

			TileIndex testtile = GetNearbyTile(parameter, tile);

   357

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

   358

		}

   359

   360

		/* Cargo acceptance history of nearby stations */

   361

		/*case 0x64: not implemented yet */

   362

   363

		/* Distance test for some house types */

   364

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

   365

	}

   366

   367

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

   368

   369

	*available = false;

   370

	return UINT_MAX;

   371

}

   372

   373

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

   374

{

   375

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

   376

	return NULL;

   377

}

   378

   379

/**

   380

 * NewHouseResolver():

   381

 *

   382

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

   383

 */

   384

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

   385

{

   386

	res->GetRandomBits = HouseGetRandomBits;

   387

	res->GetTriggers   = HouseGetTriggers;

   388

	res->SetTriggers   = HouseSetTriggers;

   389

	res->GetVariable   = HouseGetVariable;

   390

	res->ResolveReal   = HouseResolveReal;

   391

   392

	res->u.house.tile     = tile;

   393

	res->u.house.town     = town;

   394

	res->u.house.house_id = house_id;

   395

   396

	res->callback        = CBID_NO_CALLBACK;

   397

	res->callback_param1 = 0;

   398

	res->callback_param2 = 0;

   399

	res->last_value      = 0;

   400

	res->trigger         = 0;

   401

	res->reseed          = 0;

   402

	res->count           = 0;

   403

   404

	const HouseSpec *hs = GetHouseSpecs(house_id);

   405

	res->grffile         = (hs != NULL ? hs->grffile : NULL);

   406

}

   407

   408

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

   409

{

   410

	ResolverObject object;

   411

	const SpriteGroup *group;

   412

   413

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

   414

	object.callback = callback;

   415

	object.callback_param1 = param1;

   416

	object.callback_param2 = param2;

   417

   418

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

   419

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

   420

   421

	return group->g.callback.result;

   422

}

   423

   424

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

   425

{

   426

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

   427

	const DrawTileSeqStruct *dtss;

   428

   429

	const HouseSpec *hs = GetHouseSpecs(house_id);

   430

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

   431

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

   432

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

   433

		if (callback != CALLBACK_FAILED) {

   434

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

   435

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

   436

		}

   437

	}

   438

   439

	SpriteID image = dts->ground.sprite;

   440

	SpriteID pal   = dts->ground.pal;

   441

   442

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

   443

   444

	if (GB(image, 0, SPRITE_WIDTH) != 0) {

   445

		DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));

   446

	}

   447

   448

	foreach_draw_tile_seq(dtss, dts->seq) {

   449

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

   450

   451

		image = dtss->image.sprite;

   452

		pal   = dtss->image.pal;

   453

   454

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

   455

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

   456

   457

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

   458

   459

		pal = SpriteLayoutPaletteTransform(image, pal, palette);

   460

   461

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

   462

			AddSortableSpriteToDraw(

   463

				image, pal,

   464

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

   465

				dtss->size_x, dtss->size_y,

   466

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

   467

				!HasBit(image, SPRITE_MODIFIER_OPAQUE) && IsTransparencySet(TO_HOUSES)

   468

			);

   469

		} else {

   470

			/* For industries and houses delta_x and delta_y are unsigned */

   471

			AddChildSpriteScreen(image, pal, (byte)dtss->delta_x, (byte)dtss->delta_y, !HasBit(image, SPRITE_MODIFIER_OPAQUE) && IsTransparencySet(TO_HOUSES));

   472

		}

   473

	}

   474

}

   475

   476

void DrawNewHouseTile(TileInfo *ti, HouseID house_id)

   477

{

   478

	const HouseSpec *hs = GetHouseSpecs(house_id);

   479

	const SpriteGroup *group;

   480

	ResolverObject object;

   481

   482

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

   483

   484

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

   485

   486

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

   487

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

   488

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

   489

		DrawGroundSprite(SPR_SHADOW_CELL, PAL_NONE);

   490

	} else {

   491

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

   492

		byte stage = GetHouseBuildingStage(ti->tile);

   493

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

   494

		DrawTileLayout(ti, group, stage, house_id);

   495

	}

   496

}

   497

   498

void AnimateNewHouseTile(TileIndex tile)

   499

{

   500

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

   501

	byte animation_speed = hs->animation_speed;

   502

	bool frame_set_by_callback = false;

   503

   504

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

   505

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

   506

		if (callback_res != CALLBACK_FAILED) animation_speed = Clamp(callback_res & 0xFF, 2, 16);

   507