Platforms to show: All Mac Windows Linux Cross-Platform

Back to GKAchievementDescriptionMBS class.

GKAchievementDescriptionMBS.achievedDescription as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A localized description of the completed achievement. (read-only)

GKAchievementDescriptionMBS.Constructor   Private

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The private constructor.

GKAchievementDescriptionMBS.groupIdentifier as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The group identifier for the achievement, if one exists.

Available on Mac OS X 10.8.2 and newer.

GKAchievementDescriptionMBS.identifier as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A unique string used to identify the achievement. (read-only)

The GKAchievementDescription property holds the identifier string you created for the achievement on iTunes Connect.

GKAchievementDescriptionMBS.image as NSImageMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
An image to display for the completed achievement. (read-only)

The value of this property is undefined until after the image is loaded. See loadImage.

GKAchievementDescriptionMBS.isHidden as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A Boolean value that states whether this achievement should be visible to players. (read-only)

If the value of this property is false, this achievement is always visible to the user. If true, the achievement is not displayed in any of the standard achievement user interface screens. It remains hidden until the first time your game reports progress towards completing this achievement.

GKAchievementDescriptionMBS.isReplayable as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Whether or not the achievement will be reported by the game when the user earns it again.

This allows the achievement to be used for challenges when the recipient has previously earned it.
Available on Mac OS X 10.8.2 and newer.

GKAchievementDescriptionMBS.loadImage(tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Loads the image property for a completed achievement.

Your game should call loadImage for each achievement the user has completed. Your game should display the placeholder image until the image is successfully downloaded. After the event is called, the description's image property holds the same image object that is returned to the event.

When this method is called, it creates a new background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls GameKitMBS.loadImageCompleted event.

GKAchievementDescriptionMBS.maximumPoints as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The number of points earned by completing this achievement. (read-only)

GKAchievementDescriptionMBS.title as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A localized title for the achievement. (read-only)

GKAchievementDescriptionMBS.unachievedDescription as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
A localized description of the achievement, to be used when the achievement has not been completed. (read-only)

The items on this page are in the following plugins: MBS MacFrameworks Plugin.


The biggest plugin in space...