steamworks.getUserInfo()

类型 函数
返回值 UserInfo
修订版本 版本 2024.3703
关键词 steam, steamworks, getUserInfo
另请参阅 steamworks.addEventListener()
steamworks.*

概述

返回一个 UserInfo 对象。该对象提供有关一个用户帐户的信息，例如个人资料名称、Steam 等级、在线状态等。

注意

调用 steamworks.requestLeaderboardEntries() 函数时，每个排行榜条目的用户信息将立即可用。Steam 也可能会自动卸载每个条目的用户信息。因此，应在该信息可用时立即获取。

注意事项

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

语法

steamworks.getUserInfo( [userSteamId] )
userSteamId (可选)

字符串. 用户的唯一字符串 ID。如果未提供此参数，则 ID 将默认为当前用户。

示例

local steamworks = require( "plugin.steamworks" )

-- Called when information about one user has been received or changed
local function onUserInfoUpdated( event )
    -- Print information about the user
    local userInfo = steamworks.getUserInfo( event.userSteamId )
    if ( userInfo ) then
        print( "User Name: " .. userInfo.name )
        print( "User Nickname: " .. userInfo.nickname )
        print( "Steam Level: " .. tostring(userInfo.steamLevel) )
        print( "Status: " .. userInfo.status )
        print( "Relationship: " .. userInfo.relationship )
    end
end

-- Set up a listener to be invoked when user info has been received or changed
steamworks.addEventListener( "userInfoUpdate", onUserInfoUpdated )