Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Hotfix > UUpdateManager

Light Theme

Dark Theme

UUpdateManager

Update manager

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UUpdateManager

References

Module	Hotfix
Header	/Engine/Plugins/Online/OnlineFramework/Source/Hotfix/Public/UpdateManager.h
Include	#include "UpdateManager.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine)
class UUpdateManager : public UObject

Remarks

Update manager

Checks the system and/or backend for the possibility of a patch and hotfix Will not apply a hotfix if a pending patch is available Notifies the game of the result of the check

possibly requires UI to prevent user from playing if a patch is available
possibly requires UI to prevent user from player if a hotfix requires a reload of existing data

Variables

	Name	Description
int32	AppSuspendedUpdateCheckTimeSeconds	If application is suspended longer than this, trigger an update check when resuming
bool	bCheckHotfixAvailabilityOnly	Is this run only checking and not applying
bool	bInitialUpdateFinished	Has the first update completed
bool	bPlatformEnvironmentDetected	True if we've already detected the backend environment
EUpdateState	CurrentUpdateState	Current state of the update
FDateTime	DeactivatedTime	Time when application was deactivated
float	HotfixAvailabilityCheckCompleteDelay	Amount of time to wait between the internal hotfix availability check completing and advancing to the next stage
float	HotfixCheckCompleteDelay	Amount of time to wait between the internal hotfix check completing and advancing to the next stage
FDelegateHandle	HotfixCompleteDelegateHandle	Delegates to hotfix updates
FDelegateHandle	HotfixProcessedFileDelegateHandle
FDelegateHandle	HotfixProgressDelegateHandle
EUpdateCompleti...	LastCompletionResult	Last update check result (0:normal, 1:availability only)
EHotfixResult	LastHotfixResult	Result of the last hotfix
EInstallBundleM...	LastPatchCheckResult	Result of the last patch check
FDateTime[2]	LastUpdateCheck	Timestamp of last update check (0:normal, 1:availability only)
double	LoadStartTime	The time at which we started the initial load after updates completed
FTimerHandle	StartCheckInternalTimerHandle
FDelegateHandle	TickerHandle
float	UpdateCheckAvailabilityCompleteDelay	Amount of time to wait at the end of the entire check before notifying listening entities (availability check only)
float	UpdateCheckCompleteDelay	Amount of time to wait at the end of the entire check before notifying listening entities
int32	WorstNumFilesPendingLoadViewed	What was the maximum number of pending async loads we've seen so far

Constructors

	Name	Description
	UUpdateManager()

Destructors

	Name	Description
	~UUpdateManager()

Functions

	Name	Description
void	CheckComplete ( EUpdateCompletionStatus Result, bool bUpdateTimestamp )	Announce that the update check has completed
bool	ChecksEnabled()
bool	EnvironmentWantsPatchCheck()
EUpdateCompl...	GetCompletionResult()
UGameInstanc...	GetGameInstance()
THotfixManag...	GetHotfixManager()
float	GetLoadProgress()
EUpdateState	GetUpdateState()
UWorld *	GetWorld()
bool	HasCompletedInitialUpdate()
void	HotfixAvailabilityCheckComplete ( EHotfixResult Result )	Availability check complete
void	InitialPreloadComplete()	Initial preload of assets is complete
void	InstallBundlePatchCheckComplete ( EInstallBundleManagerPatchCheckResu... )
bool	IsActivelyUpdating()
bool	IsBlockingForInitialLoadEnabled()
bool	IsHotfixingEnabled()
bool	IsUpdating()
void	OnApplicationHasReactivated()	Called when application has been reactivated
void	OnApplicationWillDeactivate()	Called when application is about to be deactivated
void	OnDetectPlatformEnvironmentComplete ( const FOnlineError& Result )	Callback when detecting platform environment completes
void	OnHotfixCheckComplete ( EHotfixResult Result )
void	OnHotfixProcessedFile ( const FString& FriendlyName, const FString& CachedName )
void	OnHotfixProgress ( uint32 NumDownloaded, uint32 TotalFiles, uint64 NumBytes, uint64 TotalBytes )
FOnUpdateChe...	OnUpdateCheckComplete()
FOnUpdateHot...	OnUpdateHotfixProcessedFile()
FOnUpdateHot...	OnUpdateHotfixProgress()
FOnUpdateSta...	OnUpdateStatusChanged()
void	PatchCheckComplete ( EPatchCheckResult PatchResult )
void	RegisterDelegates()	Register deactivate/reactivate delegates
void	Reset()	Reset so you can call StartCheck again
void	SetPending()	Put the update manager in a pending state so it can alert the game that a check is imminent
void	SetUpdateState ( EUpdateState NewState )	Change the state of the update manager
void	StartCheck ( bool bInCheckHotfixOnly )	Start an patch and hotfix check
EUpdateStart...	StartCheckInternal ( bool bInCheckHotfixOnly )	Internal call for StartCheck
void	StartHotfixAvailabilityCheck()	Check for the availability of changed hotfix files only
void	StartHotfixCheck()	Hotfix check
void	StartInitialPreload()	Preload game assets after patch/hotfix check is complete but before game is alerted
void	StartPatchCheck()	Patch check
void	StartPlatformEnvironmentCheck()	Query for platform environment before continuing with hotfixing This configures the Mcp backend correctly
bool	Tick ( float DeltaTime )	Tick function during initial preload
void	UnregisterDelegates()	Unregister deactivate/reactivate delegates

Enums

	Name	Description
	EUpdateStartResult

Typedefs

Name	Description
DelayCb	Fire a delegate after a given amount of time

Deprecated Variables

		Name	Description
	bool	bCheckOSSForUpdate	Set [FPatchCheck::bCheckOSSForUpdate](API\Plugins\PatchCheck\FPatchCheck\bCheckOSSForUpdate) using section [PatchCheck] instead.
	bool	bCheckPlatformOSSForUpdate	Set [FPatchCheck::bCheckPlatformOSSForUpdate](API\Plugins\PatchCheck\FPatchCheck\bCheckPlatformOSSForUpdate) using section [PatchCheck] instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss