userProgressUpdate

Type Event
Revision Current Public Release (2018.3326)
Keywords steam, steamworks, userProgressUpdate
See also steamworks.addEventListener()
steamworks.requestUserProgress()
steamworks.*

Overview

This event occurs after Steam has attempted to fetch updated information about one user's achievements and stat data.

If successful, as indicated by the event.isError property being false, the steamworks.getAchievementInfo() and steamworks.getUserStatValue() functions will provide updated progression data for that user.

This event will be dispatched after a successful call to the steamworks.requestUserProgress() function. It will also be dispatched for the currently logged in user:

You can receive these events by adding a listener to the plugin via the steamworks.addEventListener() function.

Properties

Example

local steamworks = require( "plugin.steamworks" )

-- Called when user achievement/stat data has been received
local function onUserProgressUpdated( event )
    if ( event.isError ) then
        -- Failed to receive updated progression data
    else
        -- User progression was successfully loaded
        -- You might want to reload achievement and stat data for user here
    end
end

-- Set up a listener to be invoked when achievement and stat data has been updated
steamworks.addEventListener( "userProgressUpdate", onUserProgressUpdated )