UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Friends | List of all members
FPackageIndex Class Reference

#include <ObjectResource.h>

Public Member Functions

UE_FORCEINLINE_HINT FPackageIndex ()
 
UE_FORCEINLINE_HINT bool IsImport () const
 
UE_FORCEINLINE_HINT bool IsExport () const
 
UE_FORCEINLINE_HINT bool IsNull () const
 
int32 ToImport () const
 
int32 ToExport () const
 
UE_FORCEINLINE_HINT int32 ForDebugging () const
 
UE_FORCEINLINE_HINT bool operator== (const FPackageIndex &Other) const
 
UE_FORCEINLINE_HINT bool operator!= (const FPackageIndex &Other) const
 
UE_FORCEINLINE_HINT bool operator< (const FPackageIndex &Other) const
 
UE_FORCEINLINE_HINT bool operator> (const FPackageIndex &Other) const
 
UE_FORCEINLINE_HINT bool operator<= (const FPackageIndex &Other) const
 
UE_FORCEINLINE_HINT bool operator>= (const FPackageIndex &Other) const
 

Static Public Member Functions

static FPackageIndex FromImport (int32 ImportIndex)
 
static FPackageIndex FromExport (int32 ExportIndex)
 

Friends

FArchive & operator<< (FArchive &Ar, FPackageIndex &Value)
 
UE_FORCEINLINE_HINT friend void operator<< (FStructuredArchive::FSlot Slot, FPackageIndex &Value)
 
UE_FORCEINLINE_HINT friend uint32 GetTypeHash (const FPackageIndex &In)
 
FString LexToString (const FPackageIndex &Value)
 
void LexFromString (FPackageIndex &Value, const TCHAR *String)
 

Detailed Description

Wrapper for index into a ULnker's ImportMap or ExportMap. Values greater than zero indicate that this is an index into the ExportMap. The actual array index will be (FPackageIndex - 1).

Values less than zero indicate that this is an index into the ImportMap. The actual array index will be (-FPackageIndex - 1)

Constructor & Destructor Documentation

◆ FPackageIndex()

UE_FORCEINLINE_HINT FPackageIndex::FPackageIndex ( )
inline

Constructor, sets the value to null

Member Function Documentation

◆ ForDebugging()

UE_FORCEINLINE_HINT int32 FPackageIndex::ForDebugging ( ) const
inline

Return the raw value, for debugging purposes

◆ FromExport()

static FPackageIndex FPackageIndex::FromExport ( int32  ExportIndex)
inlinestatic

Create a FPackageIndex from an export index

◆ FromImport()

static FPackageIndex FPackageIndex::FromImport ( int32  ImportIndex)
inlinestatic

Create a FPackageIndex from an import index

◆ IsExport()

UE_FORCEINLINE_HINT bool FPackageIndex::IsExport ( ) const
inline

return true if this is an index into the export map

◆ IsImport()

UE_FORCEINLINE_HINT bool FPackageIndex::IsImport ( ) const
inline

return true if this is an index into the import map

◆ IsNull()

UE_FORCEINLINE_HINT bool FPackageIndex::IsNull ( ) const
inline

return true if this null (i.e. neither an import nor an export)

◆ operator!=()

UE_FORCEINLINE_HINT bool FPackageIndex::operator!= ( const FPackageIndex &  Other) const
inline

Compare package indecies for inequality

◆ operator<()

UE_FORCEINLINE_HINT bool FPackageIndex::operator< ( const FPackageIndex &  Other) const
inline

Compare package indecies

◆ operator<=()

UE_FORCEINLINE_HINT bool FPackageIndex::operator<= ( const FPackageIndex &  Other) const
inline

◆ operator==()

UE_FORCEINLINE_HINT bool FPackageIndex::operator== ( const FPackageIndex &  Other) const
inline

Compare package indecies for equality

◆ operator>()

UE_FORCEINLINE_HINT bool FPackageIndex::operator> ( const FPackageIndex &  Other) const
inline

◆ operator>=()

UE_FORCEINLINE_HINT bool FPackageIndex::operator>= ( const FPackageIndex &  Other) const
inline

◆ ToExport()

int32 FPackageIndex::ToExport ( ) const
inline

Check that this is an export and return the index into the export map

◆ ToImport()

int32 FPackageIndex::ToImport ( ) const
inline

Check that this is an import and return the index into the import map

Friends And Related Symbol Documentation

◆ GetTypeHash

UE_FORCEINLINE_HINT friend uint32 GetTypeHash ( const FPackageIndex &  In)
friend

◆ LexFromString

void LexFromString ( FPackageIndex &  Value,
const TCHAR *  String 
)
friend

◆ LexToString

FString LexToString ( const FPackageIndex &  Value)
friend

Lex functions Lex functions

◆ operator<< [1/2]

FArchive & operator<< ( FArchive &  Ar,
FPackageIndex &  Value 
)
friend

Serializes a package index value from or into an archive.

Parameters
Ar- The archive to serialize from or to.
Value- The value to serialize.

◆ operator<< [2/2]

UE_FORCEINLINE_HINT friend void operator<< ( FStructuredArchive::FSlot  Slot,
FPackageIndex &  Value 
)
friend

Serializes a package index value from or into a structured archive slot.

Parameters
Slot- The structured archive slot to serialize from or to.
Value- The value to serialize.
The documentation for this class was generated from the following file: