View source for Global Command: resetGameClientStats

Resets all game client stats.

''Note: this command only works, if the Steam API/GOG Galaxy library was loaded and if a Steam/GOG Galaxy account for your game exists.''

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: getGameClientAchievement|getGameClientAchievement]] | [[Global Command: getGameClientStat|getGameClientStat]] | [[Global Command: getProperty|getProperty]] | [[Global Command: initGameClient|initGameClient]] | [[Global Command: setGameClientAchievement|setGameClientAchievement]] | [[Global Command: setGameClientStat|setGameClientStat]]
|}


== Syntax ==
<syntaxhighlight lang="lua">
resetGameClientStats( [resetAchievements])
</syntaxhighlight>


== Parameters ==
{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| resetAchievements
| boolean
| If true all stats and all achievements will be cleared, otherwise only the stats will be reset. Default value is false.
|}


== Return values ==
{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| boolean
| True if the stats were cleared successfully, false if the operation failed.
|}


== Examples ==

'''Example 1:''' Reset all game client stats and achievements.
<syntaxhighlight lang="lua">
resetGameClientStats(true)
</syntaxhighlight>
{{toc}}