Engine.OnlineStatsRead

Extends

OnlineStats

Modifiers

native abstract

Stats class that holds the read request definitions and the resulting data

Core.Object
|   
+-- Engine.OnlineStats
   |   
   +-- Engine.OnlineStatsRead

Direct Known Subclasses:

UTLeaderboardRead, UTStatsReadAchievements

Functions Summary
		AddPlayer (string PlayerName, niqueNetId PlayerId)
	bool	GetFloatStatValueForPlayer (UniqueNetId PlayerId, nt StatColumnNo, ut float StatValue)
	bool	GetIntStatValueForPlayer (UniqueNetId PlayerId, nt StatColumnNo, ut int StatValue)
	int	GetRankForPlayer (UniqueNetId PlayerId)
	bool	GetStatValueForPlayerAsString (UniqueNetId PlayerId, nt StatColumnNo, ut String StatValue)
	bool	IsStatZero (UniqueNetId PlayerId, nt StatColumnNo)
		OnReadComplete ()
	bool	SetFloatStatValueForPlayer (UniqueNetId PlayerId, nt StatColumnNo, loat StatValue)
	bool	SetIntStatValueForPlayer (UniqueNetId PlayerId, nt StatColumnNo, nt StatValue)

ColumnIds Source code

The columns to read in the view we are interested in

ColumnMappings Source code

Provides metadata for column ids so that we can present their human readable form

Rows Source code

The rows of data returned by the online service

SortColumnId Source code

The column id to use for sorting rank

TitleId Source code

An optional title id to specify when reading stats (zero uses the default for the exe)

TotalRowsInView Source code

The total number of rows in the view

ViewId Source code

The unique id of the view that these stats are from

ViewName Source code

The name of the view in human readable terms

ColumnMetaData Source code

Provides human readable values for column ids
ColumnName:

The name displayed in column headings in the UI

Id:

Id for the given string

Name:

Human readable form of the Id

OnlineStatsColumn Source code

A single instance of a stat in a row
ColumnNo:

The ordinal value of the column

StatValue:

The value of the stat for this column

OnlineStatsRow Source code

Holds a single player's set of data for this stats view
Columns:

The set of columns (stat instances) for this row

NickName:

Player's online nickname

PlayerId:

The unique player id of the player these stats are for

Rank:

The rank of the player in this stats view

AddPlayer Source code

Adds a player to the results if not present
@param PlayerName the name to place in the data
@param PlayerId the player to search for

GetFloatStatValueForPlayer Source code

Searches the stat rows for the player and then finds the stat value from the specified column within that row
@param PlayerId the player to search for
@param StatColumnNo the column number to look up
@param StatValue the out value that is assigned the stat
@return whether the value was found for the player/column or not

GetIntStatValueForPlayer Source code

Searches the stat rows for the player and then finds the stat value from the specified column within that row
@param PlayerId the player to search for
@param StatColumnNo the column number to look up
@param StatValue the out value that is assigned the stat
@return whether the value was found for the player/column or not

GetRankForPlayer Source code

Searches the rows for the player and returns their rank on the leaderboard
@param PlayerId the player to search for
@return the rank for the player

GetStatValueForPlayerAsString Source code

Searches the stat rows for the player and then finds the stat value from the specified column within that row
@param PlayerId the player to search for
@param StatColumnNo the column number to look up
@param StatValue the out value that is assigned the stat in string form
@return whether the value was found for the player/column or not

IsStatZero Source code

Searches the stat rows for the player and then returns whether or not the stat is 0. Only works on float, double, int, int64, and empty stat types. Others return FALSE.
@param PlayerId the player to search for
@param StatColumnNo the column number to look up
@return whether the value is 0 (or equivalent)

OnReadComplete Source code

This event is called post read complete so that the stats object has a chance synthesize new stats from returned data, e.g. ratios, averages, etc.

SetFloatStatValueForPlayer Source code

Searches the stat rows for the player and then sets the stat value from the specified column within that row
@param PlayerId the player to search for
@param StatColumnNo the column number to look up
@param StatValue the value to set that column to
@return whether the value was found for the player/column or not

SetIntStatValueForPlayer Source code

Searches the stat rows for the player and then sets the stat value from the specified column within that row
@param PlayerId the player to search for
@param StatColumnNo the column number to look up
@param StatValue the value to set that column to
@return whether the value was found for the player/column or not