FBaseIterator | Unreal Engine 5.7 Documentation

Base functionality for iterating over the DirectoryIndex.


Name	FBaseIterator
Type	class
Header File	/Engine/Source/Runtime/PakFile/Public/IPlatformFilePak.h
Include Path	#include "IPlatformFilePak.h"

Syntax

class FBaseIterator

Name	Remarks	Include Path
FBaseIterator ( const FPakFile& InPakFile, bool bInIncludeDeleted, bool bUsePathHash )		IPlatformFilePak.h
FBaseIterator ( const FBaseIterator& )	PakFile iterators can be large, because they have to walk a tree, so do not copy them, move construct only.	IPlatformFilePak.h
FBaseIterator ( FBaseIterator&& )		IPlatformFilePak.h

Name	Remarks	Include Path	Unreal Specifiers
~FBaseIterator()		IPlatformFilePak.h

Name	Type	Remarks	Include Path
bIncludeDeleted	bool	Whether to include delete records in the iteration.	IPlatformFilePak.h
bRequiresDirectoryIndexLock	bool	Whether this iterator needs to ReadLock and ReadUnlock due to use of the DirectoryIndex	IPlatformFilePak.h
CachedFilename	FString	The cached filename for return in Filename().	IPlatformFilePak.h
DirectoryIndexIt	TOptional< FDirectoryIndex::TConstIterator >	Outer iterator over Directories when using the FDirectoryIndex.	IPlatformFilePak.h
FileIt	TOptional< FPakDirectory::TConstIterator >	Inner iterator over Files when using the FDirectoryIndex or FDirectoryTreeIndex.	IPlatformFilePak.h
IteratorType	EIteratorType	Which type of internal iterator this iterator and its pakfile are using.	IPlatformFilePak.h
PakEntry	FPakEntry	The PakEntry for return in Info	IPlatformFilePak.h
PakFile	const FPakFile *	Owner pak file.	IPlatformFilePak.h
PathHashIt	TOptional< FPathHashIndex::TConstIterator >	Iterator when using the FPathHashIndex.	IPlatformFilePak.h

Name	Remarks	Include Path	Unreal Specifiers
bool HasFilename()		IPlatformFilePak.h
const FPakEntry & Info ()	Return the FPakEntry.	IPlatformFilePak.h

Name	Remarks	Include Path	Unreal Specifiers
const FString & Filename ()	Return the current filename, as the RelativePath from the MountPoint.	IPlatformFilePak.h
FPakEntryLocation GetPakEntryIndex ()	Return the arbitrary index of the iteration.	IPlatformFilePak.h

Name	Remarks	Include Path
operator bool()	Conversion to "bool" returning true if the iterator is valid.	IPlatformFilePak.h
bool operator!()	Inverse of the "bool" operator	IPlatformFilePak.h
FBaseIterator & operator++()		IPlatformFilePak.h
FBaseIterator & operator= ( FBaseIterator&& )		IPlatformFilePak.h
FBaseIterator & operator= ( const FBaseIterator& )		IPlatformFilePak.h