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" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<b>Command History</b>
+
<span>Command History</span>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
+
<div class="alt-bg">Available since v3.7</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 tbl-ds">
! Additional Info
+
<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>
This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!
+
</div></div>
|}
 
  
  
Line 23: Line 22:
 
Example:
 
Example:
 
<syntaxhighlight>
 
<syntaxhighlight>
n/a
+
-- to do!
 
</syntaxhighlight>
 
</syntaxhighlight>
  
  
  
<b><u>Arguments</u></b>
+
<span class="bold underline">Arguments</span>
  
apiName: "string" <br/>
+
<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)
 
The name of the requested achievement (this is the API name specified in the steam account for your game)
  
Flags: none
 
  
Return: achievement <br/>
+
<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
 
True/false depending if the achievement is set or not, false if the operation failed
{{i18n|GetSteamAchievement}}
+
{{i18n|GetSteamAchievement}} <br/>
 +
{| class="tbl-ds"
 +
|-
 +
|<span class="bold">Relevant Pages</span>: [[GetSteamStat|getSteamStat]] - [[SetSteamAchievement|setSteamAchievement]] - [[SetSteamStat|setSteamStat]]
 +
|}

Revision as of 18:21, 2 April 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:

getSteamAchievement(apiName)


Example:

-- to do!


Arguments

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


Flags

none


Return

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


Relevant Pages: getSteamStat - setSteamAchievement - setSteamStat