steamworks.getAchievementInfo()

概述

返回一个 AchievementInfo 对象。它提供了有关一项成就的信息，例如其本地化名称、描述、解锁状态等，适用于当前登录的用户（或其他用户）。

获取其他用户的成就信息时，必须先使用该用户的 ID 调用 steamworks.requestUserProgress() 函数，并等待成功的 userProgressUpdate 事件。

注意事项

在以下情况下，此函数将返回 nil

• 指定了无效的参数。
• steamworks.isLoggedOn 属性为 false，表示应用程序当前未连接到 Steam 客户端。
• 系统无法访问互联网，并且当前未缓存该用户信息。
• 您尝试在未先调用 steamworks.requestUserProgress() 的情况下获取其他用户信息。

语法

steamworks.getAchievementInfo( achievementName [, userSteamId] )

示例

local steamworks = require( "plugin.steamworks" )

-- Called when achievement status or stat data has been updated/changed
-- This will be called for the currently logged in user, and other users too
local function onUserProgressUpdated( event )
    -- Determine who this progress update is for
    if ( event.userSteamId == steamworks.userSteamId ) then
        print( "Received progress info for current user." )
    else
        print( "Received progress info for another user." )
    end

    -- Print the user's current achievement info
    local achievementInfo = steamworks.getAchievementInfo( "MyAchievementName", event.userSteamId )
    if ( achievementInfo ) then
        print( "  Localized Name: " .. achievementInfo.localizedName )
        print( "  Localized Description: " .. achievementInfo.localizedDescription )
        print( "  Is Hidden: " .. tostring(achievementInfo.hidden) )
        print( "  Was Unlocked: " .. tostring(achievementInfo.unlocked) )
        if ( achievementInfo.unlocked ) then
            -- Note that "unlockTime" is in local Unix time
            -- This can be compared with "os.time()" and used by "os.date()"
            print( "  Unlock Time: " .. os.date( "%c", achievementInfo.unlockTime ) )
        end
    end
end

-- Listen for achievement status or stat data changes from all users
steamworks.addEventListener( "userProgressUpdate", onUserProgressUpdated )