UE3:OnlinePlaylistManager (UDK)

Object >> OnlinePlaylistManager

Package: 

Engine

This class holds the set of playlists that the game exposes, handles downloading updates to the playlists via MCP/TitleFiles, and creates the game settings objects that make up a playlist

Properties

DatastoresToRefresh

Type: array<name>

Modifiers: config

The set of UIDataStore_GameResource objects to refresh once the download has completed

DownloadCount

Type: int

Used to know when we should finalize the objects

PlaylistFileNames

Type: array<string>

The file names to request when downloading a playlist from MCP/TMS/etc

Playlists

Type: array<Playlist>

Modifiers: config

This is the complete set of playlists available to choose from

SuccessfulCount

Type: int

Incremented when successful to determine whether to update at all

VersionNumber

Type: int

Modifiers: config

The version number of the playlist that was downloaded

Structs

ConfiguredGameSetting

Modifiers: native

Contains a game settings class name to load and instance using the specified URL to override defaults

int GameSettingId 

The unique (within the playlist) id for this game setting

string GameSettingsClassName 

The name of the class to load and instance

string Url 

The URL to use to replace settings with (see UpdateFromURL())

OnlineGameSettings GameSettings 

Holds the object that was created for this entry in a playlist

Playlist

Modifiers: native

A playlist contains 1 or more game configurations that players can choose between

array<ConfiguredGameSetting> ConfiguredGames 

Holds the list of game configurations that are part of this playlist

int PlaylistId 

The unique id for this playlist

string LocalizationString 

The string to use to lookup the display name for this playlist

array<int> ContentIds 

The set of content/maps (or DLC bundles) that must be present in order to play on this playlist

int TeamSize 

The number of players per team if different from the defaults

int TeamCount 

The number of teams per match if different from the defaults

string Name 

The string to use in the UI for this playlist

bool bIsArbitrated 

Whether this playlist is arbitrated or not

Delegates

OnReadPlaylistComplete

delegate OnReadPlaylistComplete ()

Delegate fired when the playlist has been downloaded and processed

Functions

Native functions

DetermineFilesToDownload

native function DetermineFilesToDownload ()

Uses the current loc setting and game ini name to build the download list

FinalizePlaylistObjects

native function FinalizePlaylistObjects ()

Uses the configuration data to create the requested objects and then applies any specific game settings changes to them

Other instance functions

DownloadPlaylist

function DownloadPlaylist ()

Reads the playlist from either MCP or from some form of title storage

GetContentIdsFromPlaylist

function GetContentIdsFromPlaylist (int PlaylistId, out array<int> ContentIds)

Finds the specified playlist and return the content ids in the out var

Parameters:

• PlaylistId - the playlist being searched for
• ContentIds - the list to set the content ids in

GetGameSettings

function OnlineGameSettings GetGameSettings (int PlaylistId, int GameSettingsId)

Finds the game settings object associated with this playlist and game settings id

Parameters:

• PlaylistId - the playlist we are searching
• GameSettingsId - the game settings id being searched for

Returns:

the game settings specified or None if not found

GetTeamInfoFromPlaylist

function GetTeamInfoFromPlaylist (int PlaylistId, out int TeamSize, out int TeamCount)

Finds the team information for the specified playlist and returns it in the out vars

Parameters:

• PlaylistId - the playlist being searched for
• TeamSize - out var getting the number of players per team
• TeamCount - out var getting the number of teams per match

HasAnyGameSettings

function bool HasAnyGameSettings (int PlaylistId)

Determine if any game settings exist for the given playlistid

Parameters:

• PlaylistId - playlist to check for game settings

Returns:

TRUE if game settings exist for the given id

OnReadTitleFileComplete

function OnReadTitleFileComplete (bool bWasSuccessful, string FileName)

Notifies us when the download of the playlist file is complete

Parameters:

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

Reset

function Reset ()

Allows the playlists to be re-requested from the server