Difference between revisions of "GetSteamStat"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 29: Line 29:
 
<b><u>Arguments</u></b>
 
<b><u>Arguments</u></b>
  
apiName: "string" <br/>
+
<b>apiName</b>: "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)
  
Flags: none
 
  
Return: stat <br/>
+
<b><u>Flags</u></b>
 +
 
 +
none
 +
 
 +
<b><u>Return</u></b>
 +
 
 +
<b>stat</b> <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}}

Revision as of 18:31, 11 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