Difference between revisions of "GetSteamStat"

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 class="bold">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>
  
  
 
Returns the requested steam stat!
 
Returns the requested steam stat!
<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>Additional Info</b>
+
<span class="bold">Additional Info</span>
 
<div class="mw-collapsible-content">
 
<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>This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!</div>
Line 22: Line 22:
 
Example:
 
Example:
 
<syntaxhighlight>
 
<syntaxhighlight>
n/a
+
-- to do!
 
</syntaxhighlight>
 
</syntaxhighlight>
  
  
  
<b><u>Arguments</u></b>
+
<span class="bold underline">Arguments</span>
  
<b>apiName</b>: "string" <br/>
+
<span class="bold">apiName</span>: "string" <br/>
 
The name of the requested stat (this is the API name specified in the steam account for your game)
 
The name of the requested stat (this is the API name specified in the steam account for your game)
  
  
<b><u>Flags</u></b>
+
<span class="bold underline">Flags</span>
  
 
none
 
none
  
  
<b><u>Return</u></b>
+
<span class="bold underline">Return</span>
  
<b>stat</b> <br/>
+
<span class="bold">stat</span> <br/>
 
The integer value of the stat or -1 if the stat could not be retrieved
 
The integer value of the stat or -1 if the stat could not be retrieved
{{i18n|GetSteamStat}}
+
{{i18n|GetSteamStat}} <br/>
 +
{| class="tbl-ds"
 +
|-
 +
|<span class="bold">Relevant Pages</span>: [[GetSteamAchievement|getSteamAchievement]] - [[SetSteamAchievement|setSteamAchievement]] - [[SetSteamStat|setSteamStat]]
 +
|}

Revision as of 20:09, 2 April 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:

 -- to do!


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


Relevant Pages: getSteamAchievement - setSteamAchievement - setSteamStat