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

    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

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

    37

		HouseID house_id;

    38

    39

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

    40

    41

		house_id = GetHouseType(t);

    42

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

    43

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

    44

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

    45

			SetHouseType(t, _house_mngr.GetSubstituteID(house_id));

    46

		}

    47

	}

    48

    49

	InitializeBuildingCounts();

    50

	AfterLoadCountBuildings();

    51

    52

}

    53

    54

HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid)

    55

{

    56

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

    57

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

    58

		HouseClassMapping *map = &_class_mapping[i];

    59

    60

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

    61

    62

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

    63

			map->class_id = grf_class_id;

    64

			map->grfid    = grfid;

    65

			return (HouseClassID)i;

    66

		}

    67

	}

    68

	return HOUSE_NO_CLASS;

    69

}

    70

    71

void InitializeBuildingCounts()

    72

{

    73

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

    74

}

    75

    76

/**

    77

 * IncreaseBuildingCount()

    78

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

    79

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

    80

 * @param house_id The id of the house being added

    81

 */

    82

void IncreaseBuildingCount(Town *t, HouseID house_id)

    83

{

    84

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

    85

    86

	if (!HASBIT(_loaded_newgrf_features, GRFLOADED_NEWHOUSES)) return;

    87

    88

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

    89

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

    90

	 * therefore on the map as well. */

    91

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

    92

    93

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

    94

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

    95

    96

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

    97

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

    98

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

    99

   100

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

   101

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

   102

}

   103

   104

/**

   105

 * DecreaseBuildingCount()

   106

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

   107

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

   108

 * @param house_id The id of the house being removed

   109

 */

   110

void DecreaseBuildingCount(Town *t, HouseID house_id)

   111

{

   112

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   113

   114

	if (!HASBIT(_loaded_newgrf_features, GRFLOADED_NEWHOUSES)) return;

   115

   116

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

   117

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

   118

   119

	if (class_id == HOUSE_NO_CLASS) return;

   120

   121

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

   122

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

   123

}

   124

   125

/**

   126

 * AfterLoadCountBuildings()

   127

 *

   128

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

   129

 */

   130

void AfterLoadCountBuildings()

   131

{

   132

	if (!HASBIT(_loaded_newgrf_features, GRFLOADED_NEWHOUSES)) return;

   133

   134

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

   135

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

   136

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

   137

	}

   138

}

   139

   140

   141

static uint32 HouseGetRandomBits(const ResolverObject *object)

   142

{

   143

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

   144

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

   145

}

   146

   147

static uint32 HouseGetTriggers(const ResolverObject *object)

   148

{

   149

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

   150

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

   151

}

   152

   153

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

   154

{

   155

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

   156

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

   157

}

   158

   159

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

   160

{

   161

	uint8 map_id_count, town_id_count, map_class_count, town_class_count;

   162

	HouseClassID class_id = GetHouseSpecs(house_id)->class_id;

   163

   164

	map_id_count     = _building_counts.id_count[house_id];

   165

	map_class_count  = _building_counts.class_count[class_id];

   166

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

   167

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

   168

   169

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

   170

}

   171

   172

static uint32 GetGRFParameter(HouseID house_id, byte parameter)

   173

{

   174

	const HouseSpec *hs = GetHouseSpecs(house_id);

   175

	const GRFFile *file = hs->grffile;

   176

   177

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

   178

	return file->param[parameter];

   179

}

   180

   181

/**

   182

 * HouseGetVariable():

   183

 *

   184

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

   185

 */

   186

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

   187

{

   188

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

   189

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

   190

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

   191

   192

	if (object->scope == VSG_SCOPE_PARENT) {

   193

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

   194

	}

   195

   196

	switch (variable) {

   197

		/* Construction stage. */

   198

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

   199

   200

		/* Building age. */

   201

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

   202

   203

		/* Town zone */

   204

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

   205

   206

		/* Terrain type */

   207

		case 0x43: return GetTerrainType(tile);

   208

   209

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

   210

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

   211

   212

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

   213

		case 0x45: return _generating_world ? 1 : 0;

   214

   215

		/* Current animation frame. */

   216

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

   217

   218

   219

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

   220

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

   221

   222

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

   223

		case 0x61: {

   224

			const HouseSpec *hs = GetHouseSpecs(house_id);

   225

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

   226

   227

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

   228

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

   229

		}

   230

   231

		/* Land info for nearby tiles. */

   232

		case 0x62: {

   233

			int8 x = GB(parameter, 0, 4);

   234

			int8 y = GB(parameter, 4, 4);

   235

			byte tile_type;

   236

   237

			if (x >= 8) x -= 16;

   238

			if (y >= 8) y -= 16;

   239

   240

			tile += TileDiffXY(x, y);

   241

   242

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

   243

   244

			return GetTileType(tile) << 24 | (TileHeight(tile) * 8) << 16 | tile_type << 8 | GetTileSlope(tile, NULL);

   245

		}

   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        = 0;

   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(uint16 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 (GB(image, 0, SPRITE_WIDTH) != 0) DrawGroundSprite(image, pal);

   313

   314

	foreach_draw_tile_seq(dtss, dts->seq) {

   315

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

   316

   317

		image = dtss->image + stage;

   318

		pal   = dtss->pal;

   319

   320

		if (!HASBIT(image, SPRITE_MODIFIER_OPAQUE) && HASBIT(_transparent_opt, TO_HOUSES)) {

   321

			SETBIT(image, PALETTE_MODIFIER_TRANSPARENT);

   322

			pal = PALETTE_TO_TRANSPARENT;

   323

		} else if (HASBIT(image, PALETTE_MODIFIER_COLOR)) {

   324

			if (pal == 0) {

   325

				const HouseSpec *hs = GetHouseSpecs(house_id);

   326

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

   327

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

   328

					if (callback != CALLBACK_FAILED) {

   329

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

   330

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

   331

					}

   332

				} else {

   333

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

   334

				}

   335

			}

   336

		} else {

   337

			pal = PAL_NONE;

   338

		}

   339

   340

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

   341

			AddSortableSpriteToDraw(

   342

				image, pal,

   343

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

   344

				dtss->size_x, dtss->size_y,

   345

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

   346

			);

   347

		} else {

   348

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

   349

		}

   350

	}

   351

}

   352

   353

void DrawNewHouseTile(TileInfo *ti, HouseID house_id)

   354

{

   355

	const HouseSpec *hs = GetHouseSpecs(house_id);

   356

	const SpriteGroup *group;

   357

	ResolverObject object;

   358

   359

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

   360

   361

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

   362

   363

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

   364

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

   365

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

   366

		DrawGroundSprite(SPR_SHADOW_CELL, PAL_NONE);

   367

	} else {

   368

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

   369

		byte stage = GetHouseBuildingStage(ti->tile);

   370

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

   371

		DrawTileLayout(ti, group, stage, house_id);

   372

	}

   373

}

   374

   375

void AnimateNewHouseTile(TileIndex tile)

   376

{

   377

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

   378

	byte animation_speed = hs->animation_speed;

   379

	bool frame_set_by_callback = false;

   380

   381

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

   382

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

   383

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

   384

	}

   385

   386

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

   387

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

   388

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

   389

	 * maximum, corresponding to around 33 minutes. */

   390

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

   391

   392

	byte frame      = GetHouseAnimationFrame(tile);

   393

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

   394

   395

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

   396

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

   397

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

   398

   399

		if (callback_res != CALLBACK_FAILED) {

   400

			frame_set_by_callback = true;

   401

   402

			switch (callback_res & 0xFF) {

   403

				case 0xFF:

   404

					DeleteAnimatedTile(tile);

   405

					break;

   406

				case 0xFE:

   407

					/* Carry on as normal. */

   408

					frame_set_by_callback = false;

   409

					break;

   410

				default:

   411

					frame = callback_res & 0xFF;

   412

					break;

   413

			}

   414

   415

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

   416

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

   417

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

   418

		}

   419

	}

   420

   421

	if (!frame_set_by_callback) {

   422

		if (frame < num_frames) {

   423

			frame++;

   424

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

   425

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

   426

			frame = 0;

   427

		} else {

   428

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

   429

			DeleteAnimatedTile(tile);

   430

		}

   431

	}

   432

   433

	SetHouseAnimationFrame(tile, frame);

   434

	MarkTileDirtyByTile(tile);

   435

}

   436

   437

void ChangeHouseAnimationFrame(TileIndex tile, uint16 callback_result)

   438

{

   439

	switch (callback_result & 0xFF) {

   440

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

   441

		case 0xFE: AddAnimatedTile(tile);    break;

   442

		case 0xFF: DeleteAnimatedTile(tile); break;

   443

		default:

   444

			SetHouseAnimationFrame(tile, callback_result & 0xFF);

   445

			AddAnimatedTile(tile);

   446

			break;

   447

	}

   448

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

   449

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

   450

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

   451

}

   452

   453

bool CanDeleteHouse(TileIndex tile)

   454

{

   455

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

   456

   457

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

   458

	 * anyone using the scenario editor. */

   459

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

   460

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

   461

   462

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

   463

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

   464

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

   465

	} else {

   466

		return !(hs->extra_flags & BUILDING_IS_PROTECTED);

   467

	}

   468

}

   469

   470

static void AnimationControl(TileIndex tile, uint16 random_bits)

   471

{

   472

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

   473

   474

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

   475

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

   476

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

   477

   478

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

   479

	}

   480

}

   481

   482

bool NewHouseTileLoop(TileIndex tile)

   483

{

   484

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

   485

   486

	if (GetHouseProcessingTime(tile) > 0) {

   487

		DecHouseProcessingTime(tile);

   488

		return true;

   489

	}

   490

   491

	/* @todo: Magic with triggers goes here.  Got to implement that, one day. ..

   492

	 * Process randomizing of tiles following specs.

   493

	 * Once done, redraw the house

   494

	 * MarkTileDirtyByTile(tile);

   495

	 */

   496

   497

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

   498

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

   499

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

   500

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

   501

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

   502

		if (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) {

   503

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

   504

   505

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

   506

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

   507

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

   508

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

   509

		} else {

   510

			AnimationControl(tile, 0);

   511

		}

   512

	}

   513

   514

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

   515

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

   516

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

   517

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

   518

			ClearTownHouse(GetTownByTile(tile), tile);

   519

			return false;

   520

		}

   521

	}

   522

   523

	SetHouseProcessingTime(tile, hs->processing_time);

   524

	return true;

   525

}