Gets a section of the leaderboard. This function is helpful for displaying leaderboards in your game. By default, this function returns the top 100 entries.
This function returns a subsection of the top 1000 entries. Rankings are tracked for users below the top 1000, but they can only be accessed using the GetRank function.
The leaderboard name
The start index of the selection. Defaults to 0, which is the top of the leaderboard.
The number of entries to retrieve. Defaults to 100.
This function is restricted to only in-editor use.
Used to create an ephemeral leaderboard within the editor to test functions and views when using a leaderboard.
Clears all entries from the leaderboard. You can also reset a leaderboard using the https://create.airship.gg website.
Sends an update to the provided leaderboard. The scores provided are added to, subtracted from, or replace the existing scores based on the leaderboard configuration.
The name of the leaderboard that should be updated with the given scores
An object containing a map of ids and scores.
This service provides access to leaderboard information as well as methods for updating existing leaderboards. Leaderboards must be created using the https://create.airship.gg website. Once a leaderboard is created, it can be accessed using the name provided during setup.