UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TScriptContainerIterator< ContainerType > Struct Template Reference

#include <UnrealType.h>

Public Member Functions

 TScriptContainerIterator (const ContainerType &InContainer)
 
 TScriptContainerIterator (const ContainerType &InContainer, const int32 InLogicalIndex)
 
TScriptContainerIteratoroperator++ ()
 
TScriptContainerIterator operator++ (int)
 
 operator bool () const
 
int32 GetInternalIndex () const
 
int32 GetLogicalIndex () const
 
int32 operator* () const
 

Detailed Description

template<typename ContainerType>
struct TScriptContainerIterator< ContainerType >

Templated iterator to go through script helper containers that may contain invalid entries that are not part of the valid number of elements (i.e. GetMaxIndex() != Num() ). The iterator

  • will advance to the first valid entry on creation and when incremented
  • can be dereferenced to an internal index to be used with methods like Get<Item>Ptr or Get<Item>PtrWithoutCheck
  • can also be used directly with methods like Get<Item>PtrChecked
  • can return the associated logical index (number of valid visited entries) by calling GetLogicalIndex()

Constructor & Destructor Documentation

◆ TScriptContainerIterator() [1/2]

template<typename ContainerType >
TScriptContainerIterator< ContainerType >::TScriptContainerIterator ( const ContainerType &  InContainer)
inlineexplicit

◆ TScriptContainerIterator() [2/2]

template<typename ContainerType >
TScriptContainerIterator< ContainerType >::TScriptContainerIterator ( const ContainerType &  InContainer,
const int32  InLogicalIndex 
)
inlineexplicit

Member Function Documentation

◆ GetInternalIndex()

template<typename ContainerType >
int32 TScriptContainerIterator< ContainerType >::GetInternalIndex ( ) const
inline

◆ GetLogicalIndex()

template<typename ContainerType >
int32 TScriptContainerIterator< ContainerType >::GetLogicalIndex ( ) const
inline

◆ operator bool()

template<typename ContainerType >
TScriptContainerIterator< ContainerType >::operator bool ( ) const
inlineexplicit

◆ operator*()

template<typename ContainerType >
int32 TScriptContainerIterator< ContainerType >::operator* ( ) const
inline

◆ operator++() [1/2]

template<typename ContainerType >
TScriptContainerIterator & TScriptContainerIterator< ContainerType >::operator++ ( )
inline

◆ operator++() [2/2]

template<typename ContainerType >
TScriptContainerIterator TScriptContainerIterator< ContainerType >::operator++ ( int  )
inline

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