Type Function Return value Boolean Revision Release 2023.3686 Keywords steam, steamworks, achievements, setAchievementProgress See also steamworks.setAchievementUnlocked() achievementInfoUpdate steamworks.*
Sets the amount of progress made towards one achievement for the current user. This is mostly intended for display purposes. Calling this function will trigger a Steam notification popup to be displayed to the user, indicating their current progress, but only if overlays are enabled by the user in the Steam client. If the given progress
value argument is greater than or equal to the given
maxValue argument, the achievement will be automatically unlocked.
true if achievement progression was successfully updated.
false if given invalid arguments or if the steamworks.isLoggedOn property is
You can control where Steam's notification popup will appear within the app by using the steamworks.setNotificationPosition() function.
Steam does not save the amount of progress made towards an achievement. Steam only saves an achievement's lock/unlock status. This means that it's up to the application developer to track and store this amount outside of Steam, such as to file, until it has been unlocked.
steamworks.setAchievementProgress( achievementName, value, maxValue )
String. On the Steamworks website, this is the unique name of the achievement set under the
Number. Integer indicating the current progress made towards the achievement, ranging between
0 and the
Number. Integer defining the maximum progression value until the achievement will be unlocked.
local steamworks = require( "plugin.steamworks" ) -- Set the achievement progress to "50/100" steamworks.setAchievementProgress( "My Achievement Name", 50, 100 )