Global Command: getGameClientAchievement
From The Official Visionaire Studio: Adventure Game Engine Wiki
Get the current state of an achievement.
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 | getGameClientStat | getProperty | initGameClient | resetGameClientStats | setGameClientAchievement | setGameClientStat |
Syntax
getGameClientAchievement(apiName)
Parameters
Parameter | Type | Description |
---|---|---|
apiName | string | The name of the requested achievement. This is the API name specified in the Steam/GOG Galaxy account. |
Return values
Type | Description |
---|---|
boolean | True if the achievement is set, false if it is not set or the operation failed. |
Examples
Example 1: Get state of a game client achievement.
getGameClientAchievement("achv_easteregg_1")