Difference between revisions of "GetSteamStat"

Latest revision as of 22:27, 30 September 2014

Available since: v3.6

Returns the requested steam stat. Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.

Lua Syntax:

getSteamStat(apiName)

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

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

None.

@@ Line 1: / Line 1: @@
-<b>History</b>: Available since <span style="color:green">v3.7</span>
+==getSteamStat==
-Returns the requested steam stat!
+<div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div>
-{| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
-! 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:
+<div class="command-doc">Returns the requested steam stat.
-<syntaxhighlight>
-getSteamStat(apiName)
-</syntaxhighlight>
-Example:
+Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.</div>
-<syntaxhighlight>
-n/a
-</syntaxhighlight>
+Lua Syntax:
-<b><u>Arguments</u></b>
+<pre class="command-syntax">getSteamStat(apiName)</pre>
+===Arguments===
-apiName: "string" <br/>
+====apiName====
-The name of the requested stat (this is the API name specified in the steam account for your game)
+:'''"string"''' - The name of the requested stat. This is the API name specified in the steam account.
+===Flags===
-Flags: none
+===Return Values===
+;stat
-Return: stat <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
+===Examples===
-{{i18n|GetSteamStat}}
+None.