IVirtualizationSourceControlUtilities::SyncPayloadSidecarFile

Given a package path this method will attempt to sync th e.upayload file that is compatible with the .uasset file of the package.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h

Include

#include "Virtualization/VirtualizationSystem.h"

Syntax

bool SyncPayloadSidecarFile
(
    const FPackagePath & PackagePath
)

Remarks

Given a package path this method will attempt to sync th e.upayload file that is compatible with the .uasset file of the package.

We can make the following assumptions about the relationship between .uasset and .upayload files: 1) The .uasset may be submitted to perforce without the .upayload (if the payload is unmodified) 2) If the payload is modified then the .uasset and .upayload file must be submitted at the same time. 3) The caller has already checked the existing .upayload file (if any) to see if it contains the payload that they are looking for.

If the above is true then we can sync the .upayload file to the same perforce changelist as the .uasset and be sure that we have the correct version.

that this has only been tested with perforce and so other source control solutions are currently unsupported.