steamworks.getUserImageInfo()

Overview

Returns an ImageInfo object. This provides information about one user avatar image such as its pixel width, pixel height, and unique image handle. This object’s imageHandle property is needed to load the image via the steamworks.newImageRect() and steamworks.newTexture() functions.

Gotchas

This function will typically return nil when attempting to fetch information about a 184×184 pixel "largeAvatar" image. This is because the Steam client does not normally cache these large images.

Additionally, this function will always return nil in these cases:

• Invalid arguments were specified.
• The steamworks.isLoggedOn property is false, indicating that the application is not currently connected to the Steam client.
• The image hasn’t yet been downloaded from the Steam server. In this case, the requested image will automatically be downloaded. The result of this request will then be provided by the userInfoUpdate event which can be received by a listener given to the steamworks.addEventListener() function. This event will indicate that the image has been downloaded when either the event.smallAvatarChanged, event.mediumAvatarChanged, or event.largeAvatarChanged properties are set to true.

Syntax

steamworks.getUserImageInfo( type [, userSteamId] )

Example

local steamworks = require( "plugin.steamworks" )

-- Forward-reference the last displayed avatar image
local avatarImage

-- Displays the currently logged in user's avatar image
local function displaySteamUserAvatar()
    -- Fetch information about the user's medium-sized avatar image
    local imageInfo = steamworks.getUserImageInfo( "mediumAvatar" )
    if ( imageInfo == nil ) then
        -- Image is not available yet; wait for a "userInfoUpdate" event
        return
    end

    -- Display the avatar image
    local newAvatarImage = steamworks.newImageRect( imageInfo.imageHandle, 64, 64 )
    if ( newAvatarImage == nil ) then
        return
    end
    newAvatarImage.x = display.contentCenterX
    newAvatarImage.y = display.contentCenterY

    -- Remove the last displayed avatar image, if it exists
    if ( avatarImage ) then
        avatarImage:removeSelf()
    end

    -- Store a reference to the new avatar image
    avatarImage = newAvatarImage
end

-- Attempt to show the currently logged in user's avatar image on startup
-- Note that this will likely fail on the first app launch by the Steam client
displaySteamUserAvatar()

-- Called when a Steam user's information/avatar has changed
local function onSteamUserInfoUpdated( event )
    -- Display current user's medium-sized avatar if it changed or loaded for the first time
    if ( ( event.userSteamId == steamworks.userSteamId ) and event.mediumAvatarChanged ) then
        displaySteamUserAvatar()
    end
end
steamworks.addEventListener( "userInfoUpdate", onSteamUserInfoUpdated )