Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

GameKit.GameCenterView.SetLeaderboardTimeScope

Sets time scope.

Component Version macOS Windows Linux Server iOS SDK
GameKit 8.5 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "GameKit.GameCenterView.SetLeaderboardTimeScope"; Scope )   More

Parameters

Parameter Description Example
Scope The new time scope.
Can be Today, Week or AllTime.
"Week"

Result

Returns OK or error.

Description

Sets time scope.
A filter used to restrict the search to scores that were showed within a specific period of time.
Can be "Week", "Today" or "AllTime".

This property determines which tab view of the scores screen is displayed to the player. The default value is AllTime, which shows the best score each player has earned. For more information on time scopes, see Leaderboard functions.
When the leaderboard is presented, the value of this property determines the initial tab that is displayed to the player. As the player changes which tab they view, the leaderboardTimeScope property is automatically updated. For example, to preserve the player’s selections, you can read the leaderboardTimeScope property after the screen is dismissed, and set that value the next time you initialize the view controller.

See also

This function is free to use.

Created 5th November 2018, last changed 8th November 2018


GameKit.GameCenterView.SetLeaderboardIdentifier - GameKit.GameCenterView.SetScriptTrigger