Difference between revisions of "ResetSteamStats"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ==resetSteamStats== | |
| − | |||
| − | |||
| − | |||
| − | |||
| + | <div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div> | ||
| − | + | <div class="command-doc">Resets all steam stats. | |
| − | <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">resetSteamStats( [resetAchievements])</pre> |
| − | resetSteamStats([resetAchievements]) | + | ===Arguments=== |
| − | + | ====resetAchievements==== | |
| − | + | :'''true|false''' - If true all achievements will be cleared, otherwise only all stats will be reset. Default value is false. | |
| − | + | ===Flags=== | |
| − | + | ===Return Values=== | |
| − | + | ;success | |
| − | + | :True if the stats were cleared successfully, false if the operation failed. | |
| − | </ | + | ===Examples=== |
| − | + | None. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | If true all achievements will be cleared, otherwise only all stats will be reset. Default value is false | ||
| − | |||
| − | Flags | ||
| − | |||
| − | |||
| − | True if the stats were cleared successfully, false if the operation failed | ||
| − | |||
Latest revision as of 22:27, 30 September 2014
Contents
resetSteamStats
Available since: v3.6
Resets all steam stats.
Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.
Lua Syntax:
resetSteamStats( [resetAchievements])
Arguments
resetAchievements
- true|false - If true all achievements will be cleared, otherwise only all stats will be reset. Default value is false.
Flags
Return Values
- success
- True if the stats were cleared successfully, false if the operation failed.
Examples
None.
