IpDrv.OnlinePlaylistManager

Extends

Object

Modifiers

native inherits ( FTickableObject ) config ( Playlist )

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

Core.Object
|   
+-- IpDrv.OnlinePlaylistManager

Delegates Summary
		OnPlaylistPopulationDataUpdated ()
		OnReadPlaylistComplete ()

Functions Summary
		DetermineFilesToDownload ()
		DownloadPlaylist ()))
		FinalizePlaylistObjects ()
		GetContentIdsFromPlaylist (int PlaylistId, ut array<int> ContentIds))
	OnlineGameSettings	GetGameSettings (int PlaylistId, nt GameSettingsId))
	class<Inventory>	GetInventorySwapFromPlaylist (int PlaylistId, lass<Inventory> SourceInventory))
		GetLoadBalanceIdFromPlaylist (int PlaylistId, ut int LoadBalanceId))
		GetMapCycleFromPlaylist (int PlaylistId, ut array<name> MapCycle))
		GetPopulationInfoFromPlaylist (int PlaylistId, ut int WorldwideTotal, ut int RegionTotal))
		GetTeamInfoFromPlaylist (int PlaylistId, ut int TeamSize, ut int TeamCount, ut int MaxPartySize))
	string	GetUrlFromPlaylist (int PlaylistId))
	bool	HasAnyGameSettings (int PlaylistId))
	bool	IsPlaylistArbitrated (int PlaylistId))
		OnReadDataCenterIdComplete (bool bWasSuccessful, tring FileName))
		OnReadPlaylistPopulationComplete (bool bWasSuccessful, tring FileName))
		OnReadTitleFileComplete (bool bWasSuccessful, tring FileName))
		ParseDataCenterId (const out array<byte> Data)
		ParsePlaylistPopulationData (const out array<byte> Data)
	bool	PlaylistSupportsDedicatedServers (int PlaylistId))
		ReadDataCenterId ()))
		ReadPlaylistPopulation ()))
		Reset ()))
		SendPlaylistPopulationUpdate (int NumPlayers))

CurrentPlaylistId Source code

The playlist id that is being played

DataCenterFileName Source code

The name of the datacenter file to request

DataCenterId Source code

The datacenter id to use for this machine

DatastoresToRefresh Source code

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

DownloadCount Source code

Used to know when we should finalize the objects

EventsInterfaceName Source code

The name of the interface to request as our upload object

MinPlaylistIdToReport Source code

The lowest number playlist id to report to the backend. Used to turn off "not mp" playlist ids

NextPlaylistPopulationUpdateTime Source code

The next time the playlist population data needs to be sent

PlaylistFileNames Source code

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

PlaylistPopulationUpdateInterval Source code

How often (in seconds) we should update the population data

Playlists Source code

This is the complete set of playlists available to choose from

PopulationData Source code

The list of playlists and the number of players in them

PopulationFileName Source code

The name of the population data file to request

RegionTotalPlayers Source code

The total number of players across all playlists in the region

SuccessfulCount Source code

Incremented when successful to determine whether to update at all

TitleFileInterface Source code

Cached object ref that we use for accessing the TitleFileInterface

VersionNumber Source code

The version number of the playlist that was downloaded

WorldwideTotalPlayers Source code

The total number of players across all playlists worldwide

ConfiguredGameSetting Source code

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

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

GameSettings:

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

GameSettingsClassName:

The name of the class to load and instance

Url:

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

InventorySwap Source code

Allows for per playlist inventory swapping
Original:

The inventory to replace

SwapTo:

The inventory to replace it with

Playlist Source code

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

Whether dedicated server searches are supported with this playlist

bIsArbitrated:

Whether this playlist is arbitrated or not

ConfiguredGames:

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

ContentIds:

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

InventorySwaps:

The list of inventory swaps for the playlist

LoadBalanceId:

The load balance id for this playlist

LocalizationString:

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

MapCycle:

The custom map cycle for this playlist

MaxPartySize:

The max party size for this playlist if different from the team size

Name:

The string to use in the UI for this playlist

PlaylistId:

The unique id for this playlist

TeamCount:

The number of teams per match if different from the defaults

TeamSize:

The number of players per team if different from the defaults

Url:

URL to append to the MP options in GameInfo.InitGame()

PlaylistPopulation Source code

Holds the overall and per region playlist population numbers
PlaylistId:

The unique id for this playlist

RegionTotal:

The total for the player's region

WorldwideTotal:

The total across all regions

OnPlaylistPopulationDataUpdated Source code

Tells the listener when playlist population data was updated

OnReadPlaylistComplete Source code

Delegate fired when the playlist has been downloaded and processed

DetermineFilesToDownload Source code

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

DownloadPlaylist Source code

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

FinalizePlaylistObjects Source code

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

GetContentIdsFromPlaylist Source code

Finds the specified playlist and return the content ids in the out var
@param PlaylistId the playlist being searched for
@param ContentIds the list to set the content ids in

GetGameSettings Source code

Finds the game settings object associated with this playlist and game settings id
@param PlaylistId the playlist we are searching
@param GameSettingsId the game settings id being searched for
@return the game settings specified or None if not found

GetInventorySwapFromPlaylist Source code

Searches for a per playlist inventory swap
@param PlaylistId the playlist we are checking for swaps in
@param SourceInventory the source item we are checking for swapping
@return the swapped item or the original if not found

GetLoadBalanceIdFromPlaylist Source code

Determine the load balance id for the specified playlist and returns it in the out vars. The load balance id can be used to change the match mode during a search.
@param PlaylistId the playlist being searched for
@param LoadBalanceId out var getting the id for load balancing

GetMapCycleFromPlaylist Source code

Finds the specified playlist and returns the map cycle for it
@param PlaylistId the playlist being searched for
@param MapCycle the out var that gets the map cycle

GetPopulationInfoFromPlaylist Source code

Finds the population information for the specified playlist and returns it in the out vars
@param PlaylistId the playlist being searched for
@param WorldwideTotal out var getting the number of players worldwide
@param RegionTotal out var getting the number of players in this region

GetTeamInfoFromPlaylist Source code

Finds the team information for the specified playlist and returns it in the out vars
@param PlaylistId the playlist being searched for
@param TeamSize out var getting the number of players per team
@param TeamCount out var getting the number of teams per match
@param MaxPartySize out var getting the number of players per party

GetUrlFromPlaylist Source code

Finds the specified playlist and returns any additional URL options
@param PlaylistId the playlist being searched for
@return the URL string associated with this playlist

HasAnyGameSettings Source code

Determine if any game settings exist for the given playlistid
@param PlaylistId playlist to check for game settings
@return TRUE if game settings exist for the given id

IsPlaylistArbitrated Source code

Determine if the given playlist entry is arbitrated or not
@param PlaylistId the playlist being searched for
@return TRUE if the playlist is arbitrated

OnReadDataCenterIdComplete Source code

Notifies us when the download of a file is complete
@param bWasSuccessful true if the download completed ok, false otherwise
@param FileName the file that was downloaded (or failed to)

OnReadPlaylistPopulationComplete Source code

Notifies us when the download of a file is complete
@param bWasSuccessful true if the download completed ok, false otherwise
@param FileName the file that was downloaded (or failed to)

OnReadTitleFileComplete Source code

Notifies us when the download of the playlist file is complete
@param bWasSuccessful true if the download completed ok, false otherwise
@param FileName the file that was downloaded (or failed to)

ParseDataCenterId Source code

Converts the data into the datacenter id
@param Data the data that was downloaded

ParsePlaylistPopulationData Source code

Converts the data into the structure used by the playlist manager
@param Data the data that was downloaded

PlaylistSupportsDedicatedServers Source code

ReadDataCenterId Source code

Asks the network backend which datacenter this machine is to use

ReadPlaylistPopulation Source code

Reads the player population data for playlists by region

Reset Source code

Allows the playlists to be re-requested from the server

SendPlaylistPopulationUpdate Source code

Called once enough time has elapsed that a playlist update is required
@param NumPlayers the numbers of players to report (easier to get at in native)

defaultproperties
{
	PopulationFileName="PlaylistPopulationData.ini"
	DataCenterFileName="DataCenter.Id"
}