View source for Global Command: getGameClientAchievement

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.''

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: getGameClientStat|getGameClientStat]] | [[Global Command: getProperty|getProperty]] | [[Global Command: initGameClient|initGameClient]] | [[Global Command: resetGameClientStats|resetGameClientStats]] | [[Global Command: setGameClientAchievement|setGameClientAchievement]] | [[Global Command: setGameClientStat|setGameClientStat]]
|}


== Syntax ==
<syntaxhighlight lang="lua">
getGameClientAchievement(apiName)
</syntaxhighlight>


== Parameters ==
{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| apiName
| string
| The name of the requested achievement. This is the API name specified in the Steam/GOG Galaxy account.
|}


== Return values ==
{| class="ts"
|-
! style="width:15%" | 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.
<syntaxhighlight lang="lua">
getGameClientAchievement("achv_easteregg_1")
</syntaxhighlight>
{{toc}}