1. Epic GamesDeveloper
  3. UUpdateManager

UUpdateManager

Update manager

API > API/Plugins > API/Plugins/Hotfix

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
   
Name UUpdateManager
Type class
Header File /Engine/Plugins/Online/OnlineFramework/Source/Hotfix/Public/UpdateManager.h
Include Path #include "UpdateManager.h"

Syntax

UCLASS (MinimalAPI, Config=Engine)  
class UUpdateManager : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UUpdateManager()

   UpdateManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UUpdateManager()

   UpdateManager.h  

Enums

Protected

Name Remarks
EUpdateStartResult  

Typedefs

Name Type Remarks Include Path
DelayCb TFunction< void(void)> Fire a delegate after a given amount of time UpdateManager.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCurrentUpdatePatchCheckEnabled bool   UpdateManager.h  
ProcessedUpdateContextDefinitions TMap< FString, FUpdateContextDefinition > Update context definitions which have been processed following a config update. UpdateManager.h  
UpdateCheckCompleteDelegates FOnUpdateCheckComplete Check completion listeners UpdateManager.h  
UpdateCompletionEnum TObjectPtr< UEnum >   UpdateManager.h  
UpdateContextDefinitions TArray< FUpdateContextDefinition > Definitions for update behavior. UpdateManager.h
  • Config
UpdateContextDefinitionUnknown FUpdateContextDefinition Definition to use when a context lookup fails. UpdateManager.h
  • Config
UpdateHotfixProcessedFile FOnUpdateHotfixProcessedFile Hotfix application process listeners UpdateManager.h  
UpdateHotfixProgressDelegate FOnUpdateHotfixProgress Hotfix download progress listeners UpdateManager.h  
UpdateStateEnum TObjectPtr< UEnum > Helpers String output UpdateManager.h  
UpdateStatusChangedDelegates FOnUpdateStatusChanged Status update listeners UpdateManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

EUpdateCompletionStatus GetCompletionResult()

   UpdateManager.h  

float GetLoadProgress()

   UpdateManager.h  

EUpdateState GetUpdateState()

   UpdateManager.h  

bool HasCompletedInitialUpdate()

   UpdateManager.h  

bool IsActivelyUpdating()

   UpdateManager.h  

bool IsBlockingForInitialLoadEnabled()

   UpdateManager.h  

bool IsHotfixingEnabled()

   UpdateManager.h  

bool IsUpdating()

   UpdateManager.h  

FOnUpdateCheckComplete & OnUpdateCheckComplete()

   UpdateManager.h  

FOnUpdateHotfixProcessedFile & OnUpdateHotfixProcessedFile()

   UpdateManager.h  

FOnUpdateHotfixProgress & OnUpdateHotfixProgress()

   UpdateManager.h  

FOnUpdateStatusChanged & OnUpdateStatusChanged()

   UpdateManager.h  

void RegisterStatsCollector ( const TSharedPtr< IUpdateManagerStatsCollector >& InStatsCollector
)

 Register a collector for acquiring stats related to the update check process. UpdateManager.h  

virtual void Reset()

 Reset so you can call StartCheck again UpdateManager.h  

void SetPending()

 Put the update manager in a pending state so it can alert the game that a check is imminent UpdateManager.h  

void StartUpdateCheck ( const FString& ContextName
)

 Start an update check using properties defined by context. UpdateManager.h  

UE_DEPRECATED_FORGAME (

  1. 1,
    "UUpdateManager::StartCheck is deprecated,
    please use StartUpdateCheck instead."
    )
 Start an patch and hotfix check UpdateManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CheckComplete ( EUpdateCompletionStatus Result,
bool bUpdateTimestamp
)

 Announce that the update check has completed UpdateManager.h  

virtual bool ChecksEnabled()

   UpdateManager.h  

UGameInstance * GetGameInstance()

   UpdateManager.h  

THotfixManager * GetHotfixManager()

   UpdateManager.h  

UWorld * GetWorld()

   UpdateManager.h  

virtual void HotfixAvailabilityCheckComplete ( EHotfixResult Result
)

 Availability check complete UpdateManager.h  

virtual void InitialPreloadComplete()

 Initial preload of assets is complete UpdateManager.h  

void InstallBundlePatchCheckComplete ( EInstallBundleManagerPatchCheckResult PatchResult
)

   UpdateManager.h  

virtual void OnApplicationHasReactivated()

 Called when application has been reactivated UpdateManager.h  

virtual void OnApplicationWillDeactivate()

 Called when application is about to be deactivated UpdateManager.h  

virtual void OnHotfixCheckComplete ( EHotfixResult Result
)

   UpdateManager.h  

virtual void OnHotfixProcessedFile ( const FString& FriendlyName,
const FString& CachedName
)

   UpdateManager.h  

virtual void OnHotfixProgress ( uint32 NumDownloaded,
uint32 TotalFiles,
uint64 NumBytes,
uint64 TotalBytes
)

   UpdateManager.h  

void PatchCheckComplete ( EPatchCheckResult PatchResult
)

   UpdateManager.h  

void RegisterDelegates()

 Register deactivate/reactivate delegates UpdateManager.h  

virtual void SetUpdateState ( EUpdateState NewState
)

 Change the state of the update manager UpdateManager.h  

virtual void StartHotfixAvailabilityCheck()

 Check for the availability of changed hotfix files only UpdateManager.h  

virtual void StartHotfixCheck()

 Hotfix check UpdateManager.h  

virtual void StartInitialPreload()

 Preload game assets after patch/hotfix check is complete but before game is alerted UpdateManager.h  

virtual void StartPatchCheck()

 Patch check UpdateManager.h  

virtual EUpdateStartResult StartUpdateCheckInternal ( const FUpdateContextDefinition& ContextDefinition
)

 Internal call for StartUpdateCheck UpdateManager.h  

virtual bool Tick ( float DeltaTime
)

 Tick function during initial preload UpdateManager.h  

UE_DEPRECATED_FORGAME (

  1. 25,
    "UUpdateManager::EnvironmentWantsPatchCheck is deprecated,
    please override FPatchCheck::EnvironmentWantsPatchCheck instead."
    ) const
   UpdateManager.h  

UE_DEPRECATED_FORGAME (

  1. 1,
    "UUpdateManager::StartCheckInternal is deprecated,
    please override StartCheckUpdateInternal instead."
    )
 Internal call for StartCheck UpdateManager.h  

void UnregisterDelegates()

 Unregister deactivate/reactivate delegates UpdateManager.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   UpdateManager.h  

virtual void PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

   UpdateManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page