steamworks.resetUserStats()

Type Function
Return value Boolean
Revision Current Public Release (2018.3326)
Keywords steam, steamworks, achievements, resetUserStats
See also steamworks.resetUserProgress()
steamworks.*

Overview

Clears all stat data to nil for the current user. This means that all calls to the steamworks.getUserStatValue() function will return nil until you've set new stat data for the current user.

Returns true if the reset request was successfully accepted by Steam.

Returns false if the steamworks.isLoggedOn property is false.

Gotchas

The userProgressUpdate event will not be dispatched after calling this function.

Syntax

steamworks.resetUserStats()

Example

local steamworks = require( "plugin.steamworks" )

-- Clear all stat data for the currently logged in user
steamworks.resetUserStats()