I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

Difference between revisions of "UE3:IniLocPatcherMcp (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
(Talk)
Line 34: Line 34:
 
'''Parameters:'''
 
'''Parameters:'''
 
* ''ReadTitleFileCompleteDelegate'' - the delegate to set
 
* ''ReadTitleFileCompleteDelegate'' - the delegate to set
 +
 +
====ClearCachedFiles====
 +
{{code|function '''ClearCachedFiles''' ()}}
 +
 +
'''Overrides:''' {{tl|ClearCachedFiles|IniLocPatcher}}
 +
 +
Clears any cached files
  
 
====ClearReadFileDelegate====
 
====ClearReadFileDelegate====

Revision as of 06:24, 17 January 2010

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

Downloader

Type: OnlineTitleFileDownloadMcp

Modifiers: transient

Cached object ref that we use for accessing the downloader

McpDownloaderName

Type: name

Modifiers: config

Used to look up the MCP downloader object by name

Instance functions

AddReadFileDelegate

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

function ClearCachedFiles ()

Overrides: IniLocPatcher.ClearCachedFiles

Clears any cached files

ClearReadFileDelegate

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

function DownloadFiles ()

Overrides: IniLocPatcher.DownloadFiles

Reads the set of files from the online service

Init

function Init ()

Overrides: IniLocPatcher.Init

Initializes the patcher, sets delegates, vars, etc.

OnReadFileComplete

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)