Mostly Harmless

UE3:IniLocPatcherMcp (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> IniLocPatcher >> IniLocPatcherMcp
Package: 
IpDrv

This class is the MCP specific version of the INI/Loc patcher. It reads from MCP first and then uses the base class for fallback cases

Properties[edit]

Downloader[edit]

Type: OnlineTitleFileDownloadMcp

Modifiers: transient

Cached object ref that we use for accessing the downloader

McpDownloaderName[edit]

Type: name

Modifiers: config

Used to look up the MCP downloader object by name

Instance functions[edit]

AddReadFileDelegate[edit]

function AddReadFileDelegate (delegate<IniLocPatcher.OnReadTitleFileCompleteReadTitleFileCompleteDelegate)

Overrides: IniLocPatcher.AddReadFileDelegate

Adds the specified delegate to the registered downloader. Since the file read can come from different objects, this method hides that detail, but still lets callers get notifications

Parameters:

  • ReadTitleFileCompleteDelegate - the delegate to set

ClearCachedFiles[edit]

function ClearCachedFiles ()

Overrides: IniLocPatcher.ClearCachedFiles

Clears any cached files

ClearReadFileDelegate[edit]

function ClearReadFileDelegate (delegate<IniLocPatcher.OnReadTitleFileCompleteReadTitleFileCompleteDelegate)

Overrides: IniLocPatcher.ClearReadFileDelegate

Clears the specified delegate from any registered downloaders

Parameters:

  • ReadTitleFileCompleteDelegate - the delegate to remove from the downloader

DownloadFiles[edit]

function DownloadFiles ()

Overrides: IniLocPatcher.DownloadFiles

Reads the set of files from the online service

Init[edit]

function Init ()

Overrides: IniLocPatcher.Init

Initializes the patcher, sets delegates, vars, etc.

OnReadFileComplete[edit]

function OnReadFileComplete (bool bWasSuccessful, string FileName)

Overrides: IniLocPatcher.OnReadFileComplete

Notifies us when the download of a file is complete

Parameters:

  • bWasSuccessful - true if the download completed ok, false otherwise
  • FileName - the file that was downloaded (or failed to)