Difference between revisions of "ResetSteamStats"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: Line 1:
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<b>Command History</b>
+
<span class="bold">Command History</span>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
+
<div class="alt-bg">Available since v3.7</div>
 
</div></div>
 
</div></div>
  
  
 
Resets all steam stats!
 
Resets all steam stats!
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<b>Additional Info</b>
+
<span class="bold">Additional Info</span>
 
<div class="mw-collapsible-content">
 
<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>This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!</div>
Line 22: Line 22:
 
Example:
 
Example:
 
<syntaxhighlight>
 
<syntaxhighlight>
n/a
+
-- to do!
 
</syntaxhighlight>
 
</syntaxhighlight>
  
  
  
<b><u>Arguments</u></b>
+
<span class="bold underline">Arguments</span>
  
resetAchievements: boolean (true/false) <br/>
+
<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!
 
If true all achievements will be cleared, otherwise only all stats will be reset. Default value is false!
  
Flags: none
 
  
Return: success <br/>
+
<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
 
True if the stats were cleared successfully, false if the operation failed
{{i18n|ResetSteamStats}}
+
{{i18n|ResetSteamStats}}} <br/>
 +
{| class="tbl-ds"
 +
|-
 +
|<span class="bold">Relevant Pages</span>: [[GetSteamAchievement|getSteamAchievement]] - [[GetSteamStat|getSteamStat]] - [[SetSteamAchievement|setSteamAchievement]] - [[SetSteamStat|setSteamStat]]
 +
|}

Revision as of 14:26, 3 April 2013

Command History

Available since v3.7


Resets all steam stats!

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:

resetSteamStats([resetAchievements])


Example:

 -- to do!


Arguments

resetAchievements: boolean (true/false)
If true all achievements will be cleared, otherwise only all stats will be reset. Default value is false!


Flags

none


Return

success
True if the stats were cleared successfully, false if the operation failed

}
Relevant Pages: getSteamAchievement - getSteamStat - setSteamAchievement - setSteamStat