Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/IVirtualizationSystem
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ERehydrationResult TryRehydratePackages
(
TConstArrayView< FString > PackagePaths, |
Virtualization/VirtualizationSystem.h | ||
FRehydrationResult TryRehydratePackages
(
TConstArrayView< FString > PackagePaths, |
Runs the rehydration process on a set of packages. | Virtualization/VirtualizationSystem.h | |
ERehydrationResult TryRehydratePackages
(
TConstArrayView< FString > PackagePaths, |
Rehydrates a number of packages into memory buffers. | Virtualization/VirtualizationSystem.h |
TryRehydratePackages(TConstArrayView< FString >, TArray< FText > &)
| Name | TryRehydratePackages |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h |
| Include Path | #include "Virtualization/VirtualizationSystem.h" |
virtual ERehydrationResult TryRehydratePackages
(
TConstArrayView< FString > PackagePaths,
TArray < FText > & OutErrors
)
TryRehydratePackages(TConstArrayView< FString >, ERehydrationOptions)
Description
Runs the rehydration process on a set of packages. This involves downloading virtualized payloads and placing them back in the trailer of the given packages.
| Name | TryRehydratePackages |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h |
| Include Path | #include "Virtualization/VirtualizationSystem.h" |
FRehydrationResult TryRehydratePackages
(
TConstArrayView< FString > PackagePaths,
ERehydrationOptions Options
)
A ERehydrationResult enum with the status of the process. If the status indicates any sort of failure then OutResultInfo.Errors should contain at least one entry.
Parameters
| Name | Remarks |
|---|---|
| PackagePaths | An array containing the absolute file paths of packages |
| Options | An enum bitfield containing various options for the process. |
| OutResultInfo | A struct that will contain info about the process. |
See Also
TryRehydratePackages(TConstArrayView< FString >, uint64, TArray< FText > &, TArray< FSharedBuffer > &, TArray< FRehydrationInfo > *)
Description
Rehydrates a number of packages into memory buffers. Note that if a package does not require rehydration we will still return the package in a memory buffer but it will be the same as the package on disk.
| Name | TryRehydratePackages |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h |
| Include Path | #include "Virtualization/VirtualizationSystem.h" |
ERehydrationResult TryRehydratePackages
(
TConstArrayView< FString > PackagePaths,
uint64 PaddingAlignment,
TArray < FText > & OutErrors,
TArray < FSharedBuffer > & OutPackages,
TArray < FRehydrationInfo > * OutInfo
)
ERehydrationResult::Success if the rehydration suceeeds and OutPackages/OutInfocan be trued, otherwise it will return an error value.
Parameters
| Name | Remarks |
|---|---|
| PackagePaths | An array containing the absolute file paths of packages. |
| PaddingAlignment | Byte alignment to pad each package buffer too, a value of 0 will result in the buffers being the same size as the packages |
| OutErrors | Any errors encountered while rehydration will be added here |
| OutPackages | The rehydrated packages as memory buffers. Each entry should match the corresponding entry in PackagePaths. This array is only guaranteed to be correct if the method returns ERehydrationResult::Success. |
| OutInfo | Information about the rehydration process, each entry should match the corresponding entry in PackagePaths assuming that the method returns ERehydrationResult::Success. This parameter is optional, if the information is not required then pass in nullptr to skip. |