OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

newgrf_house.cpp
Go to the documentation of this file.
1 /* $Id: newgrf_house.cpp 26580 2014-05-11 18:02:11Z rubidium $ */
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
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
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
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
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
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
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
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
205 struct SearchNearbyHouseData {
206 const HouseSpec *hs;
207 TileIndex north_tile;
208 };
209
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
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
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
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
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 HouseSpec *hs = HouseSpec::Get(GetHouseType(testtile));
403 /* Information about the grf local classid if the house has a class */
404 uint houseclass = 0;
405 if (hs->class_id != HOUSE_NO_CLASS) {
406 houseclass = (hs->grf_prop.grffile == this->ro.grffile ? 1 : 2) << 8;
407 houseclass |= _class_mapping[hs->class_id].class_id;
408 }
409 /* old house type or grf-local houseid */
410 uint local_houseid = 0;
411 if (this->house_id < NEW_HOUSE_OFFSET) {
412 local_houseid = this->house_id;
413 } else {
414 local_houseid = (hs->grf_prop.grffile == this->ro.grffile ? 1 : 2) << 8;
415 local_houseid |= hs->grf_prop.local_id;
416 }
417 return houseclass << 16 | local_houseid;
418 }
419
420 /* GRFID of nearby house tile */
421 case 0x67: {
422 TileIndex testtile = GetNearbyTile(parameter, this->tile);
423 if (!IsTileType(testtile, MP_HOUSE)) return 0xFFFFFFFF;
424 HouseID house_id = GetHouseType(testtile);
425 if (house_id < NEW_HOUSE_OFFSET) return 0;
426 /* Checking the grffile information via HouseSpec doesn't work
427 * in case the newgrf was removed. */
428 return _house_mngr.GetGRFID(house_id);
429 }
430 }
431
432 DEBUG(grf, 1, "Unhandled house variable 0x%X", variable);
433
434 *available = false;
435 return UINT_MAX;
436 }
437
438 uint16 GetHouseCallback(CallbackID callback, uint32 param1, uint32 param2, HouseID house_id, Town *town, TileIndex tile,
439 bool not_yet_constructed, uint8 initial_random_bits, uint32 watched_cargo_triggers)
440 {
441 assert(IsValidTile(tile) && (not_yet_constructed || IsTileType(tile, MP_HOUSE)));
442
443 HouseResolverObject object(house_id, tile, town, callback, param1, param2,
444 not_yet_constructed, initial_random_bits, watched_cargo_triggers);
445 return object.ResolveCallback();
446 }
447
448 static void DrawTileLayout(const TileInfo *ti, const TileLayoutSpriteGroup *group, byte stage, HouseID house_id)
449 {
450 const DrawTileSprites *dts = group->ProcessRegisters(&stage);
451
452 const HouseSpec *hs = HouseSpec::Get(house_id);
453 PaletteID palette = hs->random_colour[TileHash2Bit(ti->x, ti->y)] + PALETTE_RECOLOUR_START;
454 if (HasBit(hs->callback_mask, CBM_HOUSE_COLOUR)) {
455 uint16 callback = GetHouseCallback(CBID_HOUSE_COLOUR, 0, 0, house_id, Town::GetByTile(ti->tile), ti->tile);
456 if (callback != CALLBACK_FAILED) {
457 /* If bit 14 is set, we should use a 2cc colour map, else use the callback value. */
458 palette = HasBit(callback, 14) ? GB(callback, 0, 8) + SPR_2CCMAP_BASE : callback;
459 }
460 }
461
462 SpriteID image = dts->ground.sprite;
463 PaletteID pal = dts->ground.pal;
464
465 if (HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE)) image += stage;
466 if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += stage;
467
468 if (GB(image, 0, SPRITE_WIDTH) != 0) {
469 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
470 }
471
472 DrawNewGRFTileSeq(ti, dts, TO_HOUSES, stage, palette);
473 }
474
475 void DrawNewHouseTile(TileInfo *ti, HouseID house_id)
476 {
477 const HouseSpec *hs = HouseSpec::Get(house_id);
478
479 if (ti->tileh != SLOPE_FLAT) {
480 bool draw_old_one = true;
481 if (HasBit(hs->callback_mask, CBM_HOUSE_DRAW_FOUNDATIONS)) {
482 /* Called to determine the type (if any) of foundation to draw for the house tile */
483 uint32 callback_res = GetHouseCallback(CBID_HOUSE_DRAW_FOUNDATIONS, 0, 0, house_id, Town::GetByTile(ti->tile), ti->tile);
484 if (callback_res != CALLBACK_FAILED) draw_old_one = ConvertBooleanCallback(hs->grf_prop.grffile, CBID_HOUSE_DRAW_FOUNDATIONS, callback_res);
485 }
486
487 if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);
488 }
489
490 HouseResolverObject object(house_id, ti->tile, Town::GetByTile(ti->tile));
491
492 const SpriteGroup *group = object.Resolve();
493 if (group != NULL && group->type == SGT_TILELAYOUT) {
494 /* Limit the building stage to the number of stages supplied. */
495 const TileLayoutSpriteGroup *tlgroup = (const TileLayoutSpriteGroup *)group;
496 byte stage = GetHouseBuildingStage(ti->tile);
497 DrawTileLayout(ti, tlgroup, stage, house_id);
498 }
499 }
500
501 /* Simple wrapper for GetHouseCallback to keep the animation unified. */
502 uint16 GetSimpleHouseCallback(CallbackID callback, uint32 param1, uint32 param2, const HouseSpec *spec, Town *town, TileIndex tile, uint32 extra_data)
503 {
504 return GetHouseCallback(callback, param1, param2, spec - HouseSpec::Get(0), town, tile, false, 0, extra_data);
505 }
506
508 struct HouseAnimationBase : public AnimationBase<HouseAnimationBase, HouseSpec, Town, uint32, GetSimpleHouseCallback> {
509 static const CallbackID cb_animation_speed = CBID_HOUSE_ANIMATION_SPEED;
510 static const CallbackID cb_animation_next_frame = CBID_HOUSE_ANIMATION_NEXT_FRAME;
511
512 static const HouseCallbackMask cbm_animation_speed = CBM_HOUSE_ANIMATION_SPEED;
513 static const HouseCallbackMask cbm_animation_next_frame = CBM_HOUSE_ANIMATION_NEXT_FRAME;
514 };
515
516 void AnimateNewHouseTile(TileIndex tile)
517 {
518 const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
519 if (hs == NULL) return;
520
521 HouseAnimationBase::AnimateTile(hs, Town::GetByTile(tile), tile, HasBit(hs->extra_flags, CALLBACK_1A_RANDOM_BITS));
522 }
523
524 void AnimateNewHouseConstruction(TileIndex tile)
525 {
526 const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
527
528 if (HasBit(hs->callback_mask, CBM_HOUSE_CONSTRUCTION_STATE_CHANGE)) {
529 HouseAnimationBase::ChangeAnimationFrame(CBID_HOUSE_CONSTRUCTION_STATE_CHANGE, hs, Town::GetByTile(tile), tile, 0, 0);
530 }
531 }
532
533 bool CanDeleteHouse(TileIndex tile)
534 {
535 const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
536
537 /* Humans are always allowed to remove buildings, as is water and disasters and
538 * anyone using the scenario editor. */
539 if (Company::IsValidHumanID(_current_company) || _current_company == OWNER_WATER || _current_company == OWNER_NONE || _game_mode == GM_EDITOR || _generating_world) {
540 return true;
541 }
542
543 if (HasBit(hs->callback_mask, CBM_HOUSE_DENY_DESTRUCTION)) {
544 uint16 callback_res = GetHouseCallback(CBID_HOUSE_DENY_DESTRUCTION, 0, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
545 return (callback_res == CALLBACK_FAILED || !ConvertBooleanCallback(hs->grf_prop.grffile, CBID_HOUSE_DENY_DESTRUCTION, callback_res));
546 } else {
547 return !(hs->extra_flags & BUILDING_IS_PROTECTED);
548 }
549 }
550
551 static void AnimationControl(TileIndex tile, uint16 random_bits)
552 {
553 const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
554
555 if (HasBit(hs->callback_mask, CBM_HOUSE_ANIMATION_START_STOP)) {
556 uint32 param = (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) ? (GB(Random(), 0, 16) | random_bits << 16) : Random();
557 HouseAnimationBase::ChangeAnimationFrame(CBID_HOUSE_ANIMATION_START_STOP, hs, Town::GetByTile(tile), tile, param, 0);
558 }
559 }
560
561 bool NewHouseTileLoop(TileIndex tile)
562 {
563 const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
564
565 if (GetHouseProcessingTime(tile) > 0) {
566 DecHouseProcessingTime(tile);
567 return true;
568 }
569
570 TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP);
571 if (hs->building_flags & BUILDING_HAS_1_TILE) TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP_TOP);
572
573 if (HasBit(hs->callback_mask, CBM_HOUSE_ANIMATION_START_STOP)) {
574 /* If this house is marked as having a synchronised callback, all the
575 * tiles will have the callback called at once, rather than when the
576 * tile loop reaches them. This should only be enabled for the northern
577 * tile, or strange things will happen (here, and in TTDPatch). */
578 if (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) {
579 uint16 random = GB(Random(), 0, 16);
580
581 if (hs->building_flags & BUILDING_HAS_1_TILE) AnimationControl(tile, random);
582 if (hs->building_flags & BUILDING_2_TILES_Y) AnimationControl(TILE_ADDXY(tile, 0, 1), random);
583 if (hs->building_flags & BUILDING_2_TILES_X) AnimationControl(TILE_ADDXY(tile, 1, 0), random);
584 if (hs->building_flags & BUILDING_HAS_4_TILES) AnimationControl(TILE_ADDXY(tile, 1, 1), random);
585 } else {
586 AnimationControl(tile, 0);
587 }
588 }
589
590 /* Check callback 21, which determines if a house should be destroyed. */
591 if (HasBit(hs->callback_mask, CBM_HOUSE_DESTRUCTION)) {
592 uint16 callback_res = GetHouseCallback(CBID_HOUSE_DESTRUCTION, 0, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
593 if (callback_res != CALLBACK_FAILED && Convert8bitBooleanCallback(hs->grf_prop.grffile, CBID_HOUSE_DESTRUCTION, callback_res)) {
594 ClearTownHouse(Town::GetByTile(tile), tile);
595 return false;
596 }
597 }
598
599 SetHouseProcessingTime(tile, hs->processing_time);
600 MarkTileDirtyByTile(tile);
601 return true;
602 }
603
604 static void DoTriggerHouse(TileIndex tile, HouseTrigger trigger, byte base_random, bool first)
605 {
606 /* We can't trigger a non-existent building... */
607 assert(IsTileType(tile, MP_HOUSE));
608
609 HouseID hid = GetHouseType(tile);
610 HouseSpec *hs = HouseSpec::Get(hid);
611
612 if (hs->grf_prop.spritegroup[0] == NULL) return;
613
614 HouseResolverObject object(hid, tile, Town::GetByTile(tile), CBID_RANDOM_TRIGGER);
615 object.trigger = trigger;
616
617 const SpriteGroup *group = object.Resolve();
618 if (group == NULL) return;
619
620 byte new_random_bits = Random();
621 byte random_bits = GetHouseRandomBits(tile);
622 uint32 reseed = object.GetReseedSum(); // The scope only affects triggers, not the reseeding
623 random_bits &= ~reseed;
624 random_bits |= (first ? new_random_bits : base_random) & reseed;
625 SetHouseRandomBits(tile, random_bits);
626
627 switch (trigger) {
628 case HOUSE_TRIGGER_TILE_LOOP:
629 /* Random value already set. */
630 break;
631
632 case HOUSE_TRIGGER_TILE_LOOP_TOP:
633 if (!first) {
634 /* The top tile is marked dirty by the usual TileLoop */
635 MarkTileDirtyByTile(tile);
636 break;
637 }
638 /* Random value of first tile already set. */
639 if (hs->building_flags & BUILDING_2_TILES_Y) DoTriggerHouse(TILE_ADDXY(tile, 0, 1), trigger, random_bits, false);
640 if (hs->building_flags & BUILDING_2_TILES_X) DoTriggerHouse(TILE_ADDXY(tile, 1, 0), trigger, random_bits, false);
641 if (hs->building_flags & BUILDING_HAS_4_TILES) DoTriggerHouse(TILE_ADDXY(tile, 1, 1), trigger, random_bits, false);
642 break;
643 }
644 }
645
646 void TriggerHouse(TileIndex t, HouseTrigger trigger)
647 {
648 DoTriggerHouse(t, trigger, 0, true);
649 }
650
658 void DoWatchedCargoCallback(TileIndex tile, TileIndex origin, uint32 trigger_cargoes, uint16 random)
659 {
660 TileIndexDiffC diff = TileIndexToTileIndexDiffC(origin, tile);
661 uint32 cb_info = random << 16 | (uint8)diff.y << 8 | (uint8)diff.x;
662 HouseAnimationBase::ChangeAnimationFrame(CBID_HOUSE_WATCHED_CARGO_ACCEPTED, HouseSpec::Get(GetHouseType(tile)), Town::GetByTile(tile), tile, 0, cb_info, trigger_cargoes);
663 }
664
671 void WatchedCargoCallback(TileIndex tile, uint32 trigger_cargoes)
672 {
673 assert(IsTileType(tile, MP_HOUSE));
674 HouseID id = GetHouseType(tile);
675 const HouseSpec *hs = HouseSpec::Get(id);
676
677 trigger_cargoes &= hs->watched_cargoes;
678 /* None of the trigger cargoes is watched? */
679 if (trigger_cargoes == 0) return;
680
681 /* Same random value for all tiles of a multi-tile house. */
682 uint16 r = Random();
683
684 /* Do the callback, start at northern tile. */
685 TileIndex north = tile + GetHouseNorthPart(id);
686 hs = HouseSpec::Get(id);
687
688 DoWatchedCargoCallback(north, tile, trigger_cargoes, r);
689 if (hs->building_flags & BUILDING_2_TILES_Y) DoWatchedCargoCallback(TILE_ADDXY(north, 0, 1), tile, trigger_cargoes, r);
690 if (hs->building_flags & BUILDING_2_TILES_X) DoWatchedCargoCallback(TILE_ADDXY(north, 1, 0), tile, trigger_cargoes, r);
691 if (hs->building_flags & BUILDING_HAS_4_TILES) DoWatchedCargoCallback(TILE_ADDXY(north, 1, 1), tile, trigger_cargoes, r);
692 }
693