Difference between revisions of "GetSteamStat"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ==getSteamStat== | |
| − | |||
| − | |||
| − | |||
| − | |||
| + | <div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div> | ||
| − | + | <div class="command-doc">Returns the requested steam stat. | |
| − | <div class=" | ||
| − | |||
| − | |||
| − | |||
| − | |||
| + | 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: |
| − | < | + | <pre class="command-syntax">getSteamStat(apiName)</pre> |
| − | 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. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | The name of the requested stat | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | The integer value of the stat or -1 if the stat could not be retrieved | ||
| − | |||
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.
