1. Epic GamesDeveloper
  3. UUpdateManager

UUpdateManager

Update manager

API > API/Plugins > API/Plugins/Hotfix

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Config&61;Engine&41;  
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

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual void

CheckComplete ( EUpdateCompletionStatus Result,
bool bUpdateTimestamp
)

 Announce that the update check has completed
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Public function Const EUpdateCompletionStatus  
Protected function Const UGameInstance *  
Protected function Const THotfixManager *  
Public function Const float  
Public function Const EUpdateState  
Protected function Const UWorld *  
Public function Const bool  
Protected function Virtual void Availability check complete
Protected function Virtual void Initial preload of assets is complete
Protected function void

InstallBundlePatchCheckComplete ( EInstallBundleManagerPatchCheckResult PatchResult
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Protected function Virtual void Called when application has been reactivated
Protected function Virtual void Called when application is about to be deactivated
Protected function void Callback when detecting platform environment completes
Protected function Virtual void  
Protected function Virtual void

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

  
Protected function Virtual void

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

  
Public function FOnUpdateCheckComplete &  
Public function FOnUpdateHotfixProcessedFile &  
Public function FOnUpdateHotfixProgress &  
Public function FOnUpdateStatusChanged &  
Protected function void  
Protected function void Register deactivate/reactivate delegates
Public function Virtual void

Reset ()

 Reset so you can call StartCheck again
Public function void Put the update manager in a pending state so it can alert the game that a check is imminent
Protected function Virtual void Change the state of the update manager
Public function Virtual void

StartCheck ( bool bInCheckHotfixOnly
)

 Start an patch and hotfix check
Protected function Virtual EUpdateStartResult

StartCheckInternal ( bool bInCheckHotfixOnly
)

 Internal call for StartCheck
Protected function Virtual void Check for the availability of changed hotfix files only
Protected function Virtual void Hotfix check
Protected function Virtual void Preload game assets after patch/hotfix check is complete but before game is alerted
Protected function Virtual void Patch check
Protected function Virtual void Query for platform environment before continuing with hotfixing This configures the Mcp backend correctly
Public function void

StartUpdateCheck ( const FString& ContextName
)

 Start an update check using properties defined by context.
Protected function Virtual EUpdateStartResult

StartUpdateCheckInternal ( const FUpdateContextDefinition& ContextDefinition
)

 Internal call for StartUpdateCheck
Protected function Virtual bool

Tick ( float DeltaTime
)

 Tick function during initial preload
Protected function void Unregister deactivate/reactivate delegates

Overridden from UObject

  Type Name Description
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Protected function Virtual void

PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

 Called from ReloadConfig after the object has reloaded its configuration data.

Enums

  Type Name Description
Protected enum EUpdateStartResult    

Typedefs

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

Deprecated Variables

  Type Name Description
Protected variable bool bCheckOSSForUpdate Set FPatchCheck::bCheckOSSForUpdate using section [PatchCheck] instead.
Protected variable bool bCheckPlatformOSSForUpdate Set FPatchCheck::bCheckPlatformOSSForUpdate using section [PatchCheck] instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page