OpenTTD Source  20241109-master-g5e4f8db7d6
HouseResolverObject Struct Reference

Resolver object to be used for houses (feature 07 spritegroups). More...

#include <newgrf_house.h>

Inheritance diagram for HouseResolverObject:
ResolverObject

Public Member Functions

 HouseResolverObject (HouseID house_id, TileIndex tile, Town *town, CallbackID callback=CBID_NO_CALLBACK, uint32_t param1=0, uint32_t param2=0, bool not_yet_constructed=false, uint8_t initial_random_bits=0, CargoTypes watched_cargo_triggers=0, int view=0)
 Construct a resolver for a house. More...
 
ScopeResolverGetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
 Get a resolver for the scope. More...
 
GrfSpecFeature GetFeature () const override
 Get the feature number being resolved for. More...
 
uint32_t GetDebugID () const override
 Get an identifier for the item being resolved. More...
 
- Public Member Functions inherited from ResolverObject
 ResolverObject (const GRFFile *grffile, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
 Resolver constructor. More...
 
const SpriteGroupResolve ()
 Resolve SpriteGroup. More...
 
uint16_t ResolveCallback ()
 Resolve callback. More...
 
virtual const SpriteGroupResolveReal (const RealSpriteGroup *group) const
 Get the real sprites of the grf. More...
 
uint32_t GetRemainingTriggers () const
 Returns the waiting triggers that did not trigger any rerandomisation.
 
uint32_t GetReseedSum () const
 Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with. More...
 
void ResetState ()
 Resets the dynamic state of the resolver object. More...
 

Data Fields

HouseScopeResolver house_scope
 
TownScopeResolver town_scope
 
- Data Fields inherited from ResolverObject
ScopeResolver default_scope
 Default implementation of the grf scope.
 
CallbackID callback
 Callback being resolved.
 
uint32_t callback_param1
 First parameter (var 10) of the callback.
 
uint32_t callback_param2
 Second parameter (var 18) of the callback.
 
uint32_t last_value
 Result of most recent DeterministicSpriteGroup (including procedure calls)
 
uint32_t waiting_triggers
 Waiting triggers to be used by any rerandomisation. (scope independent)
 
uint32_t used_triggers
 Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent)
 
uint32_t reseed [VSG_END]
 Collects bits to rerandomise while triggering triggers.
 
const GRFFilegrffile
 GRFFile the resolved SpriteGroup belongs to.
 
const SpriteGrouproot_spritegroup
 Root SpriteGroup to use for resolving.
 

Detailed Description

Resolver object to be used for houses (feature 07 spritegroups).

Definition at line 52 of file newgrf_house.h.

Constructor & Destructor Documentation

◆ HouseResolverObject()

HouseResolverObject::HouseResolverObject ( HouseID  house_id,
TileIndex  tile,
Town town,
CallbackID  callback = CBID_NO_CALLBACK,
uint32_t  param1 = 0,
uint32_t  param2 = 0,
bool  not_yet_constructed = false,
uint8_t  initial_random_bits = 0,
CargoTypes  watched_cargo_triggers = 0,
int  view = 0 
)

Construct a resolver for a house.

Parameters
house_idHouse to query.
tileTile containing the house.
townTown containing the house.
callbackCallback ID.
param1First parameter (var 10) of the callback.
param2Second parameter (var 18) of the callback.
not_yet_constructedHouse is still under construction.
initial_random_bitsRandom bits during construction checks.
watched_cargo_triggersCargo types that triggered the watched cargo callback.

Definition at line 106 of file newgrf_house.cpp.

References HouseSpec::Get(), HouseSpec::grf_prop, INVALID_TILE, IsTileType(), IsValidTile(), MP_HOUSE, ResolverObject::root_spritegroup, and GRFFilePropsBase< Tcnt >::spritegroup.

Member Function Documentation

◆ GetDebugID()

uint32_t HouseResolverObject::GetDebugID ( ) const
overridevirtual

Get an identifier for the item being resolved.

This function is mainly intended for the callback profiling feature, and should return an identifier recognisable by the NewGRF developer.

Reimplemented from ResolverObject.

Definition at line 124 of file newgrf_house.cpp.

References HouseSpec::Get(), HouseSpec::grf_prop, HouseScopeResolver::house_id, and GRFFilePropsBase< Tcnt >::local_id.

◆ GetFeature()

GrfSpecFeature HouseResolverObject::GetFeature ( ) const
overridevirtual

Get the feature number being resolved for.

This function is mainly intended for the callback profiling feature.

Reimplemented from ResolverObject.

Definition at line 119 of file newgrf_house.cpp.

◆ GetScope()

ScopeResolver* HouseResolverObject::GetScope ( VarSpriteGroupScope  scope = VSG_SCOPE_SELF,
uint8_t  relative = 0 
)
inlineoverridevirtual

Get a resolver for the scope.

Returns
The resolver for the requested scope.

Reimplemented from ResolverObject.

Definition at line 60 of file newgrf_house.h.

References ResolverObject::GetScope(), VSG_SCOPE_PARENT, and VSG_SCOPE_SELF.

Referenced by NIHHouse::Resolve().


The documentation for this struct was generated from the following files: