| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
Component: GameKit
Functions for Game Center on MacOS and iOS
Please read documentation from Apple on the concept of Game Center.
Your iOS/Mac app needs to be setup with Apple and get entitlements and signature.
You may need to request a MBS Plugin with GameKit functions included as the public plugin does not include GameKit functions.
| Version | macOS | Windows | Linux | Server | iOS SDK |
| 8.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |
| Item | Details |
|---|---|
| GameKit.Achievement.Completed Queries completed state. | Mac/iOS 8.5 |
| GameKit.Achievement.GetPercentComplete Queries percent complete. | Mac/iOS 8.5 |
| GameKit.Achievement.GetShowsCompletionBanner Queries whether to show completion banner. | Mac/iOS 8.5 |
| GameKit.Achievement.LastReportedDate Queries last reported time. | Mac/iOS 8.5 |
| GameKit.Achievement.New Initializes a new achievement object for the local player. | Mac/iOS 8.5 |
| GameKit.Achievement.Player Queries player identifier for the related player. | Mac/iOS 8.5 |
| GameKit.Achievement.SetPercentComplete Sets percent complete. | Mac/iOS 8.5 |
| GameKit.Achievement.SetShowsCompletionBanner Sets whether to show completion banner. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.AchievedDescription Queres description text. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.GroupIdentifier Queries group identifier. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.Hidden Queries hidden flag. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.Image Loads the image property for a completed achievement. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.IncompleteAchievementImage Queries a common image for incomplete achievements. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.MaximumPoints Queries maximum points. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.PlaceholderCompletedAchievementImage Returns a common image for completed achievements. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.Replayable Queries whether achievement is replay-able. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.Title Queries localized title for the achievement. | Mac/iOS 8.5 |
| GameKit.AchievementDescription.UnachievedDescription Queries description text. | Mac/iOS 8.5 |
| GameKit.AnonymousGuestPlayer Creates a new guest player with the designated identifier. | Mac/iOS 8.5 |
| GameKit.Challenge.Achievement Queries achievement to complete. | Mac/iOS 8.5 |
| GameKit.Challenge.CompletionDate The date the challenge was completed. | Mac/iOS 8.5 |
| GameKit.Challenge.Decline Declines a challenge. | Mac/iOS 8.5 |
| GameKit.Challenge.IssueDate The date the challenge was issued. | Mac/iOS 8.5 |
| GameKit.Challenge.IssuingPlayer Queries issuing player. | Mac/iOS 8.5 |
| GameKit.Challenge.Message A text message that describes the challenge. | Mac/iOS 8.5 |
| GameKit.Challenge.ReceivingPlayer Queries receiving player. | Mac/iOS 8.5 |
| GameKit.Challenge.Score Returns the score to beat. | Mac/iOS 8.5 |
| GameKit.Challenge.State The current state of the challenge. | Mac/iOS 8.5 |
| GameKit.DefaultLeaderboardIdentifier Loads the category identifier for the local player’s default leaderboard. | Mac/iOS 8.5 |
| GameKit.GameCenterView.Dismiss Dismisses the dialog. | Mac/iOS 8.5 |
| GameKit.GameCenterView.GetLeaderboardIdentifier Queries leaderboard. | Mac/iOS 8.5 |
| GameKit.GameCenterView.GetLeaderboardTimeScope Queries time scope. | Mac/iOS 8.5 |
| GameKit.GameCenterView.GetViewState Queries view state. | Mac/iOS 8.5 |
| GameKit.GameCenterView.Initialize Initializes Game Center view. | Mac/iOS 8.5 |
| GameKit.GameCenterView.Present Presents the dialog. | Mac/iOS 8.5 |
| GameKit.GameCenterView.SetLeaderboardIdentifier Sets leaderboard. | Mac/iOS 8.5 |
| GameKit.GameCenterView.SetLeaderboardTimeScope Sets time scope. | Mac/iOS 8.5 |
| GameKit.GameCenterView.SetScriptTrigger Sets script trigger to call when dialog finishes. | Mac/iOS 8.5 |
| GameKit.GameCenterView.SetViewState Sets the view state. | Mac/iOS 8.5 |
| GameKit.GameCenterView.ShowBannerWithTitle Displays a banner to the player. | Mac/iOS 8.5 |
| GameKit.Initialize Initialized GameKit. | Mac/iOS 8.5 |
| GameKit.Leaderboard.GetPlayerScope Queries the player scope. | Mac/iOS 8.5 |
| GameKit.Leaderboard.GetRange Queries the numerical score rankings to return from the search. | Mac/iOS 8.5 |
| GameKit.Leaderboard.GetTimeScope Queries time scope. | Mac/iOS 8.5 |
| GameKit.Leaderboard.GroupIdentifier Queries the identifier for the group the leaderboard is part of. | Mac/iOS 8.5 |
| GameKit.Leaderboard.Image Queries the image associated with the default leaderboard. | Mac/iOS 8.5 |
| GameKit.Leaderboard.LoadScores Retrieves a set of scores from Game Center. | Mac/iOS 8.5 |
| GameKit.Leaderboard.Loading Queries whether this leaderboard is loading. | Mac/iOS 8.5 |
| GameKit.Leaderboard.LocalPlayerScore Queries the score earned by the local player. | Mac/iOS 8.5 |
| GameKit.Leaderboard.MaxRange Queries the size of the leaderboard. | Mac/iOS 8.5 |
| GameKit.Leaderboard.New Creates new leaderboard. | Mac/iOS 8.5 |
| GameKit.Leaderboard.Scores Returns list of score identifiers. | Mac/iOS 8.5 |
| GameKit.Leaderboard.SetPlayerScope Sets the player scope. | Mac/iOS 8.5 |
| GameKit.Leaderboard.SetRange Sets the numerical score rankings to return from the search. | Mac/iOS 8.5 |
| GameKit.Leaderboard.SetTimeScope Sets time scope. | Mac/iOS 8.5 |
| GameKit.Leaderboard.Title Queries the localized title for the leaderboard. | Mac/iOS 8.5 |
| GameKit.LeaderboardSet.GroupIdentifier Queries identifies the group that the leaderboard set belongs to. | Mac/iOS 8.5 |
| GameKit.LeaderboardSet.Image Load the image associated with the leaderboard set. | Mac/iOS 8.5 |
| GameKit.LeaderboardSet.Title Queries localized title for the leaderboard set. | Mac/iOS 8.5 |
| GameKit.LoadAchievementDescriptions Downloads the achievement descriptions from Game Center. | Mac/iOS 8.5 |
| GameKit.LoadAchievements Loads achievements. | Mac/iOS 8.5 |
| GameKit.LoadLeaderboardSets Load all of the leaderboard sets for the current game. | Mac/iOS 8.5 |
| GameKit.LoadLeaderboards Loads the list of leaderboards from Game Center. | Mac/iOS 8.5 |
| GameKit.LoadPlayers Loads information from Game Center about a list of players. | Mac/iOS 8.5 |
| GameKit.LoadReceivedChallenges Loads the list of outstanding challenges. | Mac/iOS 8.5 |
| GameKit.LocalPlayer Retrieves the shared instance of the local player. | Mac/iOS 8.5 |
| GameKit.LocalPlayer.Authenticate Authenticates the local user. | Mac/iOS 8.5 |
| GameKit.LocalPlayer.AuthenticateError Queries authenticate error. | Mac/iOS 8.5 |
| GameKit.LocalPlayer.ClearAuthenticateHandler Clears authenticate handler. | Mac/iOS 8.5 |
| GameKit.LocalPlayer.isAuthenticated Checks whether local player is authenticated. | Mac/iOS 8.5 |
| GameKit.LocalPlayer.isUnderage Queries underage status. | Mac/iOS 8.5 |
| GameKit.Player.Alias Queries alias name. | Mac/iOS 8.5 |
| GameKit.Player.DisplayName Queries name to display. | Mac/iOS 8.5 |
| GameKit.Player.GuestIdentifier Queries identifier for guest player. | Mac/iOS 8.5 |
| GameKit.Player.Photo Loads a photo of this player from Game Center. | Mac/iOS 8.5 |
| GameKit.RecentPlayers Returns an array of players the local player recently played with. | Mac/iOS 8.5 |
| GameKit.ReportAchievements Reports progress on an array of achievements. | Mac/iOS 8.5 |
| GameKit.ReportAchievementsWithEligibleChallenges Reports progress on an array of achievements. | Mac/iOS 8.5 |
| GameKit.ReportScores Reports a list of scores to Game Center. | Mac/iOS 8.5 |
| GameKit.ReportScoresWithEligibleChallenges Submit a list of scores and all eligible challenges. | Mac/iOS 8.5 |
| GameKit.ResetAchievements Resets all achievement progress for the local player. | Mac/iOS 8.5 |
| GameKit.Score.Date The date and time when the score was earned. | Mac/iOS 8.5 |
| GameKit.Score.FormattedValue Returns the player’s score as a localized string. | Mac/iOS 8.5 |
| GameKit.Score.GetContext Queries context. | Mac/iOS 8.5 |
| GameKit.Score.GetShouldSetDefaultLeaderboard Queries whether this score should update default leaderboard. | Mac/iOS 8.5 |
| GameKit.Score.GetValue Queries score value. | Mac/iOS 8.5 |
| GameKit.Score.LeaderboardIdentifier Queries the identifier for the leaderboard. | Mac/iOS 8.5 |
| GameKit.Score.New Creates a new score object. | Mac/iOS 8.5 |
| GameKit.Score.Player Queries the player identifier for the player that earned the score. | Mac/iOS 8.5 |
| GameKit.Score.Rank Queries position of the score in the results of a leaderboard search. | Mac/iOS 8.5 |
| GameKit.Score.SetContext Sets context value. | Mac/iOS 8.5 |
| GameKit.Score.SetShouldSetDefaultLeaderboard Set whether this score should update default leaderboard. | Mac/iOS 8.5 |
| GameKit.Score.SetValue Sets score value. | Mac/iOS 8.5 |
| GameKit.SelectChallengeablePlayers Finds the subset of players that can earn an achievement. | Mac/iOS 8.5 |
| GameKit.SetDefaultLeaderboardIdentifier Sets the default leaderboard for the current game. | Mac/iOS 8.5 |
| GameKit.SetPlayerDidChangeScriptTrigger Sets the player change script trigger. | Mac/iOS 8.5 |
| GameKit.ShowChallengeComposeDialog Shows challenge compose dialog. | Mac/iOS 8.5 |
97 functions shown.
These functions are free to use.
Release notes
- Version 9.1
- Fixed GameKit.Leaderboard.New function.
- Version 8.5
- Added a lot of GameKit functions to work with Game Center on Mac and iOS.
Blog Entries
