UE3:OnlineStatsInterface (UDK)

Interface >> OnlineStatsInterface

Package: 

Engine

Known implementing classes:

OnlineSubsystemPC

This interface in other games:

UT3

This interface deals with reading & writing stats to the online subsytem.

Delegates

OnFlushOnlineStatsComplete

delegate OnFlushOnlineStatsComplete (name SessionName, bool bWasSuccessful)

Delegate called when the stats flush operation has completed

Parameters:

• SessionName - the name of the session having stats flushed for
• bWasSuccessful - true if the async action completed without error, false if there was an error

OnReadOnlineStatsComplete

delegate OnReadOnlineStatsComplete (bool bWasSuccessful)

Notifies the interested party that the last stats read has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnRegisterHostStatGuidComplete

delegate OnRegisterHostStatGuidComplete (bool bWasSuccessful)

Called when the host stat guid registration is complete

Parameters:

• bWasSuccessful - whether the registration has completed or not

Instance functions

AddFlushOnlineStatsCompleteDelegate

function AddFlushOnlineStatsCompleteDelegate (delegate<OnFlushOnlineStatsComplete> FlushOnlineStatsCompleteDelegate)

Adds the delegate used to notify the gameplay code that the stats flush has completed

Parameters:

• FlushOnlineStatsCompleteDelegate - the delegate to use for notifications

AddReadOnlineStatsCompleteDelegate

function AddReadOnlineStatsCompleteDelegate (delegate<OnReadOnlineStatsComplete> ReadOnlineStatsCompleteDelegate)

Adds the delegate to a list used to notify the gameplay code that the stats read has completed

Parameters:

• ReadOnlineStatsCompleteDelegate - the delegate to use for notifications

AddRegisterHostStatGuidCompleteDelegate

function AddRegisterHostStatGuidCompleteDelegate (delegate<OnRegisterHostStatGuidComplete> RegisterHostStatGuidCompleteDelegate)

Adds the delegate for notifying when the host guid registration is done

Parameters:

• RegisterHostStatGuidCompleteDelegate - the delegate to use for notifications

ClearFlushOnlineStatsCompleteDelegate

function ClearFlushOnlineStatsCompleteDelegate (delegate<OnFlushOnlineStatsComplete> FlushOnlineStatsCompleteDelegate)

Clears the delegate used to notify the gameplay code that the stats flush has completed

Parameters:

• FlushOnlineStatsCompleteDelegate - the delegate to use for notifications

ClearReadOnlineStatsCompleteDelegate

function ClearReadOnlineStatsCompleteDelegate (delegate<OnReadOnlineStatsComplete> ReadOnlineStatsCompleteDelegate)

Removes the delegate from the notify list

Parameters:

• ReadOnlineStatsCompleteDelegate - the delegate to use for notifications

ClearRegisterHostStatGuidCompleteDelegateDelegate

function ClearRegisterHostStatGuidCompleteDelegateDelegate (delegate<OnRegisterHostStatGuidComplete> RegisterHostStatGuidCompleteDelegate)

Clears the delegate used to notify the gameplay code

Parameters:

• RegisterHostStatGuidCompleteDelegate - the delegate to use for notifications

FlushOnlineStats

function bool FlushOnlineStats (name SessionName)

Commits any changes in the online stats cache to the permanent storage

Parameters:

• SessionName - the name of the session having stats flushed for

Returns:

TRUE if the call is successful, FALSE otherwise

FreeStats

function FreeStats (OnlineStatsRead StatsRead)

Cleans up any platform specific allocated data contained in the stats data

Parameters:

• StatsRead - the object to handle per platform clean up on

GetClientStatGuid

function string GetClientStatGuid ()

Reads the client's stat guid that was generated by registering the host's guid Used for synching up stats. Only valid on the client. Only callable after the host registration has completed

Returns:

the client's stat guid

GetHostStatGuid

function string GetHostStatGuid ()

Reads the host's stat guid for synching up stats. Only valid on the host.

Returns:

the host's stat guid

ReadOnlineStats

function bool ReadOnlineStats (const out array<OnlineSubsystem.UniqueNetId> Players, OnlineStatsRead StatsRead)

Reads a set of stats for the specified list of players

Parameters:

• Players - the array of unique ids to read stats for
• StatsRead - holds the definitions of the tables to read the data from and results are copied into the specified object

Returns:

TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsByRank

function bool ReadOnlineStatsByRank (OnlineStatsRead StatsRead, optional int StartIndex, optional int NumToRead)

Reads stats by ranking. This grabs the rows starting at StartIndex through NumToRead and places them in the StatsRead object.

Parameters:

• StatsRead - holds the definitions of the tables to read the data from and results are copied into the specified object
• StartIndex - the starting rank to begin reads at (1 for top)
• NumToRead - the number of rows to read (clamped at 100 underneath)

Returns:

TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsByRankAroundPlayer

function bool ReadOnlineStatsByRankAroundPlayer (byte LocalUserNum, OnlineStatsRead StatsRead, optional int NumRows)

Reads stats by ranking centered around a player. This grabs a set of rows above and below the player's current rank

Parameters:

• LocalUserNum - the local player having their stats being centered upon
• StatsRead - holds the definitions of the tables to read the data from and results are copied into the specified object
• NumRows - the number of rows to read above and below the player's rank

Returns:

TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsForFriends

function bool ReadOnlineStatsForFriends (byte LocalUserNum, OnlineStatsRead StatsRead)

Reads a player's stats and all of that player's friends stats for the specified set of stat views. This allows you to easily compare a player's stats to their friends.

Parameters:

• LocalUserNum - the local player having their stats and friend's stats read for
• StatsRead - holds the definitions of the tables to read the data from and results are copied into the specified object

Returns:

TRUE if the call is successful, FALSE otherwise

RegisterHostStatGuid

function bool RegisterHostStatGuid (const out string HostStatGuid)

Registers the host's stat guid with the client for verification they are part of the stat. Note this is an async task for any backend communication that needs to happen before the registration is deemed complete

Parameters:

• HostStatGuid - the host's stat guid

Returns:

TRUE if the call is successful, FALSE otherwise

RegisterStatGuid

function bool RegisterStatGuid (OnlineSubsystem.UniqueNetId PlayerId, const out string ClientStatGuid)

Registers the client's stat guid on the host to validate that the client was in the stat. Used for synching up stats. Only valid on the host.

Parameters:

• PlayerId - the client's unique net id
• ClientStatGuid - the client's stat guid

Returns:

TRUE if the call is successful, FALSE otherwise

WriteOnlinePlayerScores

function bool WriteOnlinePlayerScores (name SessionName, int LeaderboardId, const out array<OnlineSubsystem.OnlinePlayerScore> PlayerScores)

Writes the score data for the match

Parameters:

• SessionName - the name of the session the player stats are being recorded for
• LeaderboardId - the leaderboard to write the score information to
• PlayerScores - the list of players, teams, and scores they earned

Returns:

TRUE if the call is successful, FALSE otherwise

WriteOnlineStats

function bool WriteOnlineStats (name SessionName, OnlineSubsystem.UniqueNetId Player, OnlineStatsWrite StatsWrite)

Writes out the stats contained within the stats write object to the online subsystem's cache of stats data. Note the new data replaces the old. It does not write the data to the permanent storage until a FlushOnlineStats() call or a session ends. Stats cannot be written without a session or the write request is ignored. No more than 5 stats views can be written to at a time or the write request is ignored.

Parameters:

• SessionName - the name of the session the stats are being written to
• Player - the player to write stats for
• StatsWrite - the object containing the information to write

Returns:

TRUE if the call is successful, FALSE otherwise