EK at 11:11, 19 May 2023

2023-05-19T11:11:41Z

EK: 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..."

2023-05-19T10:45:20Z

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

New page

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

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

== Syntax ==
<syntaxhighlight lang="lua">
setGameClientAchievement(apiName, [flags])
</syntaxhighlight>

== Parameters ==
{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" colspan="2" | Type/Structure
! Description
|-
| apiName
| colspan="2" | string
| The name of the achievement to set. This is the API name specified in the Steam/GOG Galaxy account.
|-
| rowspan="2" | flags
| rowspan="2" | table
| flags = 1
| indicates flags table
|-
| clear (bool)
| If true the achievement will be cleared. Default value is false.
|}

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

'''Example 2:''' Clear a game client achievement (set to "not done").
<syntaxhighlight lang="lua">
setGameClientAchievement("achv_easteregg_1", {flags=1, clear=true})
</syntaxhighlight>
{{toc}}

← Older revision		Revision as of 11:11, 19 May 2023
Line 1:		Line 1:
−	Set an achievement to "done".	+	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.''

Global Command: setGameClientAchievement - Revision history

EK at 11:11, 19 May 2023

EK: 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..."