SC_Score
Instances of SC_Score model the score achieved by a particular user in a particular game session.
Instances of SC_Score must, at minimum, contain a result, which is typically the main numerical outcome achieved by a user of the game.
-
A score can be a simple single-digit score or a score that is based on time.
-
A score can also be more complex with multiple criteria, such as the number of hits made, the average speed, or the maximum speed that can be modeled by using:
-
A minor or secondary result
-
A level that indicates the game stage at which the score was achieved
-
A mode that indicates the gameplay setting at which the score was achieved
-
-
A score is submitted to the server, and sorting of the scores affects who wins a challenge or who ranks better in the leaderboards.
-
Scores can be sorted in ascending or descending order.
The result, minor result, and level are used for score comparison purposes. You can configure the comparison schema at https://developer.scoreloop.com .
Modes are important as Scoreloop generates separate leaderboards for each mode defined for a game.
Scores are managed by two data controllers:
-
An SC_ScoreController , which manages single instances of SC_Score
-
An SC_ScoresController , which manages lists of SC_Score
Instances of SC_Score can also contain information about score rank, which is the position of the score on a Scoreloop leaderboard. However, the rank of a score will generally only have a meaningful value when it is retrieved from the server using an SC_ScoresController .
Basic use: Score objects are returned in the following scenarios:
-
After creating a score object by calling SC_Client_CreateScore()
-
From a SC_ScoresController after the controller has requested scores from the server, the list of score objects can be accessed by using the calling SC_ScoresController_GetScores() .
See also: