| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
GameKit.Leaderboard.SetRange
Sets the numerical score rankings to return from the search.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| GameKit | 8.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |
MBS( "GameKit.Leaderboard.SetRange"; LeaderboardIdentifier; Start; Length ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| LeaderboardIdentifier | The identifier of the leaderboard. | |
| Start | The new start value of the range. | 1 |
| Length | The new length value of the range. | 10 |
Result
Returns OK or error.
Description
Sets the numerical score rankings to return from the search.The range property is ignored if the leaderboard request was initialized using the player list option. Otherwise, the range property is used to filter which scores are returned to your game. For example, if you specified a range of [1,10], after the search is complete, your game receives the best ten scores. The default range is [1,25].
The minimum index is 1. The maximum length is 100.
See also
- GameKit.Leaderboard.GetRange
- GameKit.Leaderboard.Image
- GameKit.Leaderboard.Loading
- GameKit.Leaderboard.MaxRange
- GameKit.Leaderboard.Scores
- GameKit.Leaderboard.SetTimeScope
- GameKit.Leaderboard.Title
- GameKit.LeaderboardSet.Image
- GameKit.LeaderboardSet.Title
This function is free to use.
Created 5th November 2018, last changed 8th November 2018
GameKit.Leaderboard.SetPlayerScope - GameKit.Leaderboard.SetTimeScope
