Class EOSLeaderboardManager

Namespace

PlayEveryWare.EpicOnlineServices.Samples

Class EOSLeaderboardManager is a simplified wrapper for EOS Leaderboard Interface.

public class EOSLeaderboardManager : IEOSSubManager

Inheritance

object

EOSLeaderboardManager

Constructors

EOSLeaderboardManager()

public EOSLeaderboardManager()

Methods

CopyUserScore(ProductUserId, out LeaderboardRecord?)

Retrieves the leaderboard record for the specified user id.

public Result CopyUserScore(ProductUserId userId, out LeaderboardRecord? record)

Parameters

userId ProductUserId

UserId to query.

record LeaderboardRecord?

LeaderboardRecord output from the query.

Returns

Result

Result of the copying the record for the user id.

GetCachedDefinitionFromId(string)

Get cached Leaderboard Defintion given a LeaderboardId.

public Definition? GetCachedDefinitionFromId(string leaderboardId)

Parameters

leaderboardId string

Specified LeaderboardID

Returns

Definition?

Leaderboard Defintion

GetCachedDefinitionIds()

Get list of cached Leaderboard Definitions

public List<string> GetCachedDefinitionIds()

Returns

List<string>

List(string) cached DefinitionIds

GetCachedLeaderboardDefinitions(out Dictionary<string, Definition>)

Returns cached Leaderboard Dictionary where LeaderboardId is the key and Definition is the value.

public bool GetCachedLeaderboardDefinitions(out Dictionary<string, Definition> LeaderboardDefinitions)

Parameters

LeaderboardDefinitions Dictionary<string, Definition>

Out parameter returns Dictionary where LeaderboardId is the key and LeaderboardDefinitions is the value.

Returns

bool

True if LeaderboardDefinitions has changed since last call.

GetCachedLeaderboardRecords(out List<LeaderboardRecord>)

Returns cached LeaderboardRecord List.

public bool GetCachedLeaderboardRecords(out List<LeaderboardRecord> LeaderboardsRecords)

Parameters

LeaderboardsRecords List<LeaderboardRecord>

Out parameter returns List of LeaderboardRecord.

Returns

bool

True if LeaderboardRecords has changed since last call.

GetCachedLeaderboardUserScores(out Dictionary<string, List<LeaderboardUserScore>>)

Returns cached LeaderboardUserScore Dictionary where LeaderboardId is the key.

public bool GetCachedLeaderboardUserScores(out Dictionary<string, List<LeaderboardUserScore>> LeaderboardUserScores)

Parameters

LeaderboardUserScores Dictionary<string, List<LeaderboardUserScore>>

Out parameter returns Dictionary where LeaderboardId is the key and LeaderboardUserScore is the value.

Returns

bool

True if LeaderboardUserScores has changed since last call.

GetCachedUserScoresFromLeaderboardId(string)

Get cached Leaderboard UserScores given a LeaderboardId.

public List<LeaderboardUserScore> GetCachedUserScoresFromLeaderboardId(string leaderboardId)

Parameters

leaderboardId string

Leaderboard ID

Returns

List<LeaderboardUserScore>

Leaderboard UserScores

OnLoggedIn()

User Logged In actions

public void OnLoggedIn()

OnLoggedOut()

User Logged Out actions

public void OnLoggedOut()

QueryDefinitions(OnLeaderboardCallback)

(async) Initiate query for Leaderboard Definitions.

public void QueryDefinitions(EOSLeaderboardManager.OnLeaderboardCallback QueryDefinitionsCompleted)

Parameters

QueryDefinitionsCompleted EOSLeaderboardManager.OnLeaderboardCallback

QueryRanks(string, OnLeaderboardCallback)

(async) Initiate query for Leaderboard Ranks given a Leaderboard ID.

public void QueryRanks(string leaderboardId, EOSLeaderboardManager.OnLeaderboardCallback QueryRanksCompleted)

Parameters

leaderboardId string

Leaderboard ID

QueryRanksCompleted EOSLeaderboardManager.OnLeaderboardCallback

QueryUserScores(List<string>, List<ProductUserId>, OnLeaderboardCallback)

(async) Initiate query for Leaderboard UserScores given a list of LeaderboardIds and list of Users.

public void QueryUserScores(List<string> leaderboardIds, List<ProductUserId> userIds, EOSLeaderboardManager.OnLeaderboardCallback QueryUserScoresCompleted)

Parameters

leaderboardIds List<string>

List of LeaderboardIds to query.

userIds List<ProductUserId>

List of UserId to query.

QueryUserScoresCompleted EOSLeaderboardManager.OnLeaderboardCallback