Difference between revisions of "Global Command: setGameClientAchievement"
From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "Set an achievement to "done". ''Note: this command only works, if the Steam API/GOG Galaxy library was loaded and if a Steam/GOG Galaxy account for your game exists.'' {| cl...") |
|||
| Line 1: | Line 1: | ||
| − | Set | + | Set a game client achievement to "done". |
''Note: this command only works, if the Steam API/GOG Galaxy library was loaded and if a Steam/GOG Galaxy account for your game exists.'' | ''Note: this command only works, if the Steam API/GOG Galaxy library was loaded and if a Steam/GOG Galaxy account for your game exists.'' | ||
Latest revision as of 13:11, 19 May 2023
Set a game client achievement to "done".
Note: this command only works, if the Steam API/GOG Galaxy library was loaded and if a Steam/GOG Galaxy account for your game exists.
| Related functions | getGameClientAchievement | getGameClientStat | getProperty | initGameClient | resetGameClientStats | setGameClientStat |
Syntax
setGameClientAchievement(apiName, [flags])
Parameters
| Parameter | Type/Structure | Description | |
|---|---|---|---|
| apiName | string | The name of the achievement to set. This is the API name specified in the Steam/GOG Galaxy account. | |
| flags | table | flags = 1 | indicates flags table |
| clear (bool) | If true the achievement will be cleared. Default value is false. | ||
Return values
| Type | Description |
|---|---|
| boolean | True if the achievement was set successfully, false if the operation failed. |
Examples
Example 1: Set a game client achievement to "done".
setGameClientAchievement("achv_easteregg_1")
Example 2: Clear a game client achievement (set to "not done").
setGameClientAchievement("achv_easteregg_1", {flags=1, clear=true})
