| OpenTTD
    | 
Implementation of NewGRF houses. More...
#include "stdafx.h"#include "debug.h"#include "landscape.h"#include "newgrf_house.h"#include "newgrf_spritegroup.h"#include "newgrf_town.h"#include "newgrf_sound.h"#include "company_func.h"#include "company_base.h"#include "town.h"#include "genworld.h"#include "newgrf_animation_base.h"#include "newgrf_cargo.h"#include "station_base.h"#include "safeguards.h"Go to the source code of this file.
| Data Structures | |
| struct | SearchNearbyHouseData | 
| Structure with user-data for SearchNearbyHouseXXX - functions.  More... | |
| struct | HouseAnimationBase | 
| Helper class for animation control.  More... | |
| Functions | |
| static const GRFFile * | GetHouseSpecGrf (HouseID house_id) | 
| Retrieve the grf file associated with a house. | |
| HouseClassID | AllocateHouseClassID (byte grf_class_id, uint32 grfid) | 
| void | InitializeBuildingCounts () | 
| void | IncreaseBuildingCount (Town *t, HouseID house_id) | 
| IncreaseBuildingCount() Increase the count of a building when it has been added by a town. | |
| void | DecreaseBuildingCount (Town *t, HouseID house_id) | 
| DecreaseBuildingCount() Decrease the number of a building when it is deleted. | |
| static uint32 | GetNumHouses (HouseID house_id, const Town *town) | 
| static uint32 | GetNearbyTileInformation (byte parameter, TileIndex tile, bool grf_version8) | 
| Get information about a nearby tile. | |
| static bool | SearchNearbyHouseID (TileIndex tile, void *user_data) | 
| Callback function to search a house by its HouseID. | |
| static bool | SearchNearbyHouseClass (TileIndex tile, void *user_data) | 
| Callback function to search a house by its classID. | |
| static bool | SearchNearbyHouseGRFID (TileIndex tile, void *user_data) | 
| Callback function to search a house by its grfID. | |
| static uint32 | GetDistanceFromNearbyHouse (uint8 parameter, TileIndex tile, HouseID house) | 
| This function will activate a search around a central tile, looking for some houses that fit the requested characteristics. | |
| uint16 | GetHouseCallback (CallbackID callback, uint32 param1, uint32 param2, HouseID house_id, Town *town, TileIndex tile, bool not_yet_constructed, uint8 initial_random_bits, uint32 watched_cargo_triggers) | 
| static void | DrawTileLayout (const TileInfo *ti, const TileLayoutSpriteGroup *group, byte stage, HouseID house_id) | 
| void | DrawNewHouseTile (TileInfo *ti, HouseID house_id) | 
| uint16 | GetSimpleHouseCallback (CallbackID callback, uint32 param1, uint32 param2, const HouseSpec *spec, Town *town, TileIndex tile, uint32 extra_data) | 
| void | AnimateNewHouseTile (TileIndex tile) | 
| void | AnimateNewHouseConstruction (TileIndex tile) | 
| bool | CanDeleteHouse (TileIndex tile) | 
| static void | AnimationControl (TileIndex tile, uint16 random_bits) | 
| bool | NewHouseTileLoop (TileIndex tile) | 
| static void | DoTriggerHouse (TileIndex tile, HouseTrigger trigger, byte base_random, bool first) | 
| void | TriggerHouse (TileIndex t, HouseTrigger trigger) | 
| void | DoWatchedCargoCallback (TileIndex tile, TileIndex origin, uint32 trigger_cargoes, uint16 random) | 
| Run the watched cargo accepted callback for a single house tile. | |
| void | WatchedCargoCallback (TileIndex tile, uint32 trigger_cargoes) | 
| Run watched cargo accepted callback for a house. | |
| Variables | |
| static BuildingCounts< uint32 > | _building_counts | 
| static HouseClassMapping | _class_mapping [HOUSE_CLASS_MAX] | 
| HouseOverrideManager | _house_mngr (NEW_HOUSE_OFFSET, NUM_HOUSES, INVALID_HOUSE_ID) | 
Implementation of NewGRF houses.
Definition in file newgrf_house.cpp.
DecreaseBuildingCount() Decrease the number of a building when it is deleted.
| t | The town that the building was built in | 
| house_id | The id of the house being removed | 
Definition at line 143 of file newgrf_house.cpp.
References _loaded_newgrf_features, TownCache::building_counts, Town::cache, HouseSpec::class_id, and GRFLoadedFeatures::has_newhouses.
Referenced by DoClearTownHouseHelper().
| void DoWatchedCargoCallback | ( | TileIndex | tile, | 
| TileIndex | origin, | ||
| uint32 | trigger_cargoes, | ||
| uint16 | random | ||
| ) | 
Run the watched cargo accepted callback for a single house tile.
| tile | The house tile. | 
| origin | The triggering tile. | 
| trigger_cargoes | Cargo types that triggered the callback. | 
| random | Random bits. | 
Definition at line 659 of file newgrf_house.cpp.
References CBID_HOUSE_WATCHED_CARGO_ACCEPTED, AnimationBase< HouseAnimationBase, HouseSpec, Town, uint32, GetSimpleHouseCallback >::ChangeAnimationFrame(), GetHouseType(), TileIndexToTileIndexDiffC(), TileIndexDiffC::x, and TileIndexDiffC::y.
Referenced by WatchedCargoCallback().
This function will activate a search around a central tile, looking for some houses that fit the requested characteristics.
| parameter | that is given by the callback. bits 0..6 radius of the search bits 7..8 search type i.e.: 0 = houseID/ 1 = classID/ 2 = grfID | 
| tile | TileIndex from which to start the search | 
| house | the HouseID that is associated to the house, the callback is called for | 
Definition at line 291 of file newgrf_house.cpp.
References CircularTileSearch(), DistanceManhattan(), GB(), GetHouseNorthPart(), SearchNearbyHouseData::hs, lengthof, SearchNearbyHouseData::north_tile, SearchNearbyHouseClass(), SearchNearbyHouseGRFID(), and SearchNearbyHouseID().
Referenced by HouseScopeResolver::GetVariable().
Retrieve the grf file associated with a house.
| house_id | House to query. | 
NULL). Definition at line 61 of file newgrf_house.cpp.
References HouseSpec::grf_prop, and GRFFilePropsBase< Tcnt >::grffile.
| 
 | static | 
Get information about a nearby tile.
| parameter | from callback. It's in fact a pair of coordinates | 
| tile | TileIndex from which the callback was initiated | 
| grf_version8 | True, if we are dealing with a new NewGRF which uses GRF version >= 8. | 
Definition at line 198 of file newgrf_house.cpp.
References GetNearbyTile(), and GetNearbyTileInformation().
IncreaseBuildingCount() Increase the count of a building when it has been added by a town.
| t | The town that the building is being built in | 
| house_id | The id of the house being added | 
Definition at line 122 of file newgrf_house.cpp.
References _loaded_newgrf_features, TownCache::building_counts, Town::cache, HouseSpec::class_id, and GRFLoadedFeatures::has_newhouses.
Referenced by ClearMakeHouseTile(), and RebuildTownCaches().
| 
 | static | 
Callback function to search a house by its classID.
| tile | TileIndex to be examined | 
| user_data | SearchNearbyHouseData | 
Definition at line 240 of file newgrf_house.cpp.
References HouseSpec::class_id, GetHouseNorthPart(), GetHouseType(), HouseSpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, SearchNearbyHouseData::hs, IsTileType(), MP_HOUSE, and SearchNearbyHouseData::north_tile.
Referenced by GetDistanceFromNearbyHouse().
| 
 | static | 
Callback function to search a house by its grfID.
| tile | TileIndex to be examined | 
| user_data | SearchNearbyHouseData | 
Definition at line 264 of file newgrf_house.cpp.
References GetHouseNorthPart(), GetHouseType(), HouseSpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, SearchNearbyHouseData::hs, IsTileType(), MP_HOUSE, and SearchNearbyHouseData::north_tile.
Referenced by GetDistanceFromNearbyHouse().
| 
 | static | 
Callback function to search a house by its HouseID.
| tile | TileIndex to be examined | 
| user_data | SearchNearbyHouseData | 
Definition at line 216 of file newgrf_house.cpp.
References GetHouseNorthPart(), GetHouseType(), HouseSpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, SearchNearbyHouseData::hs, IsTileType(), GRFFilePropsBase< Tcnt >::local_id, MP_HOUSE, and SearchNearbyHouseData::north_tile.
Referenced by GetDistanceFromNearbyHouse().
| void WatchedCargoCallback | ( | TileIndex | tile, | 
| uint32 | trigger_cargoes | ||
| ) | 
Run watched cargo accepted callback for a house.
| tile | House tile. | 
| trigger_cargoes | Triggering cargo types. | 
Definition at line 672 of file newgrf_house.cpp.
References HouseSpec::building_flags, DoWatchedCargoCallback(), GetHouseNorthPart(), GetHouseType(), IsTileType(), MP_HOUSE, TILE_ADDXY, and HouseSpec::watched_cargoes.
Referenced by TriggerWatchedCargoCallbacks().
 1.8.1.2
 1.8.1.2