McpLeaderboardsBase¶

Class in IpDrv · IpDrv.McpLeaderboardsBase · abstract, config

Object › McpServiceBase › McpLeaderboardsBase

Using it from Lua

h7.find_all("McpLeaderboardsBase")            -- live instances
h7.find_class("IpDrv.McpLeaderboardsBase")   -- the class
h7.hook("IpDrv.McpLeaderboardsBase.ClearAllLeaderboardEntries", fn)

Enums¶

McpLeaderboardColumnType

MLCT_SUM = 0, MLCT_MAX_VAL = 1, MLCT_MIN_VAL = 2, MLCT_LAST = 3

McpLeaderboardTimeframe

MLT_ALL_TIME = 0, MLT_DAILY = 1, MLT_WEEKLY = 2, MLT_MONTHLY = 3

Structs¶

McpLeaderboard

Field	Type
`LeaderboardName`	`String`
`RatingColumn`	`String`

McpLeaderboardColumn

Field	Type
`Name`	`String`
`Type`	`McpLeaderboardColumnType`

McpLeaderboardColumnEntry

Field	Type
`Name`	`String`
`Value`	`int`

McpLeaderboardEntry

Field	Type
`McpId`	`String`
`LeaderboardName`	`String`
`Timeframe`	`McpLeaderboardTimeframe`
`RatingValue`	`int`
`Ranking`	`int`
`Percentile`	`int`

Properties¶

Name	Type	Notes
`McpLeaderboardsClassName`	`string`	config

Functions¶

Name	Declaration
`ClearAllLeaderboardEntries`	`function ClearAllLeaderboardEntries()`
`ClearLeaderboardEntriesForLeaderboard`	`function ClearLeaderboardEntriesForLeaderboard(String LeaderboardName)`
`ClearLeaderboardEntriesForMcpId`	`function ClearLeaderboardEntriesForMcpId(String McpId)`
`CreateInstance`	`static final function McpLeaderboardsBase CreateInstance()`
`GetEntriesForLeaderboard`	`function GetEntriesForLeaderboard(String LeaderboardName, out array<McpLeaderboardEntry> Entries)`
`GetLeaderboardByColumnByRange`	`function GetLeaderboardByColumnByRange(String LeaderboardName, McpLeaderboardTimeframe Timeframe, String ColumnName, int Min, int Max, out array<McpLeaderboardEntry> Entries)`
`GetLeaderboardEntries`	`function GetLeaderboardEntries(String McpId, out array<McpLeaderboardEntry> Entries, optional String LeaderboardName)`
`GetLeaderboardEntriesForUsers`	`function GetLeaderboardEntriesForUsers(const out array McpIds, out array<McpLeaderboardEntry> Entries, optional String LeaderboardName)`
`GetLeaderboards`	`function GetLeaderboards(out array<McpLeaderboard> Leaderboards)`
`OnReadLeaderboardEntriesComplete`	`delegate OnReadLeaderboardEntriesComplete(bool bWasSuccessful, String Error, String LeaderboardName, McpLeaderboardTimeframe Timeframe)`
`OnReadLeaderboardsComplete`	`delegate OnReadLeaderboardsComplete(bool bWasSuccessful, String Error)`
`OnWriteLeaderboardEntryComplete`	`delegate OnWriteLeaderboardEntryComplete(bool bWasSuccessful, String Error, String McpId, String LeaderboardName)`
`ReadLeaderboardColumnByRange`	`function ReadLeaderboardColumnByRange(String LeaderboardName, McpLeaderboardTimeframe Timeframe, String ColumnName, int Min, int Max, int NumToRead)`
`ReadLeaderboardEntries`	`function ReadLeaderboardEntries(const out array McpIds, String LeaderboardName, McpLeaderboardTimeframe Timeframe, optional bool bSkipRankAndPercentile)`
`ReadLeaderboards`	`function ReadLeaderboards()`
`WriteLeaderboardEntry`	`function WriteLeaderboardEntry(String McpId, String LeaderboardName, const out array<McpLeaderboardColumnEntry> Columns)`

Inherited¶

From	Members
McpServiceBase	2 properties, 16 functions
Object	13 properties, 308 functions