Difference between revisions of "GetSteamAchievement"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: Line 1:
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+
==getSteamAchievement==
<span>Command History</span>
 
<div class="mw-collapsible-content">
 
<div class="alt-bg">Available since v3.7</div>
 
</div></div>
 
  
 +
<div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div>
  
Gets current state of a steam achievement!
+
<div class="command-doc">Gets current state of an achievement.
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
 
<span class="bold">Additional Info</span>
 
<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>
 
</div></div>
 
  
 +
Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.</div>
  
Syntax:
+
Lua Syntax:
<syntaxhighlight>
+
<pre class="command-syntax">getSteamAchievement(apiName)</pre>
getSteamAchievement(apiName)
+
===Arguments===
</syntaxhighlight>
+
====apiName====
 
+
:'''"string"''' - The name of the requested achievement. This is the API name specified in the steam account.
 
+
===Flags===
Example:
+
===Return Values===
<syntaxhighlight>
+
;achievement
-- to do!
+
:True/false depending if the achievement is set or not, false if the operation failed.
</syntaxhighlight>
+
===Examples===
 
+
None.
 
 
 
 
<span class="bold underline">Arguments</span>
 
 
 
<span class="bold">apiName</span>: "string" <br/>
 
The name of the requested achievement (this is the API name specified in the steam account for your game)
 
 
 
 
 
<span class="bold underline">Flags</span>
 
 
 
none
 
 
 
 
 
<span class="bold underline">Return</span>
 
 
 
<span class="bold">achievement</span> <br/>
 
True/false depending if the achievement is set or not, false if the operation failed
 
{{i18n|GetSteamAchievement}} <br/>
 
{| class="tbl-ds"
 
|-
 
|<span class="bold">Relevant Pages</span>: [[GetSteamStat|getSteamStat]] - [[ResetSteamStats|resetSteamStats]] - [[SetSteamAchievement|setSteamAchievement]] - [[SetSteamStat|setSteamStat]]
 
|}
 

Revision as of 17:11, 22 November 2013

getSteamAchievement

Available since: v3.6
Gets current state of an achievement. Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.

Lua Syntax:

getSteamAchievement(apiName)

Arguments

apiName

"string" - The name of the requested achievement. This is the API name specified in the steam account.

Flags

Return Values

achievement
True/false depending if the achievement is set or not, false if the operation failed.

Examples

None.