UE3:IniLocPatcher (UDK)

Object >> IniLocPatcher

Package: 

Engine

Direct subclass:

IniLocPatcherMcp

This class reads a set of files from Live/NP servers and uses it to update the game.

Properties

Files

Type: array<IniLocFileEntry>

Modifiers: config

The list of files to request from the online service

SystemInterface

Type: OnlineSystemInterface

Modifiers: transient

Cached access to the system interface

Structs

IniLocFileEntry

Modifiers: native

Holds the list of files to download and their download state

string Filename 

The file to read from the online service

OnlineSubsystem.EOnlineEnumerationReadState ReadState 

The state of that read

Delegates

OnReadTitleFileComplete

delegate OnReadTitleFileComplete (bool bWasSuccessful, string FileName)

Delegate fired when a file read from the network platform's title specific storage is complete

Parameters:

• bWasSuccessful - whether the file read was successful or not
• FileName - the name of the file this was for

Functions

Native functions

ProcessIniLocFile

native function ProcessIniLocFile (string FileName, out array<byte> FileData)

Takes the data, merges with the INI/Loc system, and then reloads the config for the affected objects

Parameters:

• FileName - the name of the file being merged
• FileData - the file data to merge with the config cache

Other instance functions

AddFileToDownload

function AddFileToDownload (string FileName)

Adds a loc/ini file to download

Parameters:

• FileName - the file to download

AddReadFileDelegate

function AddReadFileDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)

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

function ClearCachedFiles ()

Tells any subclasses to clear their cached file data

ClearReadFileDelegate

function ClearReadFileDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)

Clears the specified delegate from any registered downloaders

Parameters:

• ReadTitleFileCompleteDelegate - the delegate to remove from the downloader

DownloadFiles

function DownloadFiles ()

Reads the set of files from the online service

Init

function Init ()

Initializes the patcher, sets delegates, vars, etc.

OnReadFileComplete

function OnReadFileComplete (bool bWasSuccessful, string FileName)

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)