RandomizedSpriteGroup Struct Reference
Inheritance diagram for RandomizedSpriteGroup:
Data Fields | |
| VarSpriteGroupScope | var_scope |
| Take this object: | |
| RandomizedSpriteGroupCompareMode | cmp_mode |
| Check for these triggers: | |
| uint8_t | triggers |
| uint8_t | count |
| uint8_t | lowest_randbit |
| Look for this in the per-object randomized bitmask: | |
| std::vector< const SpriteGroup * > | groups |
| Take the group with appropriate index: | |
 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. | |
Protected Member Functions | |
| const SpriteGroup * | Resolve (ResolverObject &object) const override |
| Base sprite group resolver. | |
| Protected Member Functions inherited from SpriteGroup | |
| SpriteGroup (SpriteGroupType type) | |
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. | |
| Public Member Functions inherited from SpriteGroup | |
| 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. | |
| 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. | |
| 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. | |
Detailed Description
Definition at line 190 of file newgrf_spritegroup.h.
Constructor & Destructor Documentation
◆ RandomizedSpriteGroup()
|
inline |
Definition at line 191 of file newgrf_spritegroup.h.
Member Function Documentation
◆ Resolve()
|
overrideprotectedvirtual |
Base sprite group resolver.
Reimplemented from SpriteGroup.
Definition at line 256 of file newgrf_spritegroup.cpp.
References CBID_RANDOM_TRIGGER, cmp_mode, ScopeResolver::GetRandomBits(), groups, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_pool >::index, lowest_randbit, SpriteGroup::Resolve(), and var_scope.
Field Documentation
◆ cmp_mode
| RandomizedSpriteGroupCompareMode RandomizedSpriteGroup::cmp_mode |
Check for these triggers:
Definition at line 195 of file newgrf_spritegroup.h.
Referenced by Resolve().
◆ count
| uint8_t RandomizedSpriteGroup::count |
Definition at line 197 of file newgrf_spritegroup.h.
◆ groups
| std::vector<const SpriteGroup *> RandomizedSpriteGroup::groups |
Take the group with appropriate index:
Definition at line 201 of file newgrf_spritegroup.h.
Referenced by Resolve().
◆ lowest_randbit
| uint8_t RandomizedSpriteGroup::lowest_randbit |
Look for this in the per-object randomized bitmask:
Definition at line 199 of file newgrf_spritegroup.h.
Referenced by Resolve().
◆ triggers
| uint8_t RandomizedSpriteGroup::triggers |
Definition at line 196 of file newgrf_spritegroup.h.
◆ var_scope
| VarSpriteGroupScope RandomizedSpriteGroup::var_scope |
The documentation for this struct was generated from the following files:
