object.unlocked

Type Boolean
Revision Release 2024.3703
Keywords steam, steamworks, achievements, AchievementInfo, unlocked
See also AchievementInfo
steamworks.*

Overview

Boolean value indicating if the achievement has been unlocked by the user.

An application can unlock an achievement by calling the steamworks.setAchievementUnlocked() function or by calling the steamworks.setAchievementProgress() function set to its max progress value.

Example

local steamworks = require( "plugin.steamworks" )

local achievementInfo = steamworks.getAchievementInfo( "achievementName" )

if ( achievementInfo ) then
    if ( achievementInfo.unlocked ) then
        -- Achievement unlocked
    else
        -- Achievement has not been unlocked yet
    end
end