ObjectResolverObject Struct Reference

A resolver object to be used with feature 0F spritegroups. More...

#include <newgrf_object.h>

Inheritance diagram for ObjectResolverObject:

Public Member Functions
	ObjectResolverObject (const ObjectSpec *spec, Object *o, TileIndex tile, uint8_t view=0, CallbackID callback=CBID_NO_CALLBACK, uint32_t param1=0, uint32_t param2=0)
	Constructor of the object resolver.
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 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
ObjectScopeResolver	object_scope
	The object scope resolver.
std::optional< TownScopeResolver >	town_scope = std::nullopt
	The town scope resolver (created on the first call).
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.

Private Member Functions
TownScopeResolver *	GetTown ()
	Get the town resolver scope that belongs to this object resolver.

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

A resolver object to be used with feature 0F spritegroups.

Definition at line 134 of file newgrf_object.h.

Constructor & Destructor Documentation

ObjectResolverObject()

ObjectResolverObject::ObjectResolverObject	(	const ObjectSpec *	spec,
		Object *	obj,
		TileIndex	tile,
		uint8_t	view = 0,
		CallbackID	callback = CBID_NO_CALLBACK,
		uint32_t	param1 = 0,
		uint32_t	param2 = 0
	)

Constructor of the object resolver.

Parameters

obj	Object being resolved.
tile	Tile of the object.
view	View of the object.
callback	Callback ID.
param1	First parameter (var 10) of the callback.
param2	Second parameter (var 18) of the callback.

Definition at line 386 of file newgrf_object.cpp.

References StandardGRFFileProps::GetSpriteGroup(), ObjectSpec::grf_prop, and ResolverObject::root_spritegroup.

Member Function Documentation

GetDebugID()

uint32_t ObjectResolverObject::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 418 of file newgrf_object.cpp.

References ObjectSpec::grf_prop, GRFFilePropsBase::local_id, object_scope, and ObjectScopeResolver::spec.

GetFeature()

GrfSpecFeature ObjectResolverObject::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 413 of file newgrf_object.cpp.

GetScope()

ScopeResolver * ObjectResolverObject::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 141 of file newgrf_object.h.

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

Referenced by NIHObject::Resolve().

GetTown()

TownScopeResolver * ObjectResolverObject::GetTown ( )

private

Get the town resolver scope that belongs to this object resolver.

On the first call, the town scope is created (if possible).

Returns

Town scope, if available.

Definition at line 398 of file newgrf_object.cpp.

References ClosestTownFromTile(), ObjectScopeResolver::obj, object_scope, ObjectScopeResolver::tile, Object::town, and town_scope.

Referenced by GetScope().

Field Documentation

object_scope

ObjectScopeResolver ObjectResolverObject::object_scope

The object scope resolver.

Definition at line 135 of file newgrf_object.h.

Referenced by GetDebugID(), GetScope(), and GetTown().

town_scope

std::optional<TownScopeResolver> ObjectResolverObject::town_scope = std::nullopt

The town scope resolver (created on the first call).

Definition at line 136 of file newgrf_object.h.

Referenced by GetTown().

---

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

• src/newgrf_object.h
• src/newgrf_object.cpp