TObjectIterator< T > Class Template Reference

#include <UObjectIterator.h>

Public Types
enum	EEndTagType { EndTag }

Public Member Functions
	TObjectIterator (EObjectFlags AdditionalExclusionFlags=RF_ClassDefaultObject, bool bIncludeDerivedClasses=true, EInternalObjectFlags InInternalExclusionFlags=EInternalObjectFlags::None)
	TObjectIterator (EEndTagType, const TObjectIterator &Begin)
UE_FORCEINLINE_HINT void	operator++ ()
UE_FORCEINLINE_HINT	operator bool () const
UE_FORCEINLINE_HINT bool	operator! () const
FUNCTION_NON_NULL_RETURN_START UE_FORCEINLINE_HINT T *	operator* () const FUNCTION_NON_NULL_RETURN_END
FUNCTION_NON_NULL_RETURN_START UE_FORCEINLINE_HINT T *	operator-> () const FUNCTION_NON_NULL_RETURN_END
UE_FORCEINLINE_HINT bool	operator== (const TObjectIterator &Rhs) const
UE_FORCEINLINE_HINT bool	operator!= (const TObjectIterator &Rhs) const

Protected Member Functions
UE_FORCEINLINE_HINT UObject *	GetObject () const
bool	Advance ()

Protected Attributes
TArray< UObject * >	ObjectArray
int32	Index

Detailed Description

template<class T>
class TObjectIterator< T >

Class for iterating through all objects which inherit from a specified base class. Does not include any class default objects. Note that when Playing In Editor, this will find objects in the editor as well as the PIE world, in an indeterminate order.

Member Enumeration Documentation

EEndTagType

template<class T >

enum TObjectIterator::EEndTagType

Enumerator
EndTag

Constructor & Destructor Documentation

TObjectIterator() [1/2]

template<class T >

TObjectIterator< T >::TObjectIterator ( EObjectFlags  AdditionalExclusionFlags = RF_ClassDefaultObject, bool  bIncludeDerivedClasses = true, EInternalObjectFlags  InInternalExclusionFlags = EInternalObjectFlags::None  )

inlineexplicit

Constructor

TObjectIterator() [2/2]

template<class T >

TObjectIterator< T >::TObjectIterator ( EEndTagType  , const TObjectIterator< T > &  Begin  )

inline

Constructor

Member Function Documentation

Advance()

template<class T >

bool TObjectIterator< T >::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

GetObject()

template<class T >

UE_FORCEINLINE_HINT UObject * TObjectIterator< T >::GetObject ( ) const

inlineprotected

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

Returns

the UObject at the iterator

operator bool()

template<class T >

UE_FORCEINLINE_HINT TObjectIterator< T >::operator bool ( ) const

inlineexplicit

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

operator!()

template<class T >

UE_FORCEINLINE_HINT bool TObjectIterator< T >::operator! ( ) const

inline

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

operator!=()

template<class T >

UE_FORCEINLINE_HINT bool TObjectIterator< T >::operator!= ( const TObjectIterator< T > &  Rhs ) const

inline

operator*()

template<class T >

FUNCTION_NON_NULL_RETURN_START UE_FORCEINLINE_HINT T * TObjectIterator< T >::operator* ( ) const

inline

Iterator dereference

Returns

the object pointer pointed at by the iterator

operator++()

template<class T >

UE_FORCEINLINE_HINT void TObjectIterator< T >::operator++ ( )

inline

Iterator advance

operator->()

template<class T >

FUNCTION_NON_NULL_RETURN_START UE_FORCEINLINE_HINT T * TObjectIterator< T >::operator-> ( ) const

inline

Iterator dereference

Returns

the object pointer pointed at by the iterator

operator==()

template<class T >

UE_FORCEINLINE_HINT bool TObjectIterator< T >::operator== ( const TObjectIterator< T > &  Rhs ) const

inline

Member Data Documentation

Index

template<class T >

int32 TObjectIterator< T >::Index

protected

index of the current element in the object array

ObjectArray

template<class T >

TArray<UObject*> TObjectIterator< T >::ObjectArray

protected

Results from the GetObjectsOfClass query

---

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

• Engine/Source/Runtime/CoreUObject/Public/UObject/UObjectIterator.h