OpenTTD
Data Structures | Enumerations | Functions
newgrf_house.h File Reference

Functions related to NewGRF houses. More...

#include "newgrf_callbacks.h"
#include "tile_cmd.h"
#include "house_type.h"
#include "newgrf_spritegroup.h"
#include "newgrf_town.h"

Go to the source code of this file.

Data Structures

struct  HouseScopeResolver
 Scope resolver for houses. More...
 
struct  HouseResolverObject
 Resolver object to be used for houses (feature 07 spritegroups). More...
 
struct  HouseClassMapping
 Makes class IDs unique to each GRF file. More...
 

Enumerations

enum  HouseTrigger { HOUSE_TRIGGER_TILE_LOOP = 0x01, HOUSE_TRIGGER_TILE_LOOP_TOP = 0x02 }
 

Functions

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. More...
 
void DecreaseBuildingCount (Town *t, HouseID house_id)
 DecreaseBuildingCount() Decrease the number of a building when it is deleted. More...
 
void DrawNewHouseTile (TileInfo *ti, HouseID house_id)
 
void AnimateNewHouseTile (TileIndex tile)
 
void AnimateNewHouseConstruction (TileIndex tile)
 
uint16 GetHouseCallback (CallbackID callback, uint32 param1, uint32 param2, HouseID house_id, Town *town, TileIndex tile, bool not_yet_constructed=false, uint8 initial_random_bits=0, uint32 watched_cargo_triggers=0)
 
void WatchedCargoCallback (TileIndex tile, uint32 trigger_cargoes)
 Run watched cargo accepted callback for a house. More...
 
bool CanDeleteHouse (TileIndex tile)
 
bool NewHouseTileLoop (TileIndex tile)
 
void TriggerHouse (TileIndex t, HouseTrigger trigger)
 

Detailed Description

Functions related to NewGRF houses.

Definition in file newgrf_house.h.

Function Documentation

◆ DecreaseBuildingCount()

void DecreaseBuildingCount ( Town t,
HouseID  house_id 
)

DecreaseBuildingCount() Decrease the number of a building when it is deleted.

Parameters
tThe town that the building was built in
house_idThe id of the house being removed

Definition at line 121 of file newgrf_house.cpp.

References _loaded_newgrf_features, TownCache::building_counts, Town::cache, HouseSpec::class_id, and GRFLoadedFeatures::has_newhouses.

◆ IncreaseBuildingCount()

void IncreaseBuildingCount ( Town t,
HouseID  house_id 
)

IncreaseBuildingCount() Increase the count of a building when it has been added by a town.

Parameters
tThe town that the building is being built in
house_idThe id of the house being added

Definition at line 100 of file newgrf_house.cpp.

References _loaded_newgrf_features, TownCache::building_counts, Town::cache, HouseSpec::class_id, and GRFLoadedFeatures::has_newhouses.

◆ WatchedCargoCallback()

void WatchedCargoCallback ( TileIndex  tile,
uint32  trigger_cargoes 
)

Run watched cargo accepted callback for a house.

Parameters
tileHouse tile.
trigger_cargoesTriggering cargo types.
Precondition
IsTileType(t, MP_HOUSE)

Definition at line 649 of file newgrf_house.cpp.

Referenced by TriggerWatchedCargoCallbacks().