FStormSyncCoreUtils

This class exposes a set of static methods to manipulate Ava Pak files, creation and extraction.

API > API/Plugins > API/Plugins/StormSyncCore

References

   
Module StormSyncCore
Header /Engine/Plugins/Experimental/StormSync/Source/StormSyncCore/Public/StormSyncCoreUtils.h
Include #include "StormSyncCoreUtils.h"

Syntax

class FStormSyncCoreUtils

Remarks

This class exposes a set of static methods to manipulate Ava Pak files, creation and extraction.

Functions

  Type Name Description
Public function Static bool

CreatePakBuffer ( const TArray< FName >& InPackageNames,
TArray< uint8 >& OutPakBuffer,
FText& OutErrorText,
const FOnFileAdded& InOnFileAdded
)

 Attempts to create an ava pak buffer using a memory archive from the provided list of Package Names.
Public function Static bool

CreatePakBufferWithDependencies ( const TArray< FName >& InPackageNames,
TArray< uint8 >& OutPakBuffer,
FText& OutErrorText,
const FOnFileAdded& InOnFileAdded
)

 Recursively get dependencies for provided list of Package Names and attempts to create an ava pak buffer using a memory archive.
Public function Static FStormSyncFileDependency

CreateStormSyncFile ( const FName& InPackageName
)

 Creates a new FStormSyncFileDependency and initialize filesystem related information
Public function Static bool

ExtractPakBuffer ( const TArray< uint8 >& InPakBuffer,
const FStormSyncCoreExtractArgs& InExtractArgs,
TMap< FString, FString >& OutSuccessfullyExtractedPackages,
TArray< FText >& OutErrors
)

 Main entry point for unpacking.
Public function Static bool

GetAssetData ( const FString& InPackageName,
TArray< FAssetData >& OutAssets,
TArray< FName >& OutDependencies
)

 Helper function to retrieve the FAssetData associated with a given file.
Public function Static TFuture< TArray< FStormSyncFileDependency > >

GetAvaFileDependenciesAsync ( const TArray< FName >& InPackageNames,
const bool bInShouldValidatePackages,
EAsyncExecution InThreadType
)

 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.
Public function Static bool

GetAvaFileDependenciesForPackages ( const TArray< FName >& InPackageNames,
TArray< FStormSyncFileDependency >& OutFileDependencies,
FText& OutErrorText,
const bool bInShouldValidatePackages
)

 Similar to GetDependenciesForPackages internally searching for any recursive dependencies.
Public function Static TArray< FStormSyncFileDependency >

GetAvaFileDependenciesFromPackageNames ( const TArray< FName >& InPackageNames,
bool bInShouldIncludeInvalid
)

 Creates a list of FStormSyncFileDependency (with info such as asset path, file size, timestamp and file hash) from the supplied list of package names.
Public function Static bool

GetDependenciesForPackages ( const TArray< FName >& InPackageNames,
TArray< FName >& OutDependencies,
FText& OutErrorText,
const bool bInShouldValidatePackages
)

 Gathers a list of PackageNames dependencies referenced by the supplied packages.
Public function Static FString Converts the provided bytes size into a human readable string.
Public function Static TArray< FStormSyncFileModifierInfo >

GetSyncFileModifiers ( const TArray< FName >& InPackageNames,
const TArray< FStormSyncFileDependency >& InRemoteDependencies
)

 Figures out the files that needs to be synced based on local and remote list of dependencies.

Typedefs

Name Description
FOnFileAdded Delegate type triggered on pak buffer creation for each added file

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page