Scores

Description

Scores are used to rank players against one another. Scores are generated automatically for standard leaderboards whenever achievements with points are earned. Scores are to be submitted manually for custom leaderboards. When a leaderboard ranking is requested, a score is a simple number. A score is unique to a player, leaderboard, and time span.

Once a score is submitted for a custom leaderboard, r4nkt will make sure that it is represented for each time span. If a player already has a score for a leaderboard and time-span combination, then r4nkt will determine whether or not the new score is better. If so, then it will be updated. If not, then it will be ignored. You will be informed of the time spans for which the submitted score was an improvement.

Properties

When submitting a score for a custom leaderboard, it can have following properties:

Name

Type

Default

custom_leaderboard_id

string

-

custom_player_id

string

-

score

integer

empty

date_time_utc

string

empty

Leaderboard

A score is submitted for a specific custom leaderboard, which is identified by its custom_id property.

Scores submitted to standard leaderboards will be rejected.

Player

A score is submitted for a specific player, which is identified by the player's custom_id property.

When submitting scores, if the custom_player_id is not recognized, then a new player will be created.

Score

The score is an integer. Currently, it must be a value between 0 and 9,223,372,036,854,775,807, inclusive.

Date/time

The date_time_utc value is the date/time (UTC) for when the score should be recorded. It defaults to the current date/time. If provided, however, it must be a date/time in the past. Scores may not be submitted for the future.