Difference between revisions of "SetGameClientAchievement"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "==setGameClientAchievement== <div class="command-min-version-info">Available since: <span class="command-min-version">v4.1</span></div> <div class="command-doc">Sets an achi...")
 
 
Line 1: Line 1:
==setGameClientAchievement==
+
#REDIRECT [[Global Command: setGameClientAchievement]]
 
 
<div class="command-min-version-info">Available since: <span class="command-min-version">v4.1</span></div>
 
 
 
<div class="command-doc">Sets 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.</div>
 
 
 
Lua Syntax:
 
<pre class="command-syntax">setGameClientAchievement(apiName, {flags=1,
 
    clear = true|false})</pre>
 
===Arguments===
 
====apiName====
 
:'''"string"''' - The name of the achievement to set. This is the API name specified in the steam / gog galaxy account.
 
===Flags===
 
====clr/clear====
 
 
 
:If true the achievement will be cleared. Default value is false.
 
===Return Values===
 
;success
 
:True if the achievement was set successfully, false if the operation failed.
 
===Examples===
 
None.
 

Latest revision as of 13:30, 19 May 2023