SpriteGroup Struct Reference
Inheritance diagram for SpriteGroup:
Public Member Functions | |
| virtual SpriteID | GetResult () const |
| virtual uint8_t | GetNumResults () const |
| 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. More... | |
| void * | operator new (size_t size, size_t index) |
| Allocates space for new Titem with given index. More... | |
| void * | operator new (size_t, void *ptr) |
| Allocates space for new Titem at given memory address. More... | |
| void | operator delete (void *p) |
| Marks Titem as free. More... | |
Static Public Member Functions | |
| static const SpriteGroup * | Resolve (const SpriteGroup *group, ResolverObject &object, bool top_level=true) |
| ResolverObject (re)entry point. More... | |
| 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() More... | |
| static bool | CleaningPool () |
| Returns current state of pool cleaning - yes or no. More... | |
| static bool | IsValidID (size_t index) |
| Tests whether given index can be used to get valid (non-nullptr) Titem. More... | |
| static Titem * | Get (size_t index) |
| Returns Titem with given index. More... | |
| static Titem * | GetIfValid (size_t index) |
| Returns Titem with given index. More... | |
| static size_t | GetPoolSize () |
| Returns first unused index. More... | |
| static size_t | GetNumItems () |
| Returns number of valid items in the pool. More... | |
| static void | PostDestructor ([[maybe_unused]] size_t index) |
| Dummy function called after destructor of each member. More... | |
| static Pool::IterateWrapper< Titem > | Iterate (size_t from=0) |
| Returns an iterable ensemble of all valid Titem. More... | |
Data Fields | |
| 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. | |
Protected Member Functions | |
| SpriteGroup (SpriteGroupType type) | |
| virtual const SpriteGroup * | Resolve ([[maybe_unused]] ResolverObject &object) const |
| Base sprite group resolver. | |
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. | |
Detailed Description
Definition at line 57 of file newgrf_spritegroup.h.
Member Function Documentation
◆ Resolve()
|
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.
The documentation for this struct was generated from the following files:
