Difference between revisions of "SetSteamAchievement"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 16: Line 16:
 
Syntax:
 
Syntax:
 
<syntaxhighlight>
 
<syntaxhighlight>
getSteamAchievement(apiName)
+
setSteamAchievement(apiName, {flags=1, clear = true|false})
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 30: Line 30:
 
The name of the requested achievement (this is the API name specified in the steam account for your game)
 
The name of the requested achievement (this is the API name specified in the steam account for your game)
  
Flags: none
+
Flags: clr/clear <br/>
 +
If true the achievement will be cleared. Default value is false!
  
Return: achievement <br/>
+
Return: success <br/>
True/false depending if the achievement is set or not, false if the operation failed
+
True if the achievement was set successfully, false if the operation failed!
 
{{i18n|SetSteamAchievement}}
 
{{i18n|SetSteamAchievement}}

Revision as of 20:11, 6 March 2013

Command History

Available since v3.7


Gets current state of a steam achievement!

Additional Info

This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!

Syntax:

setSteamAchievement(apiName, {flags=1, clear = true|false})

Example:

n/a


Arguments

apiName: "string"
The name of the requested achievement (this is the API name specified in the steam account for your game)

Flags: clr/clear
If true the achievement will be cleared. Default value is false!

Return: success
True if the achievement was set successfully, false if the operation failed!