Difference between revisions of "GetSteamStat"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "<b>History</b>: Available since <span style="color:green">v3.7</span> Returns the requested steam stat! {| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; bor...")
 
Line 1: Line 1:
<b>History</b>: Available since <span style="color:green">v3.7</span>
+
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
 +
<b>Command History</b>
 +
<div class="mw-collapsible-content">
 +
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
 +
</div></div>
  
 
Returns the requested steam stat!
 
Returns the requested steam stat!
{| 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 13: Line 17:
 
getSteamStat(apiName)
 
getSteamStat(apiName)
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
 
Example:
 
Example:
Line 18: Line 23:
 
n/a
 
n/a
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
  

Revision as of 18:29, 7 March 2013

Command History

Available since v3.7

Returns the requested steam stat!

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:

getSteamStat(apiName)


Example:

n/a


Arguments

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

Flags: none

Return: stat
The integer value of the stat or -1 if the stat could not be retrieved