steamworks.resetUserProgress()

Type Function
Return value Boolean
Revision 2018.3333
Keywords steam, steamworks, achievements, resetUserProgress
See also steamworks.resetUserStats()
steamworks.*

Overview

Clears all stat data to nil and re-locks all unlocked achievements for the current user. This does not clear the user's high scores from leaderboards.

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

Returns false if the steamworks.isLoggedOn property is false.

Calling this function is typically only appropriate for testing purposes, as most players would not expect to lose their unlocked achievements. If you want to provide an option for users to clear only their stat data, consider using the steamworks.resetUserStats() function instead.

Gotchas

Syntax

steamworks.resetUserProgress()

Example

local steamworks = require( "plugin.steamworks" )

-- Clear all stat data and lock all achievements for the currently logged in user
steamworks.resetUserProgress()