object.hidden

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

Overview

Boolean value indicating if the achievement is set up to be hidden while locked.

Typically, you would not display information about locked hidden achievements, especially if their names and descriptions might spoil the end of a game.

Example

local steamworks = require( "plugin.steamworks" )

local achievementInfo = steamworks.getAchievementInfo( "achievementName" )

if ( achievementInfo ) then
    if ( achievementInfo.hidden and ( achievementInfo.unlocked == false ) ) then
        -- This is a hidden achievement that hasn't been unlocked yet
        -- We should not display information about it
    end
end