steamworks.getUserImageInfo()

概述

返回一个 ImageInfo 对象。该对象提供有关一个用户头像图像的信息，例如其像素宽度、像素高度和唯一图像句柄。该对象的 imageHandle 属性是通过 steamworks.newImageRect() 和 steamworks.newTexture() 函数加载图像所需的。

注意事项

当尝试获取有关 184×184 像素 "largeAvatar" 图像的信息时，此函数通常会返回 nil。这是因为 Steam 客户端通常不会缓存这些大图像。

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

• 指定了无效参数。
• steamworks.isLoggedOn 属性为 false，表示应用程序当前未连接到 Steam 客户端。
• 图像尚未从 Steam 服务器下载。在这种情况下，将自动下载请求的图像。然后，此请求的结果将由 userInfoUpdate 事件提供，该事件可以由提供给 steamworks.addEventListener() 函数的侦听器接收。 当 event.smallAvatarChanged、event.mediumAvatarChanged 或 event.largeAvatarChanged 属性设置为 true 时，此事件将指示图像已下载。

语法

steamworks.getUserImageInfo( type [, userSteamId] )

示例

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 )