userProgressSave

类型 事件
修订版 Release 2024.3703
关键字 steam、steamworks、userProgressSave
另请参阅 steamworks.addEventListener()
steamworks.*

概述

当 Steam 尝试保存并上传当前登录用户的进度数据(如解锁成就和更新的统计数据)时,会发生此事件。 event.isError 属性指示是否已成功将进度保存至 Steam。这些事件通常在调用 steamworks.setAchievementUnlocked()steamworks.setUserStatValues() 函数后触发。

你可以通过通过 steamworks.addEventListener() 函数将 监听器 添加到插件来接收这些事件。

属性

event.isError

event.name

event.resultCode

event.userSteamId

示例

local steamworks = require( "plugin.steamworks" )

-- Called when Steam has attempted to save/upload user progression
local function onUserProgressSaved( event )
    if ( event.isError ) then
        -- Failed to save/upload user's unlocked achievements and stat data
        if ( event.resultCode == 3 ) then
            -- Failed due to an invalid parameter
            -- For example, calling "steamworks.setUserStats()" with values that break constraints
        else
            -- Failed due to some other reason
        end
    else
        -- User progression was successfully saved and uploaded to Steam's server
    end
end

-- Set up a listener to be invoked when Steam has attempted to save user progress
steamworks.addEventListener( "userProgressSave", onUserProgressSaved )