1

/* $Id$ */

     2

     3

/** @file newgrf_house.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "variables.h"

     9

#include "debug.h"

    10

#include "viewport.h"

    11

#include "landscape.h"

    12

#include "date.h"

    13

#include "town.h"

    14

#include "town_map.h"

    15

#include "sound.h"

    16

#include "sprite.h"

    17

#include "strings.h"

    18

#include "table/strings.h"

    19

#include "table/sprites.h"

    20

#include "table/town_land.h"

    21

#include "newgrf.h"

    22

#include "newgrf_house.h"

    23

#include "newgrf_spritegroup.h"

    24

#include "newgrf_callbacks.h"

    25

#include "newgrf_town.h"

    26

#include "newgrf_sound.h"

    27

#include "newgrf_commons.h"

    28

#include "transparency.h"

    29

    30

static BuildingCounts    _building_counts;

    31

static HouseClassMapping _class_mapping[HOUSE_CLASS_MAX];

    32

    33

HouseOverrideManager _house_mngr(NEW_HOUSE_OFFSET, HOUSE_MAX, INVALID_HOUSE_ID);

    34

    35

void CheckHouseIDs()

    36

{

    37

	InitializeBuildingCounts();

    38

    39

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

    40

		HouseID house_id;

    41

    42

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

    43

    44

		house_id = GetHouseType(t);

    45

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

    46

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

    47

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

    48

			house_id = _house_mngr.GetSubstituteID(house_id);

    49

			SetHouseType(t, house_id);

    50

		}

    51

		IncreaseBuildingCount(GetTownByTile(t), house_id);

    52

	}

    53

}

    54

    55

HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid)

    56

{

    57

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

    58

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

    59

		HouseClassMapping *map = &_class_mapping[i];

    60

    61

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

    62

    63

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

    64

			map->class_id = grf_class_id;

    65

			map->grfid    = grfid;

    66

			return (HouseClassID)i;

    67

		}

    68

	}

    69

	return HOUSE_NO_CLASS;

    70

}

    71

    72

void InitializeBuildingCounts()

    73

{

    74

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

    75

}

    76

    77

/**

    78

 * IncreaseBuildingCount()

    79

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

    80

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

    81

 * @param house_id The id of the house being added

    82

 */

    83

void IncreaseBuildingCount(Town *t, HouseID house_id)

    84

{

    85

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

    86

    87

	if (!_loaded_newgrf_features.has_newhouses) return;

    88

    89

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

    90

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

    91

	 * therefore on the map as well. */

    92

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

    93

    94

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

    95

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

    96

    97

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

    98

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

    99

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

   100

   101

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

   102

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

   103

}

   104

   105

/**

   106

 * DecreaseBuildingCount()

   107

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

   108

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

   109

 * @param house_id The id of the house being removed

   110

 */

   111

void DecreaseBuildingCount(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 (t->building_counts.id_count[house_id] > 0) t->building_counts.id_count[house_id]--;

   118

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

   119

   120

	if (class_id == HOUSE_NO_CLASS) return;

   121

   122

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

   123

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

   124

}

   125

   126

/**

   127

 * AfterLoadCountBuildings()

   128

 *

   129

 * After a savegame has been loaded, count the number of buildings on the map.

   130

 */

   131

void AfterLoadCountBuildings()

   132

{

   133

	if (!_loaded_newgrf_features.has_newhouses) return;

   134

   135

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

   136

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

   137

		IncreaseBuildingCount(GetTownByTile(t), GetHouseType(t));

   138

	}

   139

}

   140

   141

   142

static uint32 HouseGetRandomBits(const ResolverObject *object)

   143

{

   144

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

   145

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

   146

}

   147

   148

static uint32 HouseGetTriggers(const ResolverObject *object)

   149

{

   150

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

   151

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

   152

}

   153

   154

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

   155

{

   156

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

   157

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

   158

}

   159

   160

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

   161

{

   162

	uint8 map_id_count, town_id_count, map_class_count, town_class_count;

   163

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   164

   165

	map_id_count     = _building_counts.id_count[house_id];

   166

	map_class_count  = _building_counts.class_count[class_id];

   167

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

   168

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

   169

   170

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

   171

}

   172

   173

static uint32 GetGRFParameter(HouseID house_id, byte parameter)

   174

{

   175

	const HouseSpec *hs = GetHouseSpecs(house_id);

   176

	const GRFFile *file = hs->grffile;

   177

   178

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

   179

	return file->param[parameter];

   180

}

   181

   182

uint32 GetNearbyTileInformation(byte parameter, TileIndex tile)

   183

{

   184

	uint32 tile_type;

   185

   186

	tile = GetNearbyTile(parameter, tile);

   187

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

   188

   189

	uint z;

   190

	Slope tileh = GetTileSlope(tile, &z);

   191

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

   192

}

   193

   194

/**

   195

 * HouseGetVariable():

   196

 *

   197

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

   198

 */

   199

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

   200

{

   201

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

   202

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

   203

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

   204

   205

	if (object->scope == VSG_SCOPE_PARENT) {

   206

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

   207

	}

   208

   209

	switch (variable) {

   210

		/* Construction stage. */

   211

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

   212

   213

		/* Building age. */

   214

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

   215

   216

		/* Town zone */

   217

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

   218

   219

		/* Terrain type */

   220

		case 0x43: return GetTerrainType(tile);

   221

   222

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

   223

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

   224

   225

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

   226

		case 0x45: return _generating_world ? 1 : 0;

   227

   228

		/* Current animation frame. */

   229

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

   230

   231

   232

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

   233

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

   234

   235

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

   236

		case 0x61: {

   237

			const HouseSpec *hs = GetHouseSpecs(house_id);

   238

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

   239

   240

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

   241

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

   242

		}

   243

   244

		/* Land info for nearby tiles. */

   245

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

   246

   247

		/* Read GRF parameter */

   248

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

   249

	}

   250

   251

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

   252

   253

	*available = false;

   254

	return UINT_MAX;

   255

}

   256

   257

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

   258

{

   259

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

   260

	return NULL;

   261

}

   262

   263

/**

   264

 * NewHouseResolver():

   265

 *

   266

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

   267

 */

   268

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

   269

{

   270

	res->GetRandomBits = HouseGetRandomBits;

   271

	res->GetTriggers   = HouseGetTriggers;

   272

	res->SetTriggers   = HouseSetTriggers;

   273

	res->GetVariable   = HouseGetVariable;

   274

	res->ResolveReal   = HouseResolveReal;

   275

   276

	res->u.house.tile     = tile;

   277

	res->u.house.town     = town;

   278

	res->u.house.house_id = house_id;

   279

   280

	res->callback        = CBID_NO_CALLBACK;

   281

	res->callback_param1 = 0;

   282

	res->callback_param2 = 0;

   283

	res->last_value      = 0;

   284

	res->trigger         = 0;

   285

	res->reseed          = 0;

   286

}

   287

   288

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

   289

{

   290

	ResolverObject object;

   291

	const SpriteGroup *group;

   292

   293

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

   294

	object.callback = callback;

   295

	object.callback_param1 = param1;

   296

	object.callback_param2 = param2;

   297

   298

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

   299

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

   300

   301

	return group->g.callback.result;

   302

}

   303

   304

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

   305

{

   306

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

   307

	const DrawTileSeqStruct *dtss;

   308

   309

	SpriteID image = dts->ground_sprite;

   310

	SpriteID pal   = dts->ground_pal;

   311

   312

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

   313

   314

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

   315

   316

	foreach_draw_tile_seq(dtss, dts->seq) {

   317

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

   318

   319

		image = dtss->image;

   320

		pal   = dtss->pal;

   321

   322

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

   323

   324

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

   325

			if (pal == 0) {

   326

				const HouseSpec *hs = GetHouseSpecs(house_id);

   327

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

   328

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

   329

					if (callback != CALLBACK_FAILED) {

   330

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

   331

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

   332

					}

   333

				} else {

   334

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

   335

				}

   336

			}

   337

		} else {

   338

			pal = PAL_NONE;

   339

		}

   340

   341

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

   342

			AddSortableSpriteToDraw(

   343

				image, pal,

   344

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

   345

				dtss->size_x, dtss->size_y,

   346

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

   347

				IsTransparencySet(TO_HOUSES)

   348

			);

   349

		} else {

   350

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

   351

		}

   352

	}

   353

}

   354

   355

void DrawNewHouseTile(TileInfo *ti, HouseID house_id)

   356

{

   357

	const HouseSpec *hs = GetHouseSpecs(house_id);

   358

	const SpriteGroup *group;

   359

	ResolverObject object;

   360

   361

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

   362

   363

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

   364

   365

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

   366

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

   367

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

   368

		DrawGroundSprite(SPR_SHADOW_CELL, PAL_NONE);

   369

	} else {

   370

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

   371

		byte stage = GetHouseBuildingStage(ti->tile);

   372

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

   373

		DrawTileLayout(ti, group, stage, house_id);

   374

	}

   375

}

   376

   377

void AnimateNewHouseTile(TileIndex tile)

   378

{

   379

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

   380

	byte animation_speed = hs->animation_speed;

   381

	bool frame_set_by_callback = false;

   382

   383

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

   384

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

   385

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

   386

	}

   387

   388

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

   389

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

   390

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

   391

	 * maximum, corresponding to around 33 minutes. */

   392

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

   393

   394

	byte frame      = GetHouseAnimationFrame(tile);

   395

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

   396

   397

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

   398

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

   399

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

   400

   401

		if (callback_res != CALLBACK_FAILED) {

   402

			frame_set_by_callback = true;

   403

   404

			switch (callback_res & 0xFF) {

   405

				case 0xFF:

   406

					DeleteAnimatedTile(tile);

   407

					break;

   408

				case 0xFE:

   409

					/* Carry on as normal. */

   410

					frame_set_by_callback = false;

   411

					break;

   412

				default:

   413

					frame = callback_res & 0xFF;

   414

					break;

   415

			}

   416

   417

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

   418

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

   419

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

   420

		}

   421

	}

   422

   423

	if (!frame_set_by_callback) {

   424

		if (frame < num_frames) {

   425

			frame++;

   426

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

   427

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

   428

			frame = 0;

   429

		} else {

   430

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

   431

			DeleteAnimatedTile(tile);

   432

		}

   433

	}

   434

   435

	SetHouseAnimationFrame(tile, frame);

   436

	MarkTileDirtyByTile(tile);

   437

}

   438

   439

void ChangeHouseAnimationFrame(TileIndex tile, uint16 callback_result)

   440

{

   441

	switch (callback_result & 0xFF) {

   442

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

   443

		case 0xFE: AddAnimatedTile(tile);    break;

   444

		case 0xFF: DeleteAnimatedTile(tile); break;

   445

		default:

   446

			SetHouseAnimationFrame(tile, callback_result & 0xFF);

   447

			AddAnimatedTile(tile);

   448

			break;

   449

	}

   450

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

   451

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

   452

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

   453

}

   454

   455

bool CanDeleteHouse(TileIndex tile)

   456

{

   457

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

   458

   459

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

   460

	 * anyone using the scenario editor. */

   461

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

   462

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

   463

   464

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

   465

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

   466

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

   467

	} else {

   468

		return !(hs->extra_flags & BUILDING_IS_PROTECTED);

   469

	}

   470

}

   471

   472

static void AnimationControl(TileIndex tile, uint16 random_bits)

   473

{

   474

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

   475

   476

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

   477

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

   478

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

   479

   480

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

   481

	}

   482

}

   483

   484

bool NewHouseTileLoop(TileIndex tile)

   485

{

   486

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

   487

   488

	if (GetHouseProcessingTime(tile) > 0) {

   489

		DecHouseProcessingTime(tile);

   490

		return true;

   491

	}

   492

   493

	TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP);

   494

	TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP_TOP);

   495

   496

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

   497

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

   498

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

   499

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

   500

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

   501

		if (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) {

   502

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

   503

   504

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

   505

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

   506

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

   507

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

   508

		} else {

   509

			AnimationControl(tile, 0);

   510

		}

   511

	}

   512

   513

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

   514

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

   515

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

   516

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

   517

			ClearTownHouse(GetTownByTile(tile), tile);

   518

			return false;

   519

		}

   520

	}

   521

   522