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 tile which

    73

		 * has a size bit set. Multi tile buildings have got only

    74

		 * one tile with such a bit set, so there is no problem. */

    75

		if (GetHouseSpecs(GetHouseType(t))->building_flags & BUILDING_HAS_1_TILE) {

    76

			town->num_houses++;

    77

		}

    78

	}

    79

    80

	/* Update the population and num_house dependant values */

    81

	FOR_ALL_TOWNS(town) {

    82

		UpdateTownRadius(town);

    83

		UpdateTownMaxPass(town);

    84

	}

    85

}

    86

    87

HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid)

    88

{

    89

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

    90

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

    91

		HouseClassMapping *map = &_class_mapping[i];

    92

    93

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

    94

    95

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

    96

			map->class_id = grf_class_id;

    97

			map->grfid    = grfid;

    98

			return (HouseClassID)i;

    99

		}

   100

	}

   101

	return HOUSE_NO_CLASS;

   102

}

   103

   104

void InitializeBuildingCounts()

   105

{

   106

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

   107

}

   108

   109

/**

   110

 * IncreaseBuildingCount()

   111

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

   112

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

   113

 * @param house_id The id of the house being added

   114

 */

   115

void IncreaseBuildingCount(Town *t, HouseID house_id)

   116

{

   117

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   118

   119

	if (!_loaded_newgrf_features.has_newhouses) return;

   120

   121

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

   122

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

   123

	 * therefore on the map as well. */

   124

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

   125

   126

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

   127

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

   128

   129

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

   130

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

   131

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

   132

   133

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

   134

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

   135

}

   136

   137

/**

   138

 * DecreaseBuildingCount()

   139

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

   140

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

   141

 * @param house_id The id of the house being removed

   142

 */

   143

void DecreaseBuildingCount(Town *t, HouseID house_id)

   144

{

   145

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   146

   147

	if (!_loaded_newgrf_features.has_newhouses) return;

   148

   149

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

   150

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

   151

   152

	if (class_id == HOUSE_NO_CLASS) return;

   153

   154

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

   155

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

   156

}

   157

   158

static uint32 HouseGetRandomBits(const ResolverObject *object)

   159

{

   160

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

   161

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

   162

}

   163

   164

static uint32 HouseGetTriggers(const ResolverObject *object)

   165

{

   166

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

   167

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

   168

}

   169

   170

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

   171

{

   172

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

   173

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

   174

}

   175

   176

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

   177

{

   178

	uint8 map_id_count, town_id_count, map_class_count, town_class_count;

   179

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   180

   181

	map_id_count     = _building_counts.id_count[house_id];

   182

	map_class_count  = _building_counts.class_count[class_id];

   183

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

   184

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

   185

   186

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

   187

}

   188

   189

static uint32 GetGRFParameter(HouseID house_id, byte parameter)

   190

{

   191

	const HouseSpec *hs = GetHouseSpecs(house_id);

   192

	const GRFFile *file = hs->grffile;

   193

   194

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

   195

	return file->param[parameter];

   196

}

   197

   198

uint32 GetNearbyTileInformation(byte parameter, TileIndex tile)

   199

{

   200

	tile = GetNearbyTile(parameter, tile);

   201

	return GetNearbyTileInformation(tile);

   202

}

   203

   204

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

   205

 * @param tile TileIndex to be examined

   206

 * @param data house id, in order to get the specs

   207

 * @return true or false, if found or not

   208

 */

   209

static bool SearchNearbyHouseID(TileIndex tile, uint32 data)

   210

{

   211

	if (IsTileType(tile, MP_HOUSE)) {

   212

		const HouseSpec *hs = GetHouseSpecs(GetHouseType(tile)); // tile been examined

   213

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

   214

			const HouseSpec *test_hs = GetHouseSpecs((HouseID)GB(data, 0, 16));

   215

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

   216

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

   217

		}

   218

	}

   219

	return false;

   220

}

   221

   222

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

   223

 * @param tile TileIndex to be examined

   224

 * @param data house id, in order to get the specs

   225

 * @return true or false, if found or not

   226

 */

   227

static bool SearchNearbyHouseClass(TileIndex tile, uint32 data)

   228

{

   229

	if (IsTileType(tile, MP_HOUSE)) {

   230

		const HouseSpec *hs = GetHouseSpecs(GetHouseType(tile)); // tile been examined

   231

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

   232

			const HouseSpec *test_hs = GetHouseSpecs((HouseID)GB(data, 0, 16));

   233

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

   234

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

   235

		}

   236

	}

   237

	return false;

   238

}

   239

   240

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

   241

 * @param tile TileIndex to be examined

   242

 * @param data house id, in order to get the specs

   243

 * @return true or false, if found or not

   244

 */

   245

static bool SearchNearbyHouseGRFID(TileIndex tile, uint32 data)

   246

{

   247

	if (IsTileType(tile, MP_HOUSE)) {

   248

		const HouseSpec *hs = GetHouseSpecs(GetHouseType(tile)); // tile been examined

   249

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

   250

			const HouseSpec *test_hs = GetHouseSpecs((HouseID)GB(data, 0, 16));

   251

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

   252

		}

   253

	}

   254

	return false;

   255

}

   256

   257

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

   258

 * that fit the requested characteristics

   259

 * @param parameter that is given by the callback.

   260

 *                  bits 0..6 radius of the search

   261

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

   262

 * @param tile TileIndex from which to start the search

   263

 * @param data the HouseID that is associated to the house work who started the callback

   264

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

   265

  */

   266

static uint32 GetDistanceFromNearbyHouse(uint8 parameter, TileIndex tile, uint32 data)

   267

{

   268

	static TestTileOnSearchProc * const search_procs[3] = {

   269

		SearchNearbyHouseID,

   270

		SearchNearbyHouseClass,

   271

		SearchNearbyHouseGRFID,

   272

	};

   273

	TileIndex found_tile = tile;

   274

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

   275

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

   276

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

   277

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

   278

   279

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

   280

	if (CircularTileSearch(&found_tile, searchradius, search_procs[searchtype], data)) {

   281

		return DistanceManhattan(found_tile, tile);

   282

	}

   283

	return 0;

   284

}

   285

   286

/**

   287

 * HouseGetVariable():

   288

 *

   289

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

   290

 */

   291

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

   292

{

   293

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

   294

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

   295

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

   296

   297

	if (object->scope == VSG_SCOPE_PARENT) {

   298

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

   299

	}

   300

   301

	switch (variable) {

   302

		/* Construction stage. */

   303

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

   304

   305

		/* Building age. */

   306

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

   307

   308

		/* Town zone */

   309

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

   310

   311

		/* Terrain type */

   312

		case 0x43: return GetTerrainType(tile);

   313

   314

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

   315

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

   316

   317

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

   318

		case 0x45: return _generating_world ? 1 : 0;

   319

   320

		/* Current animation frame. */

   321

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

   322

   323

   324

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

   325

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

   326

   327

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

   328

		case 0x61: {

   329

			const HouseSpec *hs = GetHouseSpecs(house_id);

   330

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

   331

   332

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

   333

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

   334

		}

   335

   336

		/* Land info for nearby tiles. */

   337

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

   338

   339

		/* Current animation frame of nearby house tiles */

   340

		case 0x63: {

   341

			TileIndex testtile = GetNearbyTile(parameter, tile);

   342

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

   343

		}

   344

   345

		/* Cargo acceptance history of nearby stations */

   346

		/*case 0x64: not implemented yet */

   347

   348

		/* Distance test for some house types */

   349

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

   350

   351

		/* Read GRF parameter */

   352

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

   353

	}

   354

   355

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

   356

   357

	*available = false;

   358

	return UINT_MAX;

   359

}

   360

   361

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

   362

{

   363

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

   364

	return NULL;

   365

}

   366

   367

/**

   368

 * NewHouseResolver():

   369

 *

   370

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

   371

 */

   372

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

   373

{

   374

	res->GetRandomBits = HouseGetRandomBits;

   375

	res->GetTriggers   = HouseGetTriggers;

   376

	res->SetTriggers   = HouseSetTriggers;

   377

	res->GetVariable   = HouseGetVariable;

   378

	res->ResolveReal   = HouseResolveReal;

   379

   380

	res->u.house.tile     = tile;

   381

	res->u.house.town     = town;

   382

	res->u.house.house_id = house_id;

   383

   384

	res->callback        = CBID_NO_CALLBACK;

   385

	res->callback_param1 = 0;

   386

	res->callback_param2 = 0;

   387

	res->last_value      = 0;

   388

	res->trigger         = 0;

   389

	res->reseed          = 0;

   390

	res->count           = 0;

   391

}

   392

   393

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

   394

{

   395

	ResolverObject object;

   396

	const SpriteGroup *group;

   397

   398

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

   399

	object.callback = callback;

   400

	object.callback_param1 = param1;

   401

	object.callback_param2 = param2;

   402

   403

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

   404

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

   405

   406

	return group->g.callback.result;

   407

}

   408

   409

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

   410

{

   411

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

   412

	const DrawTileSeqStruct *dtss;

   413

   414

	SpriteID image = dts->ground.sprite;

   415

	SpriteID pal   = dts->ground.pal;

   416

   417

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

   418

   419

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

   420

   421

	foreach_draw_tile_seq(dtss, dts->seq) {

   422

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

   423

   424

		image = dtss->image.sprite;

   425

		pal   = dtss->image.pal;

   426

   427

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

   428

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

   429

   430

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

   431

   432

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

   433

			if (pal == 0) {

   434

				const HouseSpec *hs = GetHouseSpecs(house_id);

   435

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

   436

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

   437

					if (callback != CALLBACK_FAILED) {

   438

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

   439

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

   440

					}

   441

				} else {

   442

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

   443

				}

   444

			}

   445

		} else {

   446

			pal = PAL_NONE;

   447

		}

   448

   449

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

   450

			AddSortableSpriteToDraw(

   451

				image, pal,

   452

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

   453

				dtss->size_x, dtss->size_y,

   454

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

   455

				IsTransparencySet(TO_HOUSES)

   456

			);

   457

		} else {

   458

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

   459

		}

   460

	}

   461

}

   462

   463

void DrawNewHouseTile(TileInfo *ti, HouseID house_id)

   464

{

   465

	const HouseSpec *hs = GetHouseSpecs(house_id);

   466

	const SpriteGroup *group;

   467

	ResolverObject object;

   468

   469

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

   470

   471

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

   472

   473

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

   474

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

   475

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

   476

		DrawGroundSprite(SPR_SHADOW_CELL, PAL_NONE);

   477

	} else {

   478

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

   479

		byte stage = GetHouseBuildingStage(ti->tile);

   480

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

   481

		DrawTileLayout(ti, group, stage, house_id);

   482

	}

   483

}

   484

   485

void AnimateNewHouseTile(TileIndex tile)

   486

{

   487

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

   488

	byte animation_speed = hs->animation_speed;

   489

	bool frame_set_by_callback = false;

   490

   491

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

   492

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

   493

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

   494

	}

   495

   496

	/* An animation speed of 2 means the animation frame changes 4 ticks, and

   497

	 * increasing this value by one doubles the wait. 2 is the minimum value

   498

	 * allowed for animation_speed, which corresponds to 120ms, and 16 is the

   499

	 * maximum, corresponding to around 33 minutes. */

   500

	if (_tick_counter % (1 << animation_speed) != 0) return;

   501

   502

	byte frame      = GetHouseAnimationFrame(tile);

   503

	byte num_frames = GB(hs->animation_frames, 0, 7);

   504

   505

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

   506

		uint32 param = (hs->extra_flags & CALLBACK_1A_RANDOM_BITS) ? Random() : 0;

   507

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

   508

   509

		if (callback_res != CALLBACK_FAILED) {

   510

			frame_set_by_callback = true;

   511