1

/* $Id$ */

     2

     3

/** @file newgrf_house.cpp */

     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

    25

#include "table/strings.h"

    26

#include "table/sprites.h"

    27

#include "table/town_land.h"

    28

    29

static BuildingCounts    _building_counts;

    30

static HouseClassMapping _class_mapping[HOUSE_CLASS_MAX];

    31

    32

HouseOverrideManager _house_mngr(NEW_HOUSE_OFFSET, HOUSE_MAX, INVALID_HOUSE_ID);

    33

    34

void CheckHouseIDs()

    35

{

    36

	Town *town;

    37

	InitializeBuildingCounts();

    38

    39

	/* Reset town population */

    40

	FOR_ALL_TOWNS(town) town->population = 0;

    41

    42

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

    43

		HouseID house_id;

    44

    45

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

    46

    47

		house_id = GetHouseType(t);

    48

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

    49

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

    50

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

    51

			house_id = _house_mngr.GetSubstituteID(house_id);

    52

			SetHouseType(t, house_id);

    53

		}

    54

		town = GetTownByTile(t);

    55

		IncreaseBuildingCount(town, house_id);

    56

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

    57

	}

    58

}

    59

    60

HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid)

    61

{

    62

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

    63

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

    64

		HouseClassMapping *map = &_class_mapping[i];

    65

    66

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

    67

    68

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

    69

			map->class_id = grf_class_id;

    70

			map->grfid    = grfid;

    71

			return (HouseClassID)i;

    72

		}

    73

	}

    74

	return HOUSE_NO_CLASS;

    75

}

    76

    77

void InitializeBuildingCounts()

    78

{

    79

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

    80

}

    81

    82

/**

    83

 * IncreaseBuildingCount()

    84

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

    85

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

    86

 * @param house_id The id of the house being added

    87

 */

    88

void IncreaseBuildingCount(Town *t, HouseID house_id)

    89

{

    90

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

    91

    92

	if (!_loaded_newgrf_features.has_newhouses) return;

    93

    94

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

    95

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

    96

	 * therefore on the map as well. */

    97

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

    98

    99

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

   100

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

   101

   102

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

   103

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

   104

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

   105

   106

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

   107

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

   108

}

   109

   110

/**

   111

 * DecreaseBuildingCount()

   112

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

   113

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

   114

 * @param house_id The id of the house being removed

   115

 */

   116

void DecreaseBuildingCount(Town *t, HouseID house_id)

   117

{

   118

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   119

   120

	if (!_loaded_newgrf_features.has_newhouses) return;

   121

   122

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

   123

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

   124

   125

	if (class_id == HOUSE_NO_CLASS) return;

   126

   127

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

   128

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

   129

}

   130

   131

static uint32 HouseGetRandomBits(const ResolverObject *object)

   132

{

   133

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

   134

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

   135

}

   136

   137

static uint32 HouseGetTriggers(const ResolverObject *object)

   138

{

   139

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

   140

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

   141

}

   142

   143

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

   144

{

   145

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

   146

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

   147

}

   148

   149

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

   150

{

   151

	uint8 map_id_count, town_id_count, map_class_count, town_class_count;

   152

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   153

   154

	map_id_count     = _building_counts.id_count[house_id];

   155

	map_class_count  = _building_counts.class_count[class_id];

   156

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

   157

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

   158

   159

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

   160

}

   161

   162

static uint32 GetGRFParameter(HouseID house_id, byte parameter)

   163

{

   164

	const HouseSpec *hs = GetHouseSpecs(house_id);

   165

	const GRFFile *file = hs->grffile;

   166

   167

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

   168

	return file->param[parameter];

   169

}

   170

   171

uint32 GetNearbyTileInformation(byte parameter, TileIndex tile)

   172

{

   173

	uint32 tile_type;

   174

   175

	tile = GetNearbyTile(parameter, tile);

   176

	tile_type = GetTerrainType(tile) << 2 | (IsTileType(tile, MP_WATER) ? 1 : 0) << 1;

   177

   178

	uint z;

   179

	Slope tileh = GetTileSlope(tile, &z);

   180

	return GetTileType(tile) << 24 | z << 16 | tile_type << 8 | tileh;

   181

}

   182

   183

/**

   184

 * HouseGetVariable():

   185

 *

   186

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

   187

 */

   188

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

   189

{

   190

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

   191

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

   192

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

   193

   194

	if (object->scope == VSG_SCOPE_PARENT) {

   195

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

   196

	}

   197

   198

	switch (variable) {

   199

		/* Construction stage. */

   200

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

   201

   202

		/* Building age. */

   203

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

   204

   205

		/* Town zone */

   206

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

   207

   208

		/* Terrain type */

   209

		case 0x43: return GetTerrainType(tile);

   210

   211

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

   212

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

   213

   214

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

   215

		case 0x45: return _generating_world ? 1 : 0;

   216

   217

		/* Current animation frame. */

   218

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

   219

   220

   221

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

   222

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

   223

   224

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

   225

		case 0x61: {

   226

			const HouseSpec *hs = GetHouseSpecs(house_id);

   227

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

   228

   229

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

   230

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

   231

		}

   232

   233

		/* Land info for nearby tiles. */

   234

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

   235

   236

		/* Read GRF parameter */

   237

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

   238

	}

   239

   240

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

   241

   242

	*available = false;

   243

	return UINT_MAX;

   244

}

   245

   246

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

   247

{

   248

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

   249

	return NULL;

   250

}

   251

   252

/**

   253

 * NewHouseResolver():

   254

 *

   255

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

   256

 */

   257

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

   258

{

   259

	res->GetRandomBits = HouseGetRandomBits;

   260

	res->GetTriggers   = HouseGetTriggers;

   261

	res->SetTriggers   = HouseSetTriggers;

   262

	res->GetVariable   = HouseGetVariable;

   263

	res->ResolveReal   = HouseResolveReal;

   264

   265

	res->u.house.tile     = tile;

   266

	res->u.house.town     = town;

   267

	res->u.house.house_id = house_id;

   268

   269

	res->callback        = CBID_NO_CALLBACK;

   270

	res->callback_param1 = 0;

   271

	res->callback_param2 = 0;

   272

	res->last_value      = 0;

   273

	res->trigger         = 0;

   274

	res->reseed          = 0;

   275

}

   276

   277

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

   278

{

   279

	ResolverObject object;

   280

	const SpriteGroup *group;

   281

   282

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

   283

	object.callback = callback;

   284

	object.callback_param1 = param1;

   285

	object.callback_param2 = param2;

   286

   287

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

   288

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

   289

   290

	return group->g.callback.result;

   291

}

   292

   293

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

   294

{

   295

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

   296

	const DrawTileSeqStruct *dtss;

   297

   298

	SpriteID image = dts->ground_sprite;

   299

	SpriteID pal   = dts->ground_pal;

   300

   301

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

   302

   303

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

   304

   305

	foreach_draw_tile_seq(dtss, dts->seq) {

   306

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

   307

   308

		image = dtss->image;

   309

		pal   = dtss->pal;

   310

   311

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

   312

   313

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

   314

			if (pal == 0) {

   315

				const HouseSpec *hs = GetHouseSpecs(house_id);

   316

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

   317

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

   318

					if (callback != CALLBACK_FAILED) {

   319

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

   320

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

   321

					}

   322

				} else {

   323

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

   324

				}

   325

			}

   326

		} else {

   327

			pal = PAL_NONE;

   328

		}

   329

   330

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

   331

			AddSortableSpriteToDraw(

   332

				image, pal,

   333

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

   334

				dtss->size_x, dtss->size_y,

   335

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

   336

				IsTransparencySet(TO_HOUSES)

   337

			);

   338

		} else {

   339

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

   340

		}

   341

	}

   342

}

   343

   344

void DrawNewHouseTile(TileInfo *ti, HouseID house_id)

   345

{

   346

	const HouseSpec *hs = GetHouseSpecs(house_id);

   347

	const SpriteGroup *group;

   348

	ResolverObject object;

   349

   350

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

   351

   352

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

   353

   354

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

   355

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

   356

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

   357

		DrawGroundSprite(SPR_SHADOW_CELL, PAL_NONE);

   358

	} else {

   359

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

   360

		byte stage = GetHouseBuildingStage(ti->tile);

   361

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

   362

		DrawTileLayout(ti, group, stage, house_id);

   363

	}

   364

}

   365

   366

void AnimateNewHouseTile(TileIndex tile)

   367

{

   368

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

   369

	byte animation_speed = hs->animation_speed;

   370

	bool frame_set_by_callback = false;

   371

   372

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

   373

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

   374

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

   375

	}

   376

   377

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

   378

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

   379

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

   380

	 * maximum, corresponding to around 33 minutes. */

   381

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

   382

   383

	byte frame      = GetHouseAnimationFrame(tile);

   384

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

   385

   386

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

   387

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

   388

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

   389

   390

		if (callback_res != CALLBACK_FAILED) {

   391

			frame_set_by_callback = true;

   392

   393

			switch (callback_res & 0xFF) {

   394

				case 0xFF:

   395

					DeleteAnimatedTile(tile);

   396

					break;

   397

				case 0xFE:

   398

					/* Carry on as normal. */

   399

					frame_set_by_callback = false;

   400

					break;

   401

				default:

   402

					frame = callback_res & 0xFF;

   403

					break;

   404

			}

   405

   406

			/* If the lower 7 bits of the upper byte of the callback

   407

			 * result are not empty, it is a sound effect. */

   408

			if (GB(callback_res, 8, 7) != 0) PlayHouseSound(GB(callback_res, 8, 7), tile);

   409

		}

   410

	}

   411

   412

	if (!frame_set_by_callback) {

   413

		if (frame < num_frames) {

   414

			frame++;

   415

		} else if (frame == num_frames && HasBit(hs->animation_frames, 7)) {

   416

			/* This animation loops, so start again from the beginning */

   417

			frame = 0;

   418

		} else {

   419

			/* This animation doesn't loop, so stay here */

   420

			DeleteAnimatedTile(tile);

   421

		}

   422

	}

   423

   424

	SetHouseAnimationFrame(tile, frame);

   425

	MarkTileDirtyByTile(tile);

   426

}

   427

   428

void ChangeHouseAnimationFrame(TileIndex tile, uint16 callback_result)

   429

{

   430

	switch (callback_result & 0xFF) {

   431

		case 0xFD: /* Do nothing. */         break;

   432

		case 0xFE: AddAnimatedTile(tile);    break;

   433

		case 0xFF: DeleteAnimatedTile(tile); break;

   434

		default:

   435

			SetHouseAnimationFrame(tile, callback_result & 0xFF);

   436

			AddAnimatedTile(tile);

   437

			break;

   438

	}

   439

	/* If the lower 7 bits of the upper byte of the callback

   440

	 * result are not empty, it is a sound effect. */

   441

	if (GB(callback_result, 8, 7) != 0) PlayHouseSound(GB(callback_result, 8, 7), tile);

   442

}

   443

   444

bool CanDeleteHouse(TileIndex tile)

   445

{

   446

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

   447

   448

	/* Human players are always allowed to remove buildings, as is water and

   449

	 * anyone using the scenario editor. */

   450

	if ((IsValidPlayer(_current_player) && IsHumanPlayer(_current_player))

   451

			|| _current_player == OWNER_WATER || _current_player == OWNER_NONE) return true;

   452

   453

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

   454

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

   455

		return (callback_res == CALLBACK_FAILED || callback_res == 0);

   456

	} else {

   457

		return !(hs->extra_flags & BUILDING_IS_PROTECTED);

   458

	}

   459

}

   460

   461

static void AnimationControl(TileIndex tile, uint16 random_bits)

   462

{

   463

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

   464

   465

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

   466

		uint32 param = (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) ? (GB(Random(), 0, 16) | random_bits << 16) : Random();

   467

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

   468

   469

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

   470

	}

   471

}

   472

   473

bool NewHouseTileLoop(TileIndex tile)

   474

{

   475

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

   476

   477

	if (GetHouseProcessingTime(tile) > 0) {

   478

		DecHouseProcessingTime(tile);

   479

		return true;

   480

	}

   481

   482

	TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP);

   483

	TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP_TOP);

   484

   485

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

   486

		/* If this house is marked as having a synchronised callback, all the

   487

		 * tiles will have the callback called at once, rather than when the

   488

		 * tile loop reaches them. This should only be enabled for the northern

   489

		 * tile, or strange things will happen (here, and in TTDPatch). */

   490

		if (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) {

   491

			uint16 random = GB(Random(), 0, 16);

   492

   493

			if (hs->building_flags & BUILDING_HAS_1_TILE)  AnimationControl(tile, random);

   494

			if (hs->building_flags & BUILDING_2_TILES_Y)   AnimationControl(TILE_ADDXY(tile, 0, 1), random);

   495

			if (hs->building_flags & BUILDING_2_TILES_X)   AnimationControl(TILE_ADDXY(tile, 1, 0), random);

   496

			if (hs->building_flags & BUILDING_HAS_4_TILES) AnimationControl(TILE_ADDXY(tile, 1, 1), random);

   497

		} else {

   498

			AnimationControl(tile, 0);

   499

		}

   500

	}

   501

   502

	/* Check callback 21, which determines if a house should be destroyed. */

   503

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

   504

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

   505

		if (callback_res != CALLBACK_FAILED && callback_res > 0) {

   506

			ClearTownHouse(GetTownByTile(tile), tile);

   507

			return false;

   508

		}

   509

	}

   510

   511

	SetHouseProcessingTime(tile, hs->processing_time);

   512

	return true;

   513

}

   514

   515

static void DoTriggerHouse(TileIndex tile, HouseTrigger trigger, byte base_random, bool first)

   516

{

   517

	ResolverObject object;

   518

   519