FAutoPackageBackup | Unreal Engine 5.7 Documentation

API > API/Editor > API/Editor/UnrealEd

Class that houses various static utility functions to allow for packages to be backed-up to a special auto save/backup directory. Backups are traditionally made before a save occurs to a package, to help guard against corruption/data loss.


Name	FAutoPackageBackup
Type	class
Header File	/Engine/Source/Editor/UnrealEd/Public/PackageBackup.h
Include Path	#include "PackageBackup.h"

Syntax

class FAutoPackageBackup

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FAutoPackageBackup ( const FAutoPackageBackup& )	Copy constructor, Destructor, and Self-assignment operator all left private and un-implemented in order to prevent the class from being instantiated	PackageBackup.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FAutoPackageBackup()		PackageBackup.h

Functions

Static

Name	Remarks	Include Path
static bool BackupPackage ( const UPackage& InPackage )	Create a backup of the specified package.	PackageBackup.h
static bool BackupPackages ( const TArray< UPackage* >& InPackages )	Create a backup of the specified packages.	PackageBackup.h
static FString GetBackupDirectory()	Helper function that returns the directory to store package backups in.	PackageBackup.h
static int32 GetBackupInterval ()	Helper function that returns the time in between backups of a package before another backup of the same package should be considered valid.	PackageBackup.h
static int32 GetMaxAllowedBackupSpace ()	Helper function that returns the maximum amount of space the user has designated to allow for package backups.	PackageBackup.h
static bool IsPackageBackupEnabled ()	Helper function that returns whether the user has package backups enabled or not.	PackageBackup.h
static bool PerformBackupSpaceMaintenance ( TArray< struct FBackupFileInfo >& InBackupFiles, int64 InSpaceUsed, int64 InSpaceRequired )	Deletes old backed-up package files until the provided amount of space (in bytes) is available to use in the backup directory.	PackageBackup.h
static bool ShouldBackupPackage ( const UPackage& InPackage, FString& OutFilename )	Helper function designed to determine if the provided package should be backed up or not.	PackageBackup.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FAutoPackageBackup & operator= ( const FAutoPackageBackup& )		PackageBackup.h