CloudOnce v2.7.5
Unified Game Services API
CloudOnce.Internal.UnifiedLeaderboard Class Reference

A cross-platform leaderboard. Class has a method for submitting score that will work for all supported platforms. Only intended to be used by CloudOnce internal classes. More...

Public Member Functions

 UnifiedLeaderboard (string internalID, string platformID)
 A cross-platform leaderboard. Class has a method for submitting score that will work for all supported platforms. Only intended to be used by CloudOnce internal classes. More...
 
void SubmitScore (long score, Action< CloudRequestResult< bool > > onComplete=null)
 Reports a score to this leaderboard. More...
 
void ShowOverlay ()
 Shows the native leaderboards overlay for this specific leaderboard.
 
void LoadScores (Action< IScore[]> callback)
 Load a default set of scores from this leaderboard. More...
 

Properties

string ID [get]
 The ID for the current platform.
 

Detailed Description

A cross-platform leaderboard. Class has a method for submitting score that will work for all supported platforms. Only intended to be used by CloudOnce internal classes.

Constructor & Destructor Documentation

◆ UnifiedLeaderboard()

CloudOnce.Internal.UnifiedLeaderboard.UnifiedLeaderboard ( string  internalID,
string  platformID 
)
inline

A cross-platform leaderboard. Class has a method for submitting score that will work for all supported platforms. Only intended to be used by CloudOnce internal classes.

Parameters
internalIDThe internal ID for this leaderboard.
platformIDThe current platform ID for this leaderboard. Set to string.Empty if platform is not supported.

Member Function Documentation

◆ LoadScores()

void CloudOnce.Internal.UnifiedLeaderboard.LoadScores ( Action< IScore[]>  callback)
inline

Load a default set of scores from this leaderboard.

Parameters
callbackCallback with scores.

◆ SubmitScore()

void CloudOnce.Internal.UnifiedLeaderboard.SubmitScore ( long  score,
Action< CloudRequestResult< bool > >  onComplete = null 
)
inline

Reports a score to this leaderboard.

Parameters
scoreThe score to submit.
onCompleteCallback that will be called to report the result of the operation: true on success, false otherwise. If false, an error message will be included in the callback.

The documentation for this class was generated from the following file: