src/newgrf_house.cpp

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