Navigation
API > API/Plugins > API/Plugins/StormSyncCore
This class exposes a set of static methods to manipulate Ava Pak files, creation and extraction.
| Name | FStormSyncCoreUtils |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/StormSync/Source/StormSyncCore/Public/StormSyncCoreUtils.h |
| Include Path | #include "StormSyncCoreUtils.h" |
Syntax
class FStormSyncCoreUtils
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnFileAdded | TBaseDelegate_OneParam< void, const FStormSyncFileDependency & > | Delegate type triggered on pak buffer creation for each added file | StormSyncCoreUtils.h |
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool CreatePakBuffer
(
const TArray< FName >& InPackageNames, |
Attempts to create an ava pak buffer using a memory archive from the provided list of Package Names. | StormSyncCoreUtils.h | |
static bool CreatePakBufferWithDependencies
(
const TArray< FName >& InPackageNames, |
Recursively get dependencies for provided list of Package Names and attempts to create an ava pak buffer using a memory archive. | StormSyncCoreUtils.h | |
static FStormSyncFileDependency CreateStormSyncFile
(
const FName& InPackageName |
Creates a new FStormSyncFileDependency and initialize filesystem related information | StormSyncCoreUtils.h | |
static bool ExtractPakBuffer
(
FArchive& InPakArchive, |
Main entry point for unpacking. | StormSyncCoreUtils.h | |
static bool GetAssetData
(
const FString& InPackageName, |
Helper function to retrieve the FAssetData associated with a given file. | StormSyncCoreUtils.h | |
static TFuture< TArray< FStormSyncFileDependency > > GetAvaFileDependenciesAsync
(
const TArray< FName >& InPackageNames, |
Async version of FStormSyncCoreUtils::GetAvaFileDependenciesFromPackageNames to return a list of File Dependencies (with info about file size, asset path, timestamp file hash, etc.) from the provided list of package names. | StormSyncCoreUtils.h | |
static bool GetAvaFileDependenciesForPackages
(
const TArray< FName >& InPackageNames, |
Similar to GetDependenciesForPackages internally searching for any recursive dependencies. | StormSyncCoreUtils.h | |
static TArray< FStormSyncFileDependency > GetAvaFileDependenciesFromPackageNames
(
const TArray< FName >& InPackageNames, |
Creates a list of FStormSyncFileDependency (with info such as asset path, file size, timestamp and file hash) from the supplied list of package names. | StormSyncCoreUtils.h | |
| Gathers a list of PackageNames dependencies referenced by the supplied packages. | StormSyncCoreUtils.h | ||
static FString GetHumanReadableByteSize
(
uint64 InSize |
Converts the provided bytes size into a human readable string. | StormSyncCoreUtils.h | |
static TArray< FStormSyncFileModifierInfo > GetSyncFileModifiers
(
const TArray< FName >& InPackageNames, |
Figures out the files that needs to be synced based on local and remote list of dependencies. | StormSyncCoreUtils.h | |
static bool IsValidDependency
(
const FString& InDependencyName |
Filters out any dependency we don't want to consider for a pak | StormSyncCoreUtils.h | |
static void RecursiveGetDependencies
(
const FName& InPackageName, |
Gets the dependencies of the specified package recursively. | StormSyncCoreUtils.h | |
| Validates all assets for existence on disk | StormSyncCoreUtils.h |