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