1. Epic GamesDeveloper
  3. FLinkerLoad

FLinkerLoad

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/LinkerLoad.h
Include #include "UObject/LinkerLoad.h"

Syntax

class FLinkerLoad :  
    public FLinker,  
    public FArchiveUObject

Variables

  Type Name Description
Public variable void * AsyncRoot The async package associated with this linker
Public variable bool bForceSimpleIndexToObject  
Public variable bool bHaveImportsBeenVerified Indicates whether the imports for this loader have been verified
Public variable bool bIsAsyncLoader True if Loader is FAsyncArchive
Public variable bool bLockoutLegacyOperations  
Public variable TSet< FBulkData * > BulkDataLoaders Bulk data that use the FLinkerLoad to track the state of the file on disk
Public variable UE::FMutex BulkDataMutex Used when accessing BulkDataLoaders/EditorBulkDataLoaders to ensure thread safety
Public variable TSet< UE::Serialization::FEditorBulkData * > EditorBulkDataLoaders  
Public variable TUniquePtr< int32[]> ExportHash  
Public variable TArray< FExternalReadCallback > ExternalReadDependencies List of external read dependencies that must be finished to load this package
Public variable uint32 LoadFlags Flags determining loading behavior.
Public variable TArray< FPackageIndex > PreloadDependencies List of imports and exports that must be serialized before other exports...all packed together, see FirstExportDependency
Public variable UObject * TemplateForGetArchetypeFromLoader  

Constructors

  Type Name Description
Protected function  

FLinkerLoad ( UPackage* InParent,
const FPackagePath& PackagePath,
uint32 InLoadFlags,
FLinkerInstancingContext InstancingContext
)

 Private constructor, passing arguments through from CreateLinker.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void

AddGameNameRedirect ( const FName OldName,
const FName NewName
)

 Add a new redirect from old game name to new game name for ImportMap
Public function Static void

AddKnownMissingPackage ( FName PackageName
)

 Register that a package is now known missing and that it should silence future warnings/issues
Public function Const void

BuildPathName ( FString& OutPathName,
FPackageIndex ExportIndex
)

 Builds a string containing the full path for a resource in the export table.
Public function Static void

CreateActiveRedirectsMap ( const FString& GEngineIniName
)

 Add redirects to FLinkerLoad static map
Public function bool

CreateImportClassAndPackage ( FName ClassName,
FName PackageName,
FPackageIndex& ClassIdx,
FPackageIndex& PackageIdx
)

 Attempts to find the index for the given class object in the import list and adds it + its package if it does not exist
Public function Static FLinkerLoad *

CreateLinker ( FUObjectSerializeContext* LoadContext,
UPackage* Parent,
const FPackagePath& PackagePath,
uint32 LoadFlags,
FArchive* InLoader,
const FLinkerInstancingContext* InstancingContext
)

 Creates and returns a FLinkerLoad object.
Protected function ELinkerStatus

CreateLoader ( TFunction< void()>&& InSummaryReadyCallback
)

 Creates loader used to serialize content.
Public function void  
Public function void

Detach ()

 Detaches linker from bulk data and exports and removes itself from array of loaders.
Public function void Only detaches the linker from its exports and the reset their cached state in the linker without touching bulkdata or underlying loader
Public function void Detaches all bulkdata currently attached to the FLinkerLoad followed by destroying the internal loader.
Public function UObject *

FindExistingExport ( int32 ExportIndex
)

 Before loading a persistent object from disk, this function can be used to discover the object in memory.
Public function UObject *

FindExistingImport ( int32 ImportIndex
)

  
Public function Static FLinkerLoad * Looks for an existing linker for the given package, without trying to make one if it doesn't exist
Public function int32

FindExportIndex ( FName ClassName,
FName ClassPackage,
FName ObjectName,
FPackageIndex ExportOuterIndex
)

  
Public function bool

FindImportClassAndPackage ( FName ClassName,
FPackageIndex& ClassIdx,
FPackageIndex& PackageIdx
)

 Locates the class adjusted index and its package adjusted index for a given class name in the import map
Public function bool

FindImportPackage ( FName PackageName,
FPackageIndex& PackageIdx
)

 Locates package index for a UPackage import
Public function Static FName

FindNewNameForClass ( FName OldClassName,
bool bIsInstance
)

 Utility functions to query the object name redirects list for the current name for a class
Public function Static FName

FindNewNameForEnum ( FName OldEnumName
)

 Utility functions to query the enum name redirects list for the current name for an enum
Public function Static FName

FindNewNameForStruct ( FName OldStructName
)

 Utility functions to query the struct name redirects list for the current name for a struct
Public function Static FString

FindNewPathNameForClass ( const FString& OldClassNameOrPathName,
bool bIsInstance
)

 Utility functions to query the object name redirects list for the current name for a class
Public function Static TArray< FName >

FindPreviousNamesForClass ( const FString& CurrentClassPath,
bool bIsInstance
)

 Utility functions to query the object name redirects list for previous names for a class
Public function Static TArray< FString >

FindPreviousPathNamesForClass ( const FString& CurrentClassPath,
bool bIsInstance,
bool bIncludeShortNames
)

 Utility functions to query the object name redirects list for previous names for a class
Public function bool

FinishExternalReadDependencies ( double TimeLimit
)

 Finalizes external dependencies till time limit is exceeded
Public function ELinkerStatus Allows object instances to be converted to other classes upon loading a package
Public function void

GatherExportDependencies ( int32 ExportIndex,
TSet< FDependencyRef >& Dependencies,
bool bSkipLoadedObjects
)

 Recursively gathers the dependencies of a given export (the recursive chain of imports and their imports, and so on)
Public function void

GatherImportDependencies ( int32 ImportIndex,
TSet< FDependencyRef >& Dependencies,
bool bSkipLoadedObjects
)

 Recursively gathers the dependencies of a given import (the recursive chain of imports and their imports, and so on)
Public function FAsyncArchive *  
Public function FName

GetExportClassPackage ( int32 i
)

  
Public function Static int32

GetHashBucket ( FName Object
)

  
Public function Const const FLinkerInstancingContext &  
Protected function Const FArchive *  
Public function Const FArchive * Access the underlying archive.
Public function Const int32 Returns ID of the thread that created this linker
Public function Const const FPackagePath & Get the PackagePath being loaded.
Public function Const const UE::FPackageTrailer *  
Public function Static bool  
Public function Const bool Checks if the linker has any objects in the export table that require loading.
Public function Const bool Returns whether linker has finished (potentially) async initialization.
Public function Const bool  
Public function Static void

InvalidateExport ( UObject* OldObject
)

 Invalidates the future loading of a specific object, so that subsequent loads will fail This is used to invalidate sub objects of a replaced object that may no longer be valid
Public function Const bool Query method to help handle recursive behavior.
Public function Const bool  
Public function Static bool Determines if imports can be lazily loaded.
Public function Static bool

IsKnownMissingPackage ( FName PackageName
)

 Utility functions to check the list of known missing packages and silence any warnings that may have occurred on load.
Public function Const bool  
Public function bool Test whether the given package index is a valid import or export in this package
Public function void

LoadAllObjects ( bool bForcePreload
)

 Loads all objects in package.
Public function void Detaches linker from bulk data.
Public function Static void

OnNewFileAdded ( const FString& Filename
)

  
Public function Static void

OnPakFileMounted ( const IPakFile& PakFile
)

  
Public function Static void Wraps a call to the package linker's ResolveAllImports().
Public function Static void

PRIVATE_PatchNewObjectIntoExport ( UObject* OldObject,
UObject* NewObject
)

 Replaces OldObject's entry in its linker with NewObject, so that all subsequent loads of OldObject will return NewObject.
Public function Static bool Register that a package is no longer known missing and that it should be searched for again in the future
Public function UObject *

RequestPlaceholderValue ( const FProperty* Property,
const UClass* ObjectType,
const TCHAR* ObjectPath
)

 Gives external code the ability to create FLinkerPlaceholderBase objects in place of loads that may violate the LOAD_DeferDependencyLoads state.
Public function UObject *

ResolveResource ( FPackageIndex ResourceIndex
)

 Returns the Object associated with the resource indicated.
Public function FName Returns the ObjectName associated with the resource indicated.
Public function Virtual bool  
Public function ELinkerStatus

SerializeGatherableTextDataMap ( bool bForceEnableForCommandlet
)

 Serializes the gatherable text data container.
Public function ELinkerStatus

SerializeThumbnails ( bool bForceEnableForCommandlet
)

 Serializes thumbnails
Protected function void

SetLoader ( FArchive* InLoader,
bool bInLoaderNeedsEngineVersionChecks
)

  
Public function Static void

SetPreloadingEnabled ( bool bEnabled
)

  
Public function Const bool Should bulkdata identifiers should be regenerated as they are loaded or not
Public function Static ELinkerType::Type Variables.
Protected function ELinkerStatus

Tick ( float InTimeLimit,
bool bInUseTimeLimit,
bool bInUseFullTimeLimit,
TMap< TPair< FName, FPackageIndex >, FPackageIndex >* ObjectNameWithOuterToExportMap
)

 Ticks an in-flight linker and spends InTimeLimit seconds on creation.
Public function Static bool

TryGetPreloadedLoader ( const FPackagePath& InPackagePath,
FOpenPackageResult& OutResult
)

  
Public function void

Verify ()

  
Public function EVerifyResult

VerifyImport ( int32 ImportIndex
)

 A wrapper around VerifyImportInner.
Public function bool

WillTextureBeLoaded ( UClass* Class,
int32 ExportIndex
)

 Checks if the specified export should be loaded or not. Performs similar checks as CreateExport().

Overridden from FLinker

  Type Name Description
Public function Virtual Const FString Returns a descriptor of the PackagePath this Linker is reading from or writing to, usable for an identifier in warning and log messages

Overridden from FArchive

  Type Name Description
Public function Virtual bool

AttachExternalReadDependency ( FExternalReadCallback& ReadCallback
)

 Adds external read dependency
Public function Virtual void Flush Loader Cache
Public function Virtual void Inform the archive that blueprint finalization is pending.
Public function Virtual void Called when an object stops serializing property data using script serialization.
Public function Virtual void Called when an object begins serializing property data using script serialization.
Public function Virtual void

Preload ( UObject* Object
)

 Serialize the object data for the specified object from the unreal package file.

Overridden from FArchiveState

  Type Name Description
Public function Virtual UObject * Called to retrieve the archetype from the event driven loader.
Public function Virtual Const FString Returns the name of the Archive.
Public function Virtual FLinker * If this archive is a FLinkerLoad or FLinkerSave, returns a pointer to the FLinker portion.
Public function Virtual FUObjectSerializeContext * Gets the current UObject serialization context for this archive.
Public function Virtual void Sets the current UObject serialization context for this archive.

Enums

  Type Name Description
Protected enum ELinkerStatus Linker loading status.  
Protected enum EVerifyResult Verify result.  

Constants

Name Description
bActiveRedirectsMapInitialized Makes sure the deprecated active redirects inis have been read
bPreloadingEnabled  
ExportHashCount Hash table for exports.
NAME_LoadErrors  

Deprecated Variables

  Type Name Description
Public variable bool bDynamicClassLinker This member is no longer in use and will be removed.

Deprecated Functions

  Type Name Description
Public function UObject *

Create ( UClass* ObjectClass,
FName ObjectName,
UObject* Outer,
uint32 InLoadFlags,
bool Checked
)

 Create was only used for the now-deprecated Conform argument to UPackage::Save. Contact Epic via UDN if you still need this function.
Public function Static FLinkerLoad *

CreateLinker ( FUObjectSerializeContext* LoadContext,
UPackage* Parent,
const TCHAR* Filename,
uint32 LoadFlags,
FArchive* InLoader,
const FLinkerInstancingContext* InstancingContext
)

 Use version that takes an FPackagePath instead
Public function Static bool

TryGetPreloadedLoader ( FArchive*& OutLoader,
const TCHAR* FileName
)

 Use version that takes a PackagePath instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page