Inheritance diagram for ResultSpriteGroup:

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

SpriteID	GetResult () const override

uint8_t	GetNumResults () const override

Public Member Functions inherited from SpriteGroup
virtual uint16_t	GetCallbackResult () const

Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_pool >
void *	operator new (size_t size)
	Allocates space for new Titem.

void *	operator new (size_t size, size_t index)
	Allocates space for new Titem with given index.

void *	operator new (size_t, void *ptr)
	Allocates space for new Titem at given memory address.

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

Data Fields
uint8_t	num_sprites

SpriteID	sprite

Data Fields inherited from SpriteGroup
uint32_t	nfo_line

SpriteGroupType	type

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

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

Static Public Member Functions inherited from SpriteGroup
static const SpriteGroup *	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, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_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 (size_t index)
	Tests whether given index can be used to get valid (non-nullptr) Titem.

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

static Titem *	GetIfValid (size_t 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.

Protected Member Functions inherited from SpriteGroup
	SpriteGroup (SpriteGroupType type)

virtual const SpriteGroup *	Resolve (ResolverObject &object) const
	Base sprite group resolver.

Detailed Description

Definition at line 224 of file newgrf_spritegroup.h.

Constructor & Destructor Documentation

◆ ResultSpriteGroup()

ResultSpriteGroup::ResultSpriteGroup	(	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 231 of file newgrf_spritegroup.h.

Member Function Documentation

◆ GetNumResults()

uint8_t ResultSpriteGroup::GetNumResults ( ) const

inlineoverridevirtual

Reimplemented from SpriteGroup.

Definition at line 242 of file newgrf_spritegroup.h.

◆ GetResult()

SpriteID ResultSpriteGroup::GetResult ( ) const

inlineoverridevirtual

Reimplemented from SpriteGroup.

Definition at line 241 of file newgrf_spritegroup.h.

Field Documentation

◆ num_sprites

uint8_t ResultSpriteGroup::num_sprites

Definition at line 238 of file newgrf_spritegroup.h.

◆ sprite

SpriteID ResultSpriteGroup::sprite

Definition at line 239 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

Additional Inherited Members