Difference between revisions of "SetSteamAchievement"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 2: Line 2:
 
<b>Command History</b>
 
<b>Command History</b>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Available since <span style="color:green">v3.7</span>
+
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
 
</div></div>
 
</div></div>
  
  
 
Gets current state of a steam achievement!
 
Gets current state of a steam achievement!
{| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
! Additional Info
+
<b>Additional Info</b>
|-
+
<div class="mw-collapsible-content">
|
+
<div>This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!</div>
This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!
+
</div></div>
|}
+
 
  
 
Syntax:
 
Syntax:
Line 18: Line 18:
 
setSteamAchievement(apiName, {flags=1, clear = true|false})
 
setSteamAchievement(apiName, {flags=1, clear = true|false})
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
 
Example:
 
Example:
Line 23: Line 24:
 
n/a
 
n/a
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
  

Revision as of 18:44, 7 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!