userProgressUnload

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

Overview

This event occurs when Steam has unloaded achievement and stat data of another user (not the logged in user) from memory. This means that this user's game progression data will no longer be available via the steamworks.getAchievementInfo() and steamworks.getUserStatValue() functions — you'll have to call the steamworks.requestUserProgress() function to reload the user's progression data back into memory.

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

Gotchas

Properties

Example

local steamworks = require( "plugin.steamworks" )

-- Called when Steam has unloaded achievement/stat info of another user from memory
local function onUserProgressUnloaded( event )
    print( "Unloaded progression data from user ID: " .. event.userSteamId )
end

-- Set up a listener to be invoked when Steam unloads achievement/stat info of another user
steamworks.addEventListener( "userProgressUnload", onUserProgressUnloaded )