RoadTypeResolverObject Struct Reference

Resolver object for road types. More...

#include <newgrf_roadtype.h>

Inheritance diagram for RoadTypeResolverObject:

Public Member Functions
	RoadTypeResolverObject (const RoadTypeInfo *rti, TileIndex tile, TileContext context, RoadTypeSpriteGroup rtsg, uint32_t param1=0, uint32_t param2=0)
	Resolver object for road types.
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
RoadTypeScopeResolver	roadtype_scope
	Resolver for the roadtype 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 for road types.

Definition at line 40 of file newgrf_roadtype.h.

Constructor & Destructor Documentation

RoadTypeResolverObject()

RoadTypeResolverObject::RoadTypeResolverObject	(	const RoadTypeInfo *	rti,
		TileIndex	tile,
		TileContext	context,
		RoadTypeSpriteGroup	rtsg,
		uint32_t	param1 = 0,
		uint32_t	param2 = 0
	)

Resolver object for road types.

Parameters

rti	Roadtype. nullptr in NewGRF Inspect window.
tile	Tile containing the track. For track on a bridge this is the southern bridgehead.
context	Are we resolving sprites for the upper halftile, or on a bridge?
rtsg	Roadpart of interest
param1	Extra parameter (first parameter of the callback, except roadtypes do not have callbacks).
param2	Extra parameter (second parameter of the callback, except roadtypes do not have callbacks).

Definition at line 134 of file newgrf_roadtype.cpp.

References RoadTypeInfo::group, and ResolverObject::root_spritegroup.

Member Function Documentation

GetDebugID()

uint32_t RoadTypeResolverObject::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 120 of file newgrf_roadtype.cpp.

References RoadTypeInfo::label, and roadtype_scope.

GetFeature()

GrfSpecFeature RoadTypeResolverObject::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 110 of file newgrf_roadtype.cpp.

References GetRoadTypeByLabel(), GSF_INVALID, RoadTypeInfo::label, and roadtype_scope.

GetScope()

ScopeResolver * RoadTypeResolverObject::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 45 of file newgrf_roadtype.h.

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

Referenced by NIHRoadType< TRoadTramType >::Resolve().

Field Documentation

roadtype_scope

RoadTypeScopeResolver RoadTypeResolverObject::roadtype_scope

Resolver for the roadtype scope.

Definition at line 41 of file newgrf_roadtype.h.

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

---

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

• src/newgrf_roadtype.h
• src/newgrf_roadtype.cpp