object.localizedDescription

Type String
Revision Release 2025.3721
Keywords steam, steamworks, achievements, AchievementInfo, localizedDescription
See also AchievementInfo
steamworks.*

Overview

A string providing a localized human-readable description of the achievement. This is configured by the app developer on the Steamworks website. If a localized description for the client system’s current locale is not defined on the Steamworks website, the achievement’s Display Name Description column string will be returned.

Example

local steamworks = require( "plugin.steamworks" )

local achievementInfo = steamworks.getAchievementInfo( "achievementName" )

if ( achievementInfo ) then
    print( "Achievement Description: " .. achievementInfo.localizedDescription )
end