CanalResolverObject Struct Reference

Resolver object for canals. More...

Inheritance diagram for CanalResolverObject:

Public Member Functions
	CanalResolverObject (CanalFeature feature, TileIndex tile, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
	Canal resolver constructor.
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
CanalScopeResolver	canal_scope
CanalFeature	feature
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 for canals.

Definition at line 37 of file newgrf_canal.cpp.

Constructor & Destructor Documentation

CanalResolverObject()

CanalResolverObject::CanalResolverObject	(	CanalFeature	feature,
		TileIndex	tile,
		CallbackID	callback = CBID_NO_CALLBACK,
		uint32_t	callback_param1 = 0,
		uint32_t	callback_param2 = 0
	)

Canal resolver constructor.

Parameters

feature	Which canal feature we want.
tile	Tile index of canal.
callback	Callback ID.
callback_param1	First parameter (var 10) of the callback.
callback_param2	Second parameter (var 18) of the callback.

Definition at line 127 of file newgrf_canal.cpp.

References _water_feature, and ResolverObject::root_spritegroup.

Member Function Documentation

GetDebugID()

uint32_t CanalResolverObject::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 114 of file newgrf_canal.cpp.

GetFeature()

GrfSpecFeature CanalResolverObject::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 109 of file newgrf_canal.cpp.

GetScope()

ScopeResolver * CanalResolverObject::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 44 of file newgrf_canal.cpp.

References ResolverObject::GetScope(), and VSG_SCOPE_SELF.

Field Documentation

canal_scope

CanalScopeResolver CanalResolverObject::canal_scope

Definition at line 38 of file newgrf_canal.cpp.

feature

CanalFeature CanalResolverObject::feature

Definition at line 39 of file newgrf_canal.cpp.

---

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

• src/newgrf_canal.cpp