HouseResolverObject Struct Reference

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

#include <newgrf_house.h>

Inheritance diagram for HouseResolverObject:

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.
ScopeResolver *	GetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
	Get a resolver for the scope.
GrfSpecFeature	GetFeature () const override
	Get the feature number being resolved for.
uint32_t	GetDebugID () const override
	Get an identifier for the item being resolved.
Public Member Functions inherited from SpecializedResolverObject< HouseRandomTriggers >
void	SetWaitingRandomTriggers (HouseRandomTriggers triggers)
	Set waiting triggers for rerandomisation.
HouseRandomTriggers	GetUsedRandomTriggers () const
	Get the triggers, which were "consumed" by some rerandomisation.
	ResolverObject (const GRFFile *grffile, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
	Resolver constructor.
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.
ResolverResult	DoResolve ()
int32_t	GetRegister (uint i) const
	Gets the value of a so-called newgrf "register".
void	SetRegister (uint i, int32_t value)
	Sets the value of a so-called newgrf "register".
template<class TSpriteGroup >
const TSpriteGroup *	Resolve ()
	Resolve SpriteGroup.
void	ResolveRerandomisation ()
	Resolve bits to be rerandomised.
CallbackResult	ResolveCallback (std::span< int32_t > regs100)
	Resolve callback.
virtual const SpriteGroup *	ResolveReal (const RealSpriteGroup &group) const
	Get the real sprites of the grf.
uint32_t	GetWaitingRandomTriggers () const
	Used by RandomizedSpriteGroup: Triggers for rerandomisation.
void	AddUsedRandomTriggers (uint32_t triggers)
	Used by RandomizedSpriteGroup: Consume triggers.
uint32_t	GetReseedSum () const
	Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with.

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 = 0
	First parameter (var 10) of the callback.
uint32_t	callback_param2 = 0
	Second parameter (var 18) of the callback.
uint32_t	last_value = 0
	Result of most recent DeterministicSpriteGroup (including procedure calls)
std::array< uint32_t, VSG_END >	reseed
	Collects bits to rerandomise while triggering triggers.
const GRFFile *	grffile = nullptr
	GRFFile the resolved SpriteGroup belongs to.
const SpriteGroup *	root_spritegroup = nullptr
	Root SpriteGroup to use for resolving.

Additional Inherited Members
Protected Attributes inherited from ResolverObject
uint32_t	waiting_random_triggers = 0
	Waiting triggers to be used by any rerandomisation. (scope independent)
uint32_t	used_random_triggers = 0
	Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent)

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_id	House to query.
tile	Tile containing the house.
town	Town containing the house.
callback	Callback ID.
param1	First parameter (var 10) of the callback.
param2	Second parameter (var 18) of the callback.
not_yet_constructed	House is still under construction.
initial_random_bits	Random bits during construction checks.
watched_cargo_triggers	Cargo types that triggered the watched cargo callback.

Definition at line 107 of file newgrf_house.cpp.

References HouseSpec::Get(), StandardGRFFileProps::GetSpriteGroup(), HouseSpec::grf_prop, INVALID_TILE, IsTileType(), IsValidTile(), MP_HOUSE, and ResolverObject::root_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 125 of file newgrf_house.cpp.

References HouseSpec::Get(), HouseSpec::grf_prop, HouseScopeResolver::house_id, and GRFFilePropsBase::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 120 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().

Field Documentation

house_scope

HouseScopeResolver HouseResolverObject::house_scope

Definition at line 53 of file newgrf_house.h.

town_scope

TownScopeResolver HouseResolverObject::town_scope

Definition at line 54 of file newgrf_house.h.

---

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

• src/newgrf_house.h
• src/newgrf_house.cpp