Global Command: resetGameClientStats

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 11:34, 19 May 2023 by EK (talk | contribs) (Created page with "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.'' {| cl...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.

Related functions getGameClientAchievement | getGameClientStat | getProperty | initGameClient | setGameClientAchievement | setGameClientStat


Syntax

resetGameClientStats( [resetAchievements])


Parameters

Parameter 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

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.

resetGameClientStats(true)