Inheritance diagram for ResultSpriteGroup:

Public Member Functions
	ResultSpriteGroup (SpriteGroupID index, SpriteID sprite, uint8_t num_sprites)
	Creates a spritegroup representing a sprite number result.

Public Member Functions inherited from SpecializedSpriteGroup< ResultSpriteGroup >
	SpecializedSpriteGroup (SpriteGroupID index)

Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_spritegroup_pool >
	PoolItem (Tindex index)
	Construct the item.

void *	operator new (size_t)=delete
	Do not use new PoolItem, but rather PoolItem::Create.

void *	operator new (size_t size, Tindex index)=delete
	Do not use new (index) PoolItem(...), but rather PoolItem::CreateAtIndex(index, ...).

void *	operator new (size_t, void *ptr)=delete
	Do not use new (address) PoolItem(...).

void	operator delete (void *p, size_t size)
	Marks Titem as free.

Data Fields
uint8_t	num_sprites = 0

SpriteID	sprite = 0

Data Fields inherited from SpriteGroup
uint32_t	nfo_line = 0

Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_spritegroup_pool >
const Tindex	index
	Index of this pool item.

Protected Member Functions
ResolverResult	Resolve (ResolverObject &) const override
	Base sprite group resolver.

Protected Member Functions inherited from SpriteGroup
	SpriteGroup (SpriteGroupID index)

Additional Inherited Members
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_spritegroup_pool >
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >	Pool
	Type of the pool this item is going to be part of.

Static Public Member Functions inherited from SpecializedSpriteGroup< ResultSpriteGroup >
static ResultSpriteGroup *	Create (Targs &&... args)
	Creates a new T-object in the SpriteGroup pool.

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

Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_spritegroup_pool >
static T *	Create (Targs &&... args)
	Creates a new T-object in the associated pool.

static T *	CreateAtIndex (Tindex index, Targs &&... args)
	Creates a new T-object in the associated pool.

static bool	CanAllocateItem (size_t n=1)
	Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()

static bool	CleaningPool ()
	Returns current state of pool cleaning - yes or no.

static bool	IsValidID (auto index)
	Tests whether given index can be used to get valid (non-nullptr) Titem.

static Titem *	Get (auto index)
	Returns Titem with given index.

static Titem *	GetIfValid (auto index)
	Returns Titem with given index.

static size_t	GetPoolSize ()
	Returns first unused index.

static size_t	GetNumItems ()
	Returns number of valid items in the pool.

static void	PostDestructor (size_t index)
	Dummy function called after destructor of each member.

static Pool::IterateWrapper< Titem >	Iterate (size_t from=0)
	Returns an iterable ensemble of all valid Titem.

Detailed Description

Definition at line 237 of file newgrf_spritegroup.h.

Constructor & Destructor Documentation

◆ ResultSpriteGroup()

ResultSpriteGroup::ResultSpriteGroup	(	SpriteGroupID	index,
		SpriteID	sprite,
		uint8_t	num_sprites
	)

inline

Creates a spritegroup representing a sprite number result.

Parameters

sprite	The sprite number.
num_sprites	The number of sprites per set.

Returns: A spritegroup representing the sprite number result.

Definition at line 244 of file newgrf_spritegroup.h.

Member Function Documentation

◆ Resolve()

ResolverResult ResultSpriteGroup::Resolve ( ResolverObject & object ) const

inlineoverrideprotectedvirtual

Base sprite group resolver.

Implements SpriteGroup.

Definition at line 250 of file newgrf_spritegroup.h.

Field Documentation

◆ num_sprites

uint8_t ResultSpriteGroup::num_sprites = 0

Definition at line 246 of file newgrf_spritegroup.h.

◆ sprite

SpriteID ResultSpriteGroup::sprite = 0

Definition at line 247 of file newgrf_spritegroup.h.

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

src/newgrf_spritegroup.h

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members