Difference between revisions of "GetSteamStat"

Latest revision as of 21:27, 30 September 2014

getSteamStat

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)

Arguments

apiName

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

Flags

Return Values

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

Examples

None.

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==getSteamStat==
-<span class="bold">Command History</span>
-<div class="mw-collapsible-content">
-<div class="alt-bg">Available since v3.7</div>
-</div></div>
+<div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div>
-Returns the requested steam stat!
+<div class="command-doc">Returns the requested steam stat.
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<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>
-</div></div>
+Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.</div>
-Syntax:
+Lua Syntax:
-<syntaxhighlight>
+<pre class="command-syntax">getSteamStat(apiName)</pre>
-getSteamStat(apiName)
+===Arguments===
-</syntaxhighlight>
+====apiName====
+:'''"string"''' - The name of the requested stat. This is the API name specified in the steam account.
+===Flags===
-Example:
+===Return Values===
-<syntaxhighlight>
+;stat
- -- to do!
+:The integer value of the stat or -1 if the stat could not be retrieved.
-</syntaxhighlight>
+===Examples===
+None.
-<span class="bold underline">Arguments</span>
-<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)
-<span class="bold underline">Flags</span>
-none
-<span class="bold underline">Return</span>
-<span class="bold">stat</span> <br/>
-The integer value of the stat or -1 if the stat could not be retrieved
-{{i18n|GetSteamStat}} <br/>
-{| class="tbl-ds"
-|-
-|<span class="bold">Relevant Pages</span>: [[GetSteamAchievement|getSteamAchievement]] - [[ResetSteamStats|resetSteamStats]] - [[SetSteamAchievement|setSteamAchievement]] - [[SetSteamStat|setSteamStat]]
-|}