| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
GameKit.Achievement.SetShowsCompletionBanner
Sets whether to show completion banner.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| GameKit | 8.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |
MBS( "GameKit.Achievement.SetShowsCompletionBanner"; AchievementRef; Value ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| AchievementRef | The identifier for the achievement. | $Achievement |
| Value | The new boolean value. Pass 1 to show or 0 to hide banner. |
Result
Returns OK or error.
Description
Sets whether to show completion banner.A Boolean value that states whether a banner is displayed when the achievement is completed.
When an achievement is completed and the value of this property is 1, a notification banner is displayed to the player to inform them of the completed achievement. If the value of this property is 0, there is no visual indication that the achievement is completed. Your game should set this property to 0 to provide its own visual indicator that the achievement was earned. The default value is 0.
See also
This function is free to use.
Created 5th November 2018, last changed 8th November 2018
GameKit.Achievement.SetPercentComplete - GameKit.AchievementDescription.AchievedDescription
