Apparatus Version 1.8
ECS data-oriented workflow for Unreal Engine.
Public Member Functions | Friends | List of all members
FBeltSlotCache Struct Reference

A detail caching for subjects used in the belts' slots. More...

#include <BeltSlotCache.h>

Public Member Functions

 FBeltSlotCache (const FBeltSlotCache &InCache)
 
 FBeltSlotCache (FBeltSlotCache &&InCache)
 
 FBeltSlotCache ()
 Construct an invalid/uninitialized cache. More...
 
struct FBeltSlotGetOwner () const
 Get the owner of the cache. More...
 
TSubclassOf< UDetailGetDetailClass () const
 Get the class of details stored within the cache. More...
 
const TArray< TWeakObjectPtr< class UDetail > > & GetDetails () const
 Get the list of all fetched details. More...
 
int32 IterableNum () const
 Get the current number of iterable details. More...
 
bool HasAny () const
 Check if there are any viable detail(s) within the cache. More...
 
 operator bool () const
 Check if there are any viable detail(s) within the cache. More...
 
const TWeakObjectPtr< class UDetail > & operator[] (const int32 Index) const
 Get a detail at specified index. More...
 
void Fetch (const TSubclassOf< UDetail > DetailClass, const TScriptInterface< class ISubjective > Subjective)
 Fetch the detail instances from the subject. More...
 
void Fetch (const TSubclassOf< UDetail > DetailClass, const TArray< UDetail * > &InDetails)
 Fetch the detail instances from the user-provided list of details. More...
 
FBeltSlotCacheoperator= (const FBeltSlotCache &Cache)
 Copy the cache from another cache instance. More...
 
FBeltSlotCacheoperator+= (const FBeltSlotCache &Cache)
 Append the cache from another cache instance. More...
 

Friends

class UBelt
 
template<typename SubjectHandleT >
struct TBeltIt
 
struct FBeltSlot
 
class UObject
 
class UClass
 
class TArray< FBeltSlotCache >
 

Detailed Description

A detail caching for subjects used in the belts' slots.

Constructor & Destructor Documentation

◆ FBeltSlotCache() [1/3]

FBeltSlotCache::FBeltSlotCache ( const FBeltSlotCache InCache)
inline

◆ FBeltSlotCache() [2/3]

FBeltSlotCache::FBeltSlotCache ( FBeltSlotCache &&  InCache)
inline

◆ FBeltSlotCache() [3/3]

FBeltSlotCache::FBeltSlotCache ( )
inline

Construct an invalid/uninitialized cache.

Member Function Documentation

◆ Fetch() [1/2]

void FBeltSlotCache::Fetch ( const TSubclassOf< UDetail DetailClass,
const TArray< UDetail * > &  InDetails 
)
inline

Fetch the detail instances from the user-provided list of details.

◆ Fetch() [2/2]

void FBeltSlotCache::Fetch ( const TSubclassOf< UDetail DetailClass,
const TScriptInterface< class ISubjective Subjective 
)
inline

Fetch the detail instances from the subject.

◆ GetDetailClass()

TSubclassOf<UDetail> FBeltSlotCache::GetDetailClass ( ) const
inline

Get the class of details stored within the cache.

◆ GetDetails()

const TArray<TWeakObjectPtr<class UDetail> >& FBeltSlotCache::GetDetails ( ) const
inline

Get the list of all fetched details.

◆ GetOwner()

struct FBeltSlot* FBeltSlotCache::GetOwner ( ) const
inline

Get the owner of the cache.

◆ HasAny()

bool FBeltSlotCache::HasAny ( ) const
inline

Check if there are any viable detail(s) within the cache.

◆ IterableNum()

int32 FBeltSlotCache::IterableNum ( ) const
inline

Get the current number of iterable details.

◆ operator bool()

FBeltSlotCache::operator bool ( ) const
inline

Check if there are any viable detail(s) within the cache.

◆ operator+=()

FBeltSlotCache& FBeltSlotCache::operator+= ( const FBeltSlotCache Cache)

Append the cache from another cache instance.

◆ operator=()

FBeltSlotCache& FBeltSlotCache::operator= ( const FBeltSlotCache Cache)

Copy the cache from another cache instance.

◆ operator[]()

const TWeakObjectPtr<class UDetail>& FBeltSlotCache::operator[] ( const int32  Index) const
inline

Get a detail at specified index.

Parameters
IndexThe index of the detail to get.

Friends And Related Function Documentation

◆ FBeltSlot

friend struct FBeltSlot
friend

◆ TArray< FBeltSlotCache >

friend class TArray< FBeltSlotCache >
friend

◆ TBeltIt

template<typename SubjectHandleT >
friend struct TBeltIt
friend

◆ UBelt

friend class UBelt
friend

◆ UClass

friend class UClass
friend

◆ UObject

friend class UObject
friend

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