Navigation
API > API/Runtime > API/Runtime/Core
The base interface for the virtualization system. An Epic maintained version can be found in the Virtualization module. To implement your own, simply derived from this interface and then use the UE_REGISTER_VIRTUALIZATION_SYSTEM macro in the cpp to register it as an option. You can then set the config file option [Core.ContentVirtualization]SystemName=FooBar, where FooBar should be the SystemName parameter you used when registering with the macro.
Special Cases: SystemName=Off - This is the default set up and means a project will not use content virtualization Note that calling IVirtualizationSystem::Get() will still return a valid IVirtualizationSystem implementation, but all push and pull operations will result in failure and IsEnabled will always return false. SystemName=Default - This will cause the default Epic implementation to be used
| Name | IVirtualizationSystem |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h |
| Include Path | #include "Virtualization/VirtualizationSystem.h" |
Syntax
class IVirtualizationSystem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IVirtualizationSystem() |
Virtualization/VirtualizationSystem.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IVirtualizationSystem() |
Virtualization/VirtualizationSystem.h |
Enums
Public
| Name | Remarks |
|---|---|
| ENotification |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnNotification | TTSMulticastDelegate< void(ENotification, const FIoHash &)> | Declare delegate for notifications | Virtualization/VirtualizationSystem.h |
| GetPayloadActivityInfoFuncRef | TFunctionRef< void(const FString &DebugName, const FString &ConfigName, const FPayloadActivityInfo &PayloadInfo)> | Virtualization/VirtualizationSystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Poll to see if the virtualization process failing when submitting a collection of files to source control should block that submit or allow it to continue. | Virtualization/VirtualizationSystem.h | ||
void DumpStats() |
When called the system should write any performance stats that it has been gathering to the log file | Virtualization/VirtualizationSystem.h | |
EPayloadFilterReason FilterPayload
(
const UObject* Owner |
Run checks to see if the payload can be virtualized or not. | Virtualization/VirtualizationSystem.h | |
void GatherAnalytics
(
TArray< FAnalyticsEventAttribute >& Attributes |
Gather analytics data. Stats will only be collected if ENABLE_COOK_STATS is enabled. | Virtualization/VirtualizationSystem.h | |
virtual FPayloadActivityInfo GetAccumualtedPayloadActivityInfo() |
Virtualization/VirtualizationSystem.h | ||
| Access profiling info relating to payload activity per backend. | Virtualization/VirtualizationSystem.h | ||
FOnNotification & GetNotificationEvent() |
Virtualization/VirtualizationSystem.h | ||
virtual void GetPayloadActivityInfo
(
GetPayloadActivityInfoFuncRef Func |
Virtualization/VirtualizationSystem.h | ||
| Access profiling info for all backends combined. | Virtualization/VirtualizationSystem.h | ||
bool Initialize
(
const FInitParams& InitParams |
Initialize the system from the parameters given in the FInitParams structure. | Virtualization/VirtualizationSystem.h | |
bool IsEnabled() |
Poll to see if content virtualization is enabled or not. | Virtualization/VirtualizationSystem.h | |
bool IsPushingEnabled
(
EStorageType StorageType |
Poll to see if pushing virtualized content to the given backend storage type is enabled or not. | Virtualization/VirtualizationSystem.h | |
bool PullData
(
TArrayView< FPullRequest > Requests |
Pull a number of payloads from the virtualization backends. | Virtualization/VirtualizationSystem.h | |
FCompressedBuffer PullData
(
const FIoHash& Id |
Pull a single payload from the virtualization backends. | Virtualization/VirtualizationSystem.h | |
bool PullData
(
FPullRequest Request |
Pull a single payload from the virtualization backends. | Virtualization/VirtualizationSystem.h | |
bool PushData
(
TArrayView< FPushRequest > Requests, |
Push one or more payloads to a backend storage system. | Virtualization/VirtualizationSystem.h | |
bool PushData
(
FPushRequest Request, |
Push a payload to the virtualization backends. | Virtualization/VirtualizationSystem.h | |
bool PushData
(
const FIoHash& Id, |
Push a payload to the virtualization backends. | Virtualization/VirtualizationSystem.h | |
EQueryResult QueryPayloadStatuses
(
TArrayView< const FIoHash > Ids, |
Query if a number of payloads exist or not in the given storage type. | Virtualization/VirtualizationSystem.h | |
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 | |
FVirtualizationResult TryVirtualizePackages
(
TConstArrayView< FString > PackagePaths, |
Runs the virtualization process on a set of packages. | Virtualization/VirtualizationSystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IVirtualizationSystem & Get () |
Gain access to the current virtualization system active for the project. | Virtualization/VirtualizationSystem.h | |
static FName GetSystemName() |
Returns the name of the currently initialized system, will be NAME_None if initialization failed or the system is not enabled | Virtualization/VirtualizationSystem.h | |
static bool IsInitialized() |
Returns true if a virtualization system has been initialized and false if not | Virtualization/VirtualizationSystem.h |
See Also
- VirtualizationManager