| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
GameKit.AchievementDescription.Image
Loads the image property for a completed achievement.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| GameKit | 8.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |
MBS( "GameKit.AchievementDescription.Image"; AchievementDescriptionRef { ; Filename; Type } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| AchievementDescriptionRef | The identifier for the achievement description. | $AchievementDescription | |
| Filename | For PDF or image files returned an optional file name. | "test.jpg" | Optional |
| Type | For images the type you like to get. Can be JPEG, TIFF, PNG, GIF, BMP or PDF. |
"JPEG" | Optional |
Result
Returns image container or error.
Description
Loads the image property for a completed achievement.Loading and displaying achievements using a custom interface is a two-step process, with the first step being to call the GameKit.LoadAchievementDescriptions function. The second step is to call the GameKit.AchievementDescription.Image function for each achievement the user has completed. Your game should display the placeholder image until the image is successfully downloaded.
See also
- GameKit.AchievementDescription.Hidden
- GameKit.AchievementDescription.Replayable
- GameKit.AchievementDescription.Title
- GameKit.LoadAchievementDescriptions
This function is free to use.
Created 8th November 2018, last changed 8th November 2018
GameKit.AchievementDescription.Hidden - GameKit.AchievementDescription.IncompleteAchievementImage
