Difference between revisions of "ResetSteamStats"

Latest revision as of 21:27, 30 September 2014

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.

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==resetSteamStats==
-<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>
-Resets all steam stats!
+<div class="command-doc">Resets all steam stats.
-<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">resetSteamStats( [resetAchievements])</pre>
-resetSteamStats([resetAchievements])
+===Arguments===
-</syntaxhighlight>
+====resetAchievements====
+:'''true|false''' - If true all achievements will be cleared, otherwise only all stats will be reset. Default value is false.
+===Flags===
-Example:
+===Return Values===
-<syntaxhighlight>
+;success
- -- to do!
+:True if the stats were cleared successfully, false if the operation failed.
-</syntaxhighlight>
+===Examples===
+None.
-<span class="bold underline">Arguments</span>
-<span class="bold">resetAchievements</span>: boolean (true/false) <br/>
-If true all achievements will be cleared, otherwise only all stats will be reset. Default value is false!
-<span class="bold underline">Flags</span>
-none
-<span class="bold underline">Return</span>
-<span class="bold">success</span> <br/>
-True if the stats were cleared successfully, false if the operation failed
-{{i18n|ResetSteamStats}}} <br/>
-{| class="tbl-ds"
-|-
-|<span class="bold">Relevant Pages</span>: [[GetSteamAchievement|getSteamAchievement]] - [[GetSteamStat|getSteamStat]] - [[SetSteamAchievement|setSteamAchievement]] - [[SetSteamStat|setSteamStat]]
-|}