SpriteGroup Struct Reference

Common wrapper for all the different sprite group types. More...

#include <newgrf_spritegroup.h>

Inheritance diagram for SpriteGroup:

Public Member Functions
virtual	~SpriteGroup ()=default
	Ensure the destructor of the sub classes are called as well.

Static Public Member Functions
static ResolverResult	Resolve (const SpriteGroup *group, ResolverObject &object, bool top_level=true)
	ResolverObject (re)entry point.

Data Fields
uint32_t	nfo_line = 0

Protected Member Functions
	SpriteGroup (SpriteGroupID index)
	Create the SpriteGroup.
virtual ResolverResult	Resolve (ResolverObject &object) const =0
	Resolves a callback or rerandomisation callback to a NewGRF.

Detailed Description

Common wrapper for all the different sprite group types.

Definition at line 47 of file newgrf_spritegroup.h.

Constructor & Destructor Documentation

SpriteGroup()

SpriteGroup::SpriteGroup ( SpriteGroupID index )

inlineprotected

Create the SpriteGroup.

Parameters

index

Index of the sprite group within the pool.

Definition at line 53 of file newgrf_spritegroup.h.

Referenced by Resolve(), SpecializedSpriteGroup< T >::SpecializedSpriteGroup(), and ~SpriteGroup().

Member Function Documentation

Resolve() [1/2]

ResolverResult SpriteGroup::Resolve ( const SpriteGroup * group, ResolverObject & object, bool top_level = true )

static

ResolverObject (re)entry point.

This cannot be made a call to a virtual function because virtual functions do not like nullptr and checking for nullptr everywhere is more cumbersome than this little helper function.

Parameters

group	the group to resolve for
object	information needed to resolve the group
top_level	true if this is a top-level SpriteGroup, false if used nested in another SpriteGroup.

Returns

the resolved group

Definition at line 34 of file newgrf_spritegroup.cpp.

References NewGRFProfiler::grffile, Resolve(), and SpriteGroup().

Resolve() [2/2]

virtual ResolverResult SpriteGroup::Resolve ( ResolverObject & object ) const

protectedpure virtual

Resolves a callback or rerandomisation callback to a NewGRF.

Parameters

object

Information needed to resolve the group.

Returns

The result of resolving this SpriteGroup.

Implemented in CallbackResultSpriteGroup, DeterministicSpriteGroup, IndustryProductionSpriteGroup, RandomizedSpriteGroup, RealSpriteGroup, ResultSpriteGroup, and TileLayoutSpriteGroup.

Referenced by DeterministicSpriteGroup::Resolve(), RandomizedSpriteGroup::Resolve(), RealSpriteGroup::Resolve(), Resolve(), and ResolverObject::~ResolverObject().

Field Documentation

nfo_line

uint32_t SpriteGroup::nfo_line = 0

Definition at line 65 of file newgrf_spritegroup.h.

---

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

• src/newgrf_spritegroup.h
• src/newgrf_spritegroup.cpp