src/newgrf_house.cpp

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file newgrf_house.cpp Implementation of NewGRF houses. */
  11
  12 #include "stdafx.h"
  13 #include "debug.h"
  14 #include "landscape.h"
  15 #include "newgrf_house.h"
  16 #include "newgrf_spritegroup.h"
  17 #include "newgrf_town.h"
  18 #include "newgrf_sound.h"
  19 #include "company_func.h"
  20 #include "company_base.h"
  21 #include "town.h"
  22 #include "genworld.h"
  23 #include "newgrf_animation_base.h"
  24 #include "newgrf_cargo.h"
  25 #include "station_base.h"
  26
  27 #include "safeguards.h"
  28
  29 static BuildingCounts<uint32> _building_counts;
  30 static HouseClassMapping _class_mapping[HOUSE_CLASS_MAX];
  31
  32 HouseOverrideManager _house_mngr(NEW_HOUSE_OFFSET, NUM_HOUSES, INVALID_HOUSE_ID);
  33
  34 /**
  35  * Retrieve the grf file associated with a house.
  36  * @param house_id House to query.
  37  * @return The associated GRF file (may be \c nullptr).
  38  */
  39 static const GRFFile *GetHouseSpecGrf(HouseID house_id)
  40 {
  41         const HouseSpec *hs  = HouseSpec::Get(house_id);
  42         return (hs != nullptr) ? hs->grf_prop.grffile : nullptr;
  43 }
  44
  45 /**
  46  * Construct a resolver for a house.
  47  * @param house_id House to query.
  48  * @param tile %Tile containing the house.
  49  * @param town %Town containing the house.
  50  * @param callback Callback ID.
  51  * @param param1 First parameter (var 10) of the callback.
  52  * @param param2 Second parameter (var 18) of the callback.
  53  * @param not_yet_constructed House is still under construction.
  54  * @param initial_random_bits Random bits during construction checks.
  55  * @param watched_cargo_triggers Cargo types that triggered the watched cargo callback.
  56  */
  57 HouseResolverObject::HouseResolverObject(HouseID house_id, TileIndex tile, Town *town,
  58                 CallbackID callback, uint32 param1, uint32 param2,
  59                 bool not_yet_constructed, uint8 initial_random_bits, uint32 watched_cargo_triggers)
  60         : ResolverObject(GetHouseSpecGrf(house_id), callback, param1, param2),
  61         house_scope(*this, house_id, tile, town, not_yet_constructed, initial_random_bits, watched_cargo_triggers),
  62         town_scope(*this, town, not_yet_constructed) // Don't access StorePSA if house is not yet constructed.
  63 {
  64         this->root_spritegroup = HouseSpec::Get(house_id)->grf_prop.spritegroup[0];
  65 }
  66
  67 HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid)
  68 {
  69         /* Start from 1 because 0 means that no class has been assigned. */
  70         for (int i = 1; i != lengthof(_class_mapping); i++) {
  71                 HouseClassMapping *map = &_class_mapping[i];
  72
  73                 if (map->class_id == grf_class_id && map->grfid == grfid) return (HouseClassID)i;
  74
  75                 if (map->class_id == 0 && map->grfid == 0) {
  76                         map->class_id = grf_class_id;
  77                         map->grfid    = grfid;
  78                         return (HouseClassID)i;
  79                 }
  80         }
  81         return HOUSE_NO_CLASS;
  82 }
  83
  84 void InitializeBuildingCounts()
  85 {
  86         memset(&_building_counts, 0, sizeof(_building_counts));
  87
  88         Town *t;
  89         FOR_ALL_TOWNS(t) {
  90                 memset(&t->cache.building_counts, 0, sizeof(t->cache.building_counts));
  91         }
  92 }
  93
  94 /**
  95  * IncreaseBuildingCount()
  96  * Increase the count of a building when it has been added by a town.
  97  * @param t The town that the building is being built in
  98  * @param house_id The id of the house being added
  99  */
 100 void IncreaseBuildingCount(Town *t, HouseID house_id)
 101 {
 102         HouseClassID class_id = HouseSpec::Get(house_id)->class_id;
 103
 104         if (!_loaded_newgrf_features.has_newhouses) return;
 105
 106         t->cache.building_counts.id_count[house_id]++;
 107         _building_counts.id_count[house_id]++;
 108
 109         if (class_id == HOUSE_NO_CLASS) return;
 110
 111         t->cache.building_counts.class_count[class_id]++;
 112         _building_counts.class_count[class_id]++;
 113 }
 114
 115 /**
 116  * DecreaseBuildingCount()
 117  * Decrease the number of a building when it is deleted.
 118  * @param t The town that the building was built in
 119  * @param house_id The id of the house being removed
 120  */
 121 void DecreaseBuildingCount(Town *t, HouseID house_id)
 122 {
 123         HouseClassID class_id = HouseSpec::Get(house_id)->class_id;
 124
 125         if (!_loaded_newgrf_features.has_newhouses) return;
 126
 127         if (t->cache.building_counts.id_count[house_id] > 0) t->cache.building_counts.id_count[house_id]--;
 128         if (_building_counts.id_count[house_id] > 0) _building_counts.id_count[house_id]--;
 129
 130         if (class_id == HOUSE_NO_CLASS) return;
 131
 132         if (t->cache.building_counts.class_count[class_id] > 0) t->cache.building_counts.class_count[class_id]--;
 133         if (_building_counts.class_count[class_id] > 0) _building_counts.class_count[class_id]--;
 134 }
 135
 136 /* virtual */ uint32 HouseScopeResolver::GetRandomBits() const
 137 {
 138         /* Note: Towns build houses over houses. So during construction checks 'tile' may be a valid but unrelated house. */
 139         assert(IsValidTile(this->tile) && (this->not_yet_constructed || IsTileType(this->tile, MP_HOUSE)));
 140         return this->not_yet_constructed ? this->initial_random_bits : GetHouseRandomBits(this->tile);
 141 }
 142
 143 /* virtual */ uint32 HouseScopeResolver::GetTriggers() const
 144 {
 145         /* Note: Towns build houses over houses. So during construction checks 'tile' may be a valid but unrelated house. */
 146         assert(IsValidTile(this->tile) && (this->not_yet_constructed || IsTileType(this->tile, MP_HOUSE)));
 147         return this->not_yet_constructed ? 0 : GetHouseTriggers(this->tile);
 148 }
 149
 150 static uint32 GetNumHouses(HouseID house_id, const Town *town)
 151 {
 152         uint8 map_id_count, town_id_count, map_class_count, town_class_count;
 153         HouseClassID class_id = HouseSpec::Get(house_id)->class_id;
 154
 155         map_id_count     = ClampU(_building_counts.id_count[house_id], 0, 255);
 156         map_class_count  = ClampU(_building_counts.class_count[class_id], 0, 255);
 157         town_id_count    = ClampU(town->cache.building_counts.id_count[house_id], 0, 255);
 158         town_class_count = ClampU(town->cache.building_counts.class_count[class_id], 0, 255);
 159
 160         return map_class_count << 24 | town_class_count << 16 | map_id_count << 8 | town_id_count;
 161 }
 162
 163 /**
 164  * Get information about a nearby tile.
 165  * @param parameter from callback. It's in fact a pair of coordinates
 166  * @param tile TileIndex from which the callback was initiated
 167  * @param grf_version8 True, if we are dealing with a new NewGRF which uses GRF version >= 8.
 168  * @return a construction of bits obeying the newgrf format
 169  */
 170 static uint32 GetNearbyTileInformation(byte parameter, TileIndex tile, bool grf_version8)
 171 {
 172         tile = GetNearbyTile(parameter, tile);
 173         return GetNearbyTileInformation(tile, grf_version8);
 174 }
 175
 176 /** Structure with user-data for SearchNearbyHouseXXX - functions */
 177 struct SearchNearbyHouseData {
 178         const HouseSpec *hs;  ///< Specs of the house that started the search.
 179         TileIndex north_tile; ///< Northern tile of the house.
 180 };
 181
 182 /**
 183  * Callback function to search a house by its HouseID
 184  * @param tile TileIndex to be examined
 185  * @param user_data SearchNearbyHouseData
 186  * @return true or false, if found or not
 187  */
 188 static bool SearchNearbyHouseID(TileIndex tile, void *user_data)
 189 {
 190         if (IsTileType(tile, MP_HOUSE)) {
 191                 HouseID house = GetHouseType(tile); // tile been examined
 192                 const HouseSpec *hs = HouseSpec::Get(house);
 193                 if (hs->grf_prop.grffile != nullptr) { // must be one from a grf file
 194                         SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;
 195
 196                         TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!
 197                         if (north_tile == nbhd->north_tile) return false; // Always ignore origin house
 198
 199                         return hs->grf_prop.local_id == nbhd->hs->grf_prop.local_id &&  // same local id as the one requested
 200                                 hs->grf_prop.grffile->grfid == nbhd->hs->grf_prop.grffile->grfid;  // from the same grf
 201                 }
 202         }
 203         return false;
 204 }
 205
 206 /**
 207  * Callback function to search a house by its classID
 208  * @param tile TileIndex to be examined
 209  * @param user_data SearchNearbyHouseData
 210  * @return true or false, if found or not
 211  */
 212 static bool SearchNearbyHouseClass(TileIndex tile, void *user_data)
 213 {
 214         if (IsTileType(tile, MP_HOUSE)) {
 215                 HouseID house = GetHouseType(tile); // tile been examined
 216                 const HouseSpec *hs = HouseSpec::Get(house);
 217                 if (hs->grf_prop.grffile != nullptr) { // must be one from a grf file
 218                         SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;
 219
 220                         TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!
 221                         if (north_tile == nbhd->north_tile) return false; // Always ignore origin house
 222
 223                         return hs->class_id == nbhd->hs->class_id &&  // same classid as the one requested
 224                                 hs->grf_prop.grffile->grfid == nbhd->hs->grf_prop.grffile->grfid;  // from the same grf
 225                 }
 226         }
 227         return false;
 228 }
 229
 230 /**
 231  * Callback function to search a house by its grfID
 232  * @param tile TileIndex to be examined
 233  * @param user_data SearchNearbyHouseData
 234  * @return true or false, if found or not
 235  */
 236 static bool SearchNearbyHouseGRFID(TileIndex tile, void *user_data)
 237 {
 238         if (IsTileType(tile, MP_HOUSE)) {
 239                 HouseID house = GetHouseType(tile); // tile been examined
 240                 const HouseSpec *hs = HouseSpec::Get(house);
 241                 if (hs->grf_prop.grffile != nullptr) { // must be one from a grf file
 242                         SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;
 243
 244                         TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!
 245                         if (north_tile == nbhd->north_tile) return false; // Always ignore origin house
 246
 247                         return hs->grf_prop.grffile->grfid == nbhd->hs->grf_prop.grffile->grfid;  // from the same grf
 248                 }
 249         }
 250         return false;
 251 }
 252
 253 /**
 254  * This function will activate a search around a central tile, looking for some houses
 255  * that fit the requested characteristics
 256  * @param parameter that is given by the callback.
 257  *                  bits 0..6 radius of the search
 258  *                  bits 7..8 search type i.e.: 0 = houseID/ 1 = classID/ 2 = grfID
 259  * @param tile TileIndex from which to start the search
 260  * @param house the HouseID that is associated to the house, the callback is called for
 261  * @return the Manhattan distance from the center tile, if any, and 0 if failure
 262  */
 263 static uint32 GetDistanceFromNearbyHouse(uint8 parameter, TileIndex tile, HouseID house)
 264 {
 265         static TestTileOnSearchProc * const search_procs[3] = {
 266                 SearchNearbyHouseID,
 267                 SearchNearbyHouseClass,
 268                 SearchNearbyHouseGRFID,
 269         };
 270         TileIndex found_tile = tile;
 271         uint8 searchtype = GB(parameter, 6, 2);
 272         uint8 searchradius = GB(parameter, 0, 6);
 273         if (searchtype >= lengthof(search_procs)) return 0;  // do not run on ill-defined code
 274         if (searchradius < 1) return 0; // do not use a too low radius
 275
 276         SearchNearbyHouseData nbhd;
 277         nbhd.hs = HouseSpec::Get(house);
 278         nbhd.north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!
 279
 280         /* Use a pointer for the tile to start the search. Will be required for calculating the distance*/
 281         if (CircularTileSearch(&found_tile, 2 * searchradius + 1, search_procs[searchtype], &nbhd)) {
 282                 return DistanceManhattan(found_tile, tile);
 283         }
 284         return 0;
 285 }
 286
 287 /**
 288  * @note Used by the resolver to get values for feature 07 deterministic spritegroups.
 289  */
 290 /* virtual */ uint32 HouseScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
 291 {
 292         switch (variable) {
 293                 /* Construction stage. */
 294                 case 0x40: return (IsTileType(this->tile, MP_HOUSE) ? GetHouseBuildingStage(this->tile) : 0) | TileHash2Bit(TileX(this->tile), TileY(this->tile)) << 2;
 295
 296                 /* Building age. */
 297                 case 0x41: return IsTileType(this->tile, MP_HOUSE) ? GetHouseAge(this->tile) : 0;
 298
 299                 /* Town zone */
 300                 case 0x42: return GetTownRadiusGroup(this->town, this->tile);
 301
 302                 /* Terrain type */
 303                 case 0x43: return GetTerrainType(this->tile);
 304
 305                 /* Number of this type of building on the map. */
 306                 case 0x44: return GetNumHouses(this->house_id, this->town);
 307
 308                 /* Whether the town is being created or just expanded. */
 309                 case 0x45: return _generating_world ? 1 : 0;
 310
 311                 /* Current animation frame. */
 312                 case 0x46: return IsTileType(this->tile, MP_HOUSE) ? GetAnimationFrame(this->tile) : 0;
 313
 314                 /* Position of the house */
 315                 case 0x47: return TileY(this->tile) << 16 | TileX(this->tile);
 316
 317                 /* Building counts for old houses with id = parameter. */
 318                 case 0x60: return parameter < NEW_HOUSE_OFFSET ? GetNumHouses(parameter, this->town) : 0;
 319
 320                 /* Building counts for new houses with id = parameter. */
 321                 case 0x61: {
 322                         const HouseSpec *hs = HouseSpec::Get(this->house_id);
 323                         if (hs->grf_prop.grffile == nullptr) return 0;
 324
 325                         HouseID new_house = _house_mngr.GetID(parameter, hs->grf_prop.grffile->grfid);
 326                         return new_house == INVALID_HOUSE_ID ? 0 : GetNumHouses(new_house, this->town);
 327                 }
 328
 329                 /* Land info for nearby tiles. */
 330                 case 0x62: return GetNearbyTileInformation(parameter, this->tile, this->ro.grffile->grf_version >= 8);
 331
 332                 /* Current animation frame of nearby house tiles */
 333                 case 0x63: {
 334                         TileIndex testtile = GetNearbyTile(parameter, this->tile);
 335                         return IsTileType(testtile, MP_HOUSE) ? GetAnimationFrame(testtile) : 0;
 336                 }
 337
 338                 /* Cargo acceptance history of nearby stations */
 339                 case 0x64: {
 340                         CargoID cid = GetCargoTranslation(parameter, this->ro.grffile);
 341                         if (cid == CT_INVALID) return 0;
 342
 343                         /* Extract tile offset. */
 344                         int8 x_offs = GB(GetRegister(0x100), 0, 8);
 345                         int8 y_offs = GB(GetRegister(0x100), 8, 8);
 346                         TileIndex testtile = TILE_MASK(this->tile + TileDiffXY(x_offs, y_offs));
 347
 348                         StationFinder stations(TileArea(testtile, 1, 1));
 349                         const StationList *sl = stations.GetStations();
 350
 351                         /* Collect acceptance stats. */
 352                         uint32 res = 0;
 353                         for (Station * const * st_iter = sl->Begin(); st_iter != sl->End(); st_iter++) {
 354                                 const Station *st = *st_iter;
 355                                 if (HasBit(st->goods[cid].status, GoodsEntry::GES_EVER_ACCEPTED))    SetBit(res, 0);
 356                                 if (HasBit(st->goods[cid].status, GoodsEntry::GES_LAST_MONTH))       SetBit(res, 1);
 357                                 if (HasBit(st->goods[cid].status, GoodsEntry::GES_CURRENT_MONTH))    SetBit(res, 2);
 358                                 if (HasBit(st->goods[cid].status, GoodsEntry::GES_ACCEPTED_BIGTICK)) SetBit(res, 3);
 359                         }
 360
 361                         /* Cargo triggered CB 148? */
 362                         if (HasBit(this->watched_cargo_triggers, cid)) SetBit(res, 4);
 363
 364                         return res;
 365                 }
 366
 367                 /* Distance test for some house types */
 368                 case 0x65: return GetDistanceFromNearbyHouse(parameter, this->tile, this->house_id);
 369
 370                 /* Class and ID of nearby house tile */
 371                 case 0x66: {
 372                         TileIndex testtile = GetNearbyTile(parameter, this->tile);
 373                         if (!IsTileType(testtile, MP_HOUSE)) return 0xFFFFFFFF;
 374                         HouseID nearby_house_id = GetHouseType(testtile);
 375                         HouseSpec *hs = HouseSpec::Get(nearby_house_id);
 376                         /* Information about the grf local classid if the house has a class */
 377                         uint houseclass = 0;
 378                         if (hs->class_id != HOUSE_NO_CLASS) {
 379                                 houseclass = (hs->grf_prop.grffile == this->ro.grffile ? 1 : 2) << 8;
 380                                 houseclass |= _class_mapping[hs->class_id].class_id;
 381                         }
 382                         /* old house type or grf-local houseid */
 383                         uint local_houseid = 0;
 384                         if (nearby_house_id < NEW_HOUSE_OFFSET) {
 385                                 local_houseid = nearby_house_id;
 386                         } else {
 387                                 local_houseid = (hs->grf_prop.grffile == this->ro.grffile ? 1 : 2) << 8;
 388                                 local_houseid |= hs->grf_prop.local_id;
 389                         }
 390                         return houseclass << 16 | local_houseid;
 391                 }
 392
 393                 /* GRFID of nearby house tile */
 394                 case 0x67: {
 395                         TileIndex testtile = GetNearbyTile(parameter, this->tile);
 396                         if (!IsTileType(testtile, MP_HOUSE)) return 0xFFFFFFFF;
 397                         HouseID house_id = GetHouseType(testtile);
 398                         if (house_id < NEW_HOUSE_OFFSET) return 0;
 399                         /* Checking the grffile information via HouseSpec doesn't work
 400                          * in case the newgrf was removed. */
 401                         return _house_mngr.GetGRFID(house_id);
 402                 }
 403         }
 404
 405         DEBUG(grf, 1, "Unhandled house variable 0x%X", variable);
 406
 407         *available = false;
 408         return UINT_MAX;
 409 }
 410
 411 uint16 GetHouseCallback(CallbackID callback, uint32 param1, uint32 param2, HouseID house_id, Town *town, TileIndex tile,
 412                 bool not_yet_constructed, uint8 initial_random_bits, uint32 watched_cargo_triggers)
 413 {
 414         assert(IsValidTile(tile) && (not_yet_constructed || IsTileType(tile, MP_HOUSE)));
 415
 416         HouseResolverObject object(house_id, tile, town, callback, param1, param2,
 417                         not_yet_constructed, initial_random_bits, watched_cargo_triggers);
 418         return object.ResolveCallback();
 419 }
 420
 421 static void DrawTileLayout(const TileInfo *ti, const TileLayoutSpriteGroup *group, byte stage, HouseID house_id)
 422 {
 423         const DrawTileSprites *dts = group->ProcessRegisters(&stage);
 424
 425         const HouseSpec *hs = HouseSpec::Get(house_id);
 426         PaletteID palette = hs->random_colour[TileHash2Bit(ti->x, ti->y)] + PALETTE_RECOLOUR_START;
 427         if (HasBit(hs->callback_mask, CBM_HOUSE_COLOUR)) {
 428                 uint16 callback = GetHouseCallback(CBID_HOUSE_COLOUR, 0, 0, house_id, Town::GetByTile(ti->tile), ti->tile);
 429                 if (callback != CALLBACK_FAILED) {
 430                         /* If bit 14 is set, we should use a 2cc colour map, else use the callback value. */
 431                         palette = HasBit(callback, 14) ? GB(callback, 0, 8) + SPR_2CCMAP_BASE : callback;
 432                 }
 433         }
 434
 435         SpriteID image = dts->ground.sprite;
 436         PaletteID pal  = dts->ground.pal;
 437
 438         if (HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE)) image += stage;
 439         if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += stage;
 440
 441         if (GB(image, 0, SPRITE_WIDTH) != 0) {
 442                 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
 443         }
 444
 445         DrawOverlay(ti, MP_HOUSE);
 446
 447         DrawNewGRFTileSeq(ti, dts, TO_HOUSES, stage, palette);
 448 }
 449
 450 void DrawNewHouseTile(TileInfo *ti, HouseID house_id)
 451 {
 452         const HouseSpec *hs = HouseSpec::Get(house_id);
 453
 454         if (ti->tileh != SLOPE_FLAT) {
 455                 bool draw_old_one = true;
 456                 if (HasBit(hs->callback_mask, CBM_HOUSE_DRAW_FOUNDATIONS)) {
 457                         /* Called to determine the type (if any) of foundation to draw for the house tile */
 458                         uint32 callback_res = GetHouseCallback(CBID_HOUSE_DRAW_FOUNDATIONS, 0, 0, house_id, Town::GetByTile(ti->tile), ti->tile);
 459                         if (callback_res != CALLBACK_FAILED) draw_old_one = ConvertBooleanCallback(hs->grf_prop.grffile, CBID_HOUSE_DRAW_FOUNDATIONS, callback_res);
 460                 }
 461
 462                 if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);
 463         }
 464
 465         HouseResolverObject object(house_id, ti->tile, Town::GetByTile(ti->tile));
 466
 467         const SpriteGroup *group = object.Resolve();
 468         if (group != nullptr && group->type == SGT_TILELAYOUT) {
 469                 /* Limit the building stage to the number of stages supplied. */
 470                 const TileLayoutSpriteGroup *tlgroup = (const TileLayoutSpriteGroup *)group;
 471                 byte stage = GetHouseBuildingStage(ti->tile);
 472                 DrawTileLayout(ti, tlgroup, stage, house_id);
 473         }
 474 }
 475
 476 /* Simple wrapper for GetHouseCallback to keep the animation unified. */
 477 uint16 GetSimpleHouseCallback(CallbackID callback, uint32 param1, uint32 param2, const HouseSpec *spec, Town *town, TileIndex tile, uint32 extra_data)
 478 {
 479         return GetHouseCallback(callback, param1, param2, spec - HouseSpec::Get(0), town, tile, false, 0, extra_data);
 480 }
 481
 482 /** Helper class for animation control. */
 483 struct HouseAnimationBase : public AnimationBase<HouseAnimationBase, HouseSpec, Town, uint32, GetSimpleHouseCallback> {
 484         static const CallbackID cb_animation_speed      = CBID_HOUSE_ANIMATION_SPEED;
 485         static const CallbackID cb_animation_next_frame = CBID_HOUSE_ANIMATION_NEXT_FRAME;
 486
 487         static const HouseCallbackMask cbm_animation_speed      = CBM_HOUSE_ANIMATION_SPEED;
 488         static const HouseCallbackMask cbm_animation_next_frame = CBM_HOUSE_ANIMATION_NEXT_FRAME;
 489 };
 490
 491 void AnimateNewHouseTile(TileIndex tile)
 492 {
 493         const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
 494         if (hs == nullptr) return;
 495
 496         HouseAnimationBase::AnimateTile(hs, Town::GetByTile(tile), tile, HasBit(hs->extra_flags, CALLBACK_1A_RANDOM_BITS));
 497 }
 498
 499 void AnimateNewHouseConstruction(TileIndex tile)
 500 {
 501         const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
 502
 503         if (HasBit(hs->callback_mask, CBM_HOUSE_CONSTRUCTION_STATE_CHANGE)) {
 504                 HouseAnimationBase::ChangeAnimationFrame(CBID_HOUSE_CONSTRUCTION_STATE_CHANGE, hs, Town::GetByTile(tile), tile, 0, 0);
 505         }
 506 }
 507
 508 bool CanDeleteHouse(TileIndex tile)
 509 {
 510         const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
 511
 512         /* Humans are always allowed to remove buildings, as is water and disasters and
 513          * anyone using the scenario editor. */
 514         if (Company::IsValidHumanID(_current_company) || _current_company == OWNER_WATER || _current_company == OWNER_NONE || _game_mode == GM_EDITOR || _generating_world) {
 515                 return true;
 516         }
 517
 518         if (HasBit(hs->callback_mask, CBM_HOUSE_DENY_DESTRUCTION)) {
 519                 uint16 callback_res = GetHouseCallback(CBID_HOUSE_DENY_DESTRUCTION, 0, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
 520                 return (callback_res == CALLBACK_FAILED || !ConvertBooleanCallback(hs->grf_prop.grffile, CBID_HOUSE_DENY_DESTRUCTION, callback_res));
 521         } else {
 522                 return !(hs->extra_flags & BUILDING_IS_PROTECTED);
 523         }
 524 }
 525
 526 static void AnimationControl(TileIndex tile, uint16 random_bits)
 527 {
 528         const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
 529
 530         if (HasBit(hs->callback_mask, CBM_HOUSE_ANIMATION_START_STOP)) {
 531                 uint32 param = (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) ? (GB(Random(), 0, 16) | random_bits << 16) : Random();
 532                 HouseAnimationBase::ChangeAnimationFrame(CBID_HOUSE_ANIMATION_START_STOP, hs, Town::GetByTile(tile), tile, param, 0);
 533         }
 534 }
 535
 536 bool NewHouseTileLoop(TileIndex tile)
 537 {
 538         const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
 539
 540         if (GetHouseProcessingTime(tile) > 0) {
 541                 DecHouseProcessingTime(tile);
 542                 return true;
 543         }
 544
 545         TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP);
 546         if (hs->building_flags & BUILDING_HAS_1_TILE) TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP_TOP);
 547
 548         if (HasBit(hs->callback_mask, CBM_HOUSE_ANIMATION_START_STOP)) {
 549                 /* If this house is marked as having a synchronised callback, all the
 550                  * tiles will have the callback called at once, rather than when the
 551                  * tile loop reaches them. This should only be enabled for the northern
 552                  * tile, or strange things will happen (here, and in TTDPatch). */
 553                 if (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) {
 554                         uint16 random = GB(Random(), 0, 16);
 555
 556                         if (hs->building_flags & BUILDING_HAS_1_TILE)  AnimationControl(tile, random);
 557                         if (hs->building_flags & BUILDING_2_TILES_Y)   AnimationControl(TILE_ADDXY(tile, 0, 1), random);
 558                         if (hs->building_flags & BUILDING_2_TILES_X)   AnimationControl(TILE_ADDXY(tile, 1, 0), random);
 559                         if (hs->building_flags & BUILDING_HAS_4_TILES) AnimationControl(TILE_ADDXY(tile, 1, 1), random);
 560                 } else {
 561                         AnimationControl(tile, 0);
 562                 }
 563         }
 564
 565         /* Check callback 21, which determines if a house should be destroyed. */
 566         if (HasBit(hs->callback_mask, CBM_HOUSE_DESTRUCTION)) {
 567                 uint16 callback_res = GetHouseCallback(CBID_HOUSE_DESTRUCTION, 0, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
 568                 if (callback_res != CALLBACK_FAILED && Convert8bitBooleanCallback(hs->grf_prop.grffile, CBID_HOUSE_DESTRUCTION, callback_res)) {
 569                         ClearTownHouse(Town::GetByTile(tile), tile);
 570                         return false;
 571                 }
 572         }
 573
 574         SetHouseProcessingTime(tile, hs->processing_time);
 575         MarkTileDirtyByTile(tile, ZOOM_LVL_DRAW_MAP);
 576         return true;
 577 }
 578
 579 static void DoTriggerHouse(TileIndex tile, HouseTrigger trigger, byte base_random, bool first)
 580 {
 581         /* We can't trigger a non-existent building... */
 582         assert(IsTileType(tile, MP_HOUSE));
 583
 584         HouseID hid = GetHouseType(tile);
 585         HouseSpec *hs = HouseSpec::Get(hid);
 586
 587         if (hs->grf_prop.spritegroup[0] == nullptr) return;
 588
 589         HouseResolverObject object(hid, tile, Town::GetByTile(tile), CBID_RANDOM_TRIGGER);
 590         object.waiting_triggers = GetHouseTriggers(tile) | trigger;
 591         SetHouseTriggers(tile, object.waiting_triggers); // store now for var 5F
 592
 593         const SpriteGroup *group = object.Resolve();
 594         if (group == nullptr) return;
 595
 596         /* Store remaining triggers. */
 597         SetHouseTriggers(tile, object.GetRemainingTriggers());
 598
 599         /* Rerandomise bits. Scopes other than SELF are invalid for houses. For bug-to-bug-compatibility with TTDP we ignore the scope. */
 600         byte new_random_bits = Random();
 601         byte random_bits = GetHouseRandomBits(tile);
 602         uint32 reseed = object.GetReseedSum();
 603         random_bits &= ~reseed;
 604         random_bits |= (first ? new_random_bits : base_random) & reseed;
 605         SetHouseRandomBits(tile, random_bits);
 606
 607         switch (trigger) {
 608                 case HOUSE_TRIGGER_TILE_LOOP:
 609                         /* Random value already set. */
 610                         break;
 611
 612                 case HOUSE_TRIGGER_TILE_LOOP_TOP:
 613                         if (!first) {
 614                                 /* The top tile is marked dirty by the usual TileLoop */
 615                                 MarkTileDirtyByTile(tile, ZOOM_LVL_DRAW_MAP);
 616                                 break;
 617                         }
 618                         /* Random value of first tile already set. */
 619                         if (hs->building_flags & BUILDING_2_TILES_Y)   DoTriggerHouse(TILE_ADDXY(tile, 0, 1), trigger, random_bits, false);
 620                         if (hs->building_flags & BUILDING_2_TILES_X)   DoTriggerHouse(TILE_ADDXY(tile, 1, 0), trigger, random_bits, false);
 621                         if (hs->building_flags & BUILDING_HAS_4_TILES) DoTriggerHouse(TILE_ADDXY(tile, 1, 1), trigger, random_bits, false);
 622                         break;
 623         }
 624 }
 625
 626 void TriggerHouse(TileIndex t, HouseTrigger trigger)
 627 {
 628         DoTriggerHouse(t, trigger, 0, true);
 629 }
 630
 631 /**
 632  * Run the watched cargo accepted callback for a single house tile.
 633  * @param tile The house tile.
 634  * @param origin The triggering tile.
 635  * @param trigger_cargoes Cargo types that triggered the callback.
 636  * @param random Random bits.
 637  */
 638 void DoWatchedCargoCallback(TileIndex tile, TileIndex origin, uint32 trigger_cargoes, uint16 random)
 639 {
 640         TileIndexDiffC diff = TileIndexToTileIndexDiffC(origin, tile);
 641         uint32 cb_info = random << 16 | (uint8)diff.y << 8 | (uint8)diff.x;
 642         HouseAnimationBase::ChangeAnimationFrame(CBID_HOUSE_WATCHED_CARGO_ACCEPTED, HouseSpec::Get(GetHouseType(tile)), Town::GetByTile(tile), tile, 0, cb_info, trigger_cargoes);
 643 }
 644
 645 /**
 646  * Run watched cargo accepted callback for a house.
 647  * @param tile House tile.
 648  * @param trigger_cargoes Triggering cargo types.
 649  * @pre IsTileType(t, MP_HOUSE)
 650  */
 651 void WatchedCargoCallback(TileIndex tile, uint32 trigger_cargoes)
 652 {
 653         assert(IsTileType(tile, MP_HOUSE));
 654         HouseID id = GetHouseType(tile);
 655         const HouseSpec *hs = HouseSpec::Get(id);
 656
 657         trigger_cargoes &= hs->watched_cargoes;
 658         /* None of the trigger cargoes is watched? */
 659         if (trigger_cargoes == 0) return;
 660
 661         /* Same random value for all tiles of a multi-tile house. */
 662         uint16 r = Random();
 663
 664         /* Do the callback, start at northern tile. */
 665         TileIndex north = tile + GetHouseNorthPart(id);
 666         hs = HouseSpec::Get(id);
 667
 668         DoWatchedCargoCallback(north, tile, trigger_cargoes, r);
 669         if (hs->building_flags & BUILDING_2_TILES_Y)   DoWatchedCargoCallback(TILE_ADDXY(north, 0, 1), tile, trigger_cargoes, r);
 670         if (hs->building_flags & BUILDING_2_TILES_X)   DoWatchedCargoCallback(TILE_ADDXY(north, 1, 0), tile, trigger_cargoes, r);
 671         if (hs->building_flags & BUILDING_HAS_4_TILES) DoWatchedCargoCallback(TILE_ADDXY(north, 1, 1), tile, trigger_cargoes, r);
 672 }
 673