UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FUObjectArray::TIterator Class Reference

#include <UObjectArray.h>

+ Inheritance diagram for FUObjectArray::TIterator:

Public Types

enum  EEndTagType { EndTag }
 

Public Member Functions

 TIterator (const FUObjectArray &InArray, bool bOnlyGCedObjects=false)
 
 TIterator (EEndTagType, const TIterator &InIter)
 
UE_FORCEINLINE_HINT void operator++ ()
 
bool operator== (const TIterator &Rhs) const
 
bool operator!= (const TIterator &Rhs) const
 
UE_FORCEINLINE_HINT operator bool () const
 
UE_FORCEINLINE_HINT bool operator! () const
 
UE_FORCEINLINE_HINT int32 GetIndex () const
 

Protected Member Functions

UE_FORCEINLINE_HINT FUObjectItemGetObject () const
 
bool Advance ()
 
const FUObjectArrayGetIteratedArray () const
 

Detailed Description

Low level iterator.

Member Enumeration Documentation

◆ EEndTagType

enum FUObjectArray::TIterator::EEndTagType
Enumerator
EndTag 

Constructor & Destructor Documentation

◆ TIterator() [1/2]

FUObjectArray::TIterator::TIterator ( const FUObjectArray InArray,
bool  bOnlyGCedObjects = false 
)
inline

Constructor

Parameters
InArraythe array to iterate on
bOnlyGCedObjectsif true, skip all of the permanent objects

◆ TIterator() [2/2]

FUObjectArray::TIterator::TIterator ( EEndTagType  ,
const TIterator InIter 
)
inline

Constructor

Parameters
InArraythe array to iterate on
bOnlyGCedObjectsif true, skip all of the permanent objects

Member Function Documentation

◆ Advance()

bool FUObjectArray::TIterator::Advance ( )
inlineprotected

Iterator advance with ordinary name for clarity in subclasses

Returns
true if the iterator points to a valid object, false if iteration is complete

◆ GetIndex()

UE_FORCEINLINE_HINT int32 FUObjectArray::TIterator::GetIndex ( ) const
inline

◆ GetIteratedArray()

const FUObjectArray & FUObjectArray::TIterator::GetIteratedArray ( ) const
inlineprotected

Gets the array this iterator iterates over

◆ GetObject()

UE_FORCEINLINE_HINT FUObjectItem * FUObjectArray::TIterator::GetObject ( ) const
inlineprotected

Dereferences the iterator with an ordinary name for clarity in derived classes

Returns
the UObject at the iterator

◆ operator bool()

UE_FORCEINLINE_HINT FUObjectArray::TIterator::operator bool ( ) const
inlineexplicit

Conversion to "bool" returning true if the iterator is valid.

◆ operator!()

UE_FORCEINLINE_HINT bool FUObjectArray::TIterator::operator! ( ) const
inline

inverse of the "bool" operator

◆ operator!=()

bool FUObjectArray::TIterator::operator!= ( const TIterator Rhs) const
inline

◆ operator++()

UE_FORCEINLINE_HINT void FUObjectArray::TIterator::operator++ ( )
inline

Iterator advance

◆ operator==()

bool FUObjectArray::TIterator::operator== ( const TIterator Rhs) const
inline

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