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

    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

   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

{

   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

uint32 GetNearbyTileInformation(byte parameter, TileIndex tile)

   182

{

   183

	uint32 tile_type;

   184

   185

	tile = GetNearbyTile(parameter, tile);

   186

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

   187

   188

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

   189

}

   190

   191

/**

   192

 * HouseGetVariable():

   193

 *

   194

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

   195

 */

   196

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

   197

{

   198

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

   199

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

   200

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

   201

   202

	if (object->scope == VSG_SCOPE_PARENT) {

   203

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

   204

	}

   205

   206

	switch (variable) {

   207

		/* Construction stage. */

   208

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

   209

   210

		/* Building age. */

   211

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

   212

   213

		/* Town zone */

   214

		case 0x42: return town->GetRadiusGroup(tile);

   215

   216

		/* Terrain type */

   217

		case 0x43: return GetTerrainType(tile);

   218

   219

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

   220

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

   221

   222

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

   223

		case 0x45: return _generating_world ? 1 : 0;

   224

   225

		/* Current animation frame. */

   226

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

   227

   228

   229

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

   230

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

   231

   232

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

   233

		case 0x61: {

   234

			const HouseSpec *hs = GetHouseSpecs(house_id);

   235

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

   236

   237

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

   238

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

   239

		}

   240

   241

		/* Land info for nearby tiles. */

   242

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

   243

   244

		/* Read GRF parameter */

   245

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

   246

	}

   247

   248

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

   249

   250

	*available = false;

   251

	return UINT_MAX;

   252

}

   253

   254

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

   255

{

   256

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

   257

	return NULL;

   258

}

   259

   260

/**

   261

 * NewHouseResolver():

   262

 *

   263

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

   264

 */

   265

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

   266

{

   267

	res->GetRandomBits = HouseGetRandomBits;

   268

	res->GetTriggers   = HouseGetTriggers;

   269

	res->SetTriggers   = HouseSetTriggers;

   270

	res->GetVariable   = HouseGetVariable;

   271

	res->ResolveReal   = HouseResolveReal;

   272

   273

	res->u.house.tile     = tile;

   274

	res->u.house.town     = town;

   275

	res->u.house.house_id = house_id;

   276

   277

	res->callback        = 0;

   278

	res->callback_param1 = 0;

   279

	res->callback_param2 = 0;

   280

	res->last_value      = 0;

   281

	res->trigger         = 0;

   282

	res->reseed          = 0;

   283

}

   284

   285

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

   286

{

   287

	ResolverObject object;

   288

	const SpriteGroup *group;

   289

   290

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

   291

	object.callback = callback;

   292

	object.callback_param1 = param1;

   293

	object.callback_param2 = param2;

   294

   295

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

   296

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

   297

   298

	return group->g.callback.result;

   299

}

   300

   301

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

   302

{

   303

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

   304

	const DrawTileSeqStruct *dtss;

   305

   306

	SpriteID image = dts->ground_sprite;

   307

	SpriteID pal   = dts->ground_pal;

   308

   309

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

   310

   311

	foreach_draw_tile_seq(dtss, dts->seq) {

   312

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

   313

   314

		image = dtss->image + stage;

   315

		pal   = dtss->pal;

   316

   317

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

   318

			SETBIT(image, PALETTE_MODIFIER_TRANSPARENT);

   319

			pal = PALETTE_TO_TRANSPARENT;

   320

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

   321

			if (pal == 0) {

   322

				const HouseSpec *hs = GetHouseSpecs(house_id);

   323

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

   324

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

   325

					if (callback != CALLBACK_FAILED) {

   326

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

   327

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

   328

					}

   329

				} else {

   330

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

   331

				}

   332

			}

   333

		} else {

   334

			pal = PAL_NONE;

   335

		}

   336

   337

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

   338

			AddSortableSpriteToDraw(

   339

				image, pal,

   340

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

   341

				dtss->size_x, dtss->size_y,

   342

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

   343

			);

   344

		} else {

   345

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

   346

		}

   347

	}

   348

}

   349

   350

void DrawNewHouseTile(TileInfo *ti, HouseID house_id)

   351

{

   352

	const HouseSpec *hs = GetHouseSpecs(house_id);

   353

	const SpriteGroup *group;

   354

	ResolverObject object;

   355

   356

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

   357

   358

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

   359

   360

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

   361

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

   362

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

   363

		DrawGroundSprite(SPR_SHADOW_CELL, PAL_NONE);

   364

	} else {

   365

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

   366

		byte stage = GetHouseBuildingStage(ti->tile);

   367

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

   368

		DrawTileLayout(ti, group, stage, house_id);

   369

	}

   370

}

   371

   372

void AnimateNewHouseTile(TileIndex tile)

   373

{

   374

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

   375

	byte animation_speed = hs->animation_speed;

   376

	bool frame_set_by_callback = false;

   377

   378

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

   379

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

   380

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

   381

	}

   382

   383

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

   384

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

   385

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

   386

	 * maximum, corresponding to around 33 minutes. */

   387

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

   388

   389

	byte frame      = GetHouseAnimationFrame(tile);

   390

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

   391

   392

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

   393

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

   394

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

   395

   396

		if (callback_res != CALLBACK_FAILED) {

   397

			frame_set_by_callback = true;

   398

   399

			switch (callback_res & 0xFF) {

   400

				case 0xFF:

   401

					DeleteAnimatedTile(tile);

   402

					break;

   403

				case 0xFE:

   404

					/* Carry on as normal. */

   405

					frame_set_by_callback = false;

   406

					break;

   407

				default:

   408

					frame = callback_res & 0xFF;

   409

					break;

   410

			}

   411

   412

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

   413

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

   414

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

   415

		}

   416

	}

   417

   418

	if (!frame_set_by_callback) {

   419

		if (frame < num_frames) {

   420

			frame++;

   421

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

   422

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

   423

			frame = 0;

   424

		} else {

   425

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

   426

			DeleteAnimatedTile(tile);

   427

		}

   428

	}

   429

   430

	SetHouseAnimationFrame(tile, frame);

   431

	MarkTileDirtyByTile(tile);

   432

}

   433

   434

void ChangeHouseAnimationFrame(TileIndex tile, uint16 callback_result)

   435

{

   436

	switch (callback_result & 0xFF) {

   437

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

   438

		case 0xFE: AddAnimatedTile(tile);    break;

   439

		case 0xFF: DeleteAnimatedTile(tile); break;

   440

		default:

   441

			SetHouseAnimationFrame(tile, callback_result & 0xFF);

   442

			AddAnimatedTile(tile);

   443

			break;

   444

	}

   445

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

   446

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

   447

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

   448

}

   449

   450

bool CanDeleteHouse(TileIndex tile)

   451

{

   452

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

   453

   454

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

   455

	 * anyone using the scenario editor. */

   456

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

   457

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

   458

   459

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

   460

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

   461

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

   462

	} else {

   463

		return !(hs->extra_flags & BUILDING_IS_PROTECTED);

   464

	}

   465

}

   466

   467

static void AnimationControl(TileIndex tile, uint16 random_bits)

   468

{

   469

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

   470

   471

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

   472

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

   473

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

   474

   475

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

   476

	}

   477

}

   478

   479

bool NewHouseTileLoop(TileIndex tile)

   480

{

   481

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

   482

   483

	if (GetHouseProcessingTime(tile) > 0) {

   484

		DecHouseProcessingTime(tile);

   485

		return true;

   486

	}

   487

   488

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

   489

	 * Process randomizing of tiles following specs.

   490

	 * Once done, redraw the house

   491

	 * MarkTileDirtyByTile(tile);

   492

	 */

   493

   494

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

   495

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

   496

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

   497

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

   498

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

   499

		if (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) {

   500

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

   501

   502

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

   503

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

   504

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

   505

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

   506

		} else {

   507

			AnimationControl(tile, 0);

   508

		}

   509

	}

   510

   511

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

   512

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

   513

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

   514

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

   515

			ClearTownHouse(GetTownByTile(tile), tile);

   516

			return false;

   517

		}

   518

	}

   519

   520

	SetHouseProcessingTime(tile, hs->processing_time);

   521

	return true;

   522

}