FPakFile::FBaseIterator Class Reference

#include <IPlatformFilePak.h>

Inheritance diagram for FPakFile::FBaseIterator:

Public Member Functions
	FBaseIterator (FBaseIterator &&)=default
FBaseIterator &	operator= (FBaseIterator &&)=default
	FBaseIterator (const FBaseIterator &)=delete
FBaseIterator &	operator= (const FBaseIterator &)=delete
PAKFILE_API FBaseIterator &	operator++ ()
PAKFILE_API	operator bool () const
PAKFILE_API bool	operator! () const
PAKFILE_API const FPakEntry &	Info () const
PAKFILE_API bool	HasFilename () const

Protected Member Functions
PAKFILE_API	FBaseIterator (const FPakFile &InPakFile, bool bInIncludeDeleted, bool bUsePathHash)
PAKFILE_API	~FBaseIterator ()
PAKFILE_API const FString &	Filename () const
PAKFILE_API FPakEntryLocation	GetPakEntryIndex () const

Detailed Description

Base functionality for iterating over the DirectoryIndex.

Constructor & Destructor Documentation

FBaseIterator() [1/3]

FPakFile::FBaseIterator::FBaseIterator ( FBaseIterator &&  )

default

FBaseIterator() [2/3]

FPakFile::FBaseIterator::FBaseIterator ( const FBaseIterator &  )

delete

FBaseIterator() [3/3]

FPakFile::FBaseIterator::FBaseIterator ( const FPakFile &  InPakFile, bool  bInIncludeDeleted, bool  bUsePathHash  )

protected

~FBaseIterator()

PAKFILE_API FPakFile::FBaseIterator::~FBaseIterator ( )

protected

Member Function Documentation

Filename()

const FString & FPakFile::FBaseIterator::Filename ( ) const

protected

Return the current filename, as the RelativePath from the MountPoint. Only available when using the FDirectoryIndex, otherwise always returns empty string. Invalid to call unless the iterator is currently valid.

GetPakEntryIndex()

FPakEntryLocation FPakFile::FBaseIterator::GetPakEntryIndex ( ) const

protected

Return the arbitrary index of the iteration. Invalid to call unless the iterator is currently valid.

HasFilename()

bool FPakFile::FBaseIterator::HasFilename

(

)

const

Info()

const FPakEntry & FPakFile::FBaseIterator::Info

(

)

const

Return the FPakEntry. Invalid to call unless the iterator is currently valid.

operator bool()

FPakFile::FBaseIterator::operator bool ( ) const

explicit

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

operator!()

bool FPakFile::FBaseIterator::operator!

(

)

const

inverse of the "bool" operator

operator++()

FPakFile::FBaseIterator & FPakFile::FBaseIterator::operator++

(

)

operator=() [1/2]

FBaseIterator & FPakFile::FBaseIterator::operator= ( const FBaseIterator &  )

delete

operator=() [2/2]

FBaseIterator & FPakFile::FBaseIterator::operator= ( FBaseIterator &&  )

default

---

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

• Engine/Source/Runtime/PakFile/Public/IPlatformFilePak.h
• Engine/Source/Runtime/PakFile/Private/PakFile.cpp