object.relationship(对象.关系)

类型 字符串
修订 版本 2024.3703
关键词 steam, steamworks, getUserInfo, UserInfo, relationship(关系)
另请参阅 steamworks.getUserInfo()
steamworks.*

概述

一个 字符串,指示用户与当前登录用户的关系状态。

这将是以下字符串之一

陷阱

如果 UserInfo 对象引用当前登录的用户,则此属性将始终为 "none"(无)

示例

local steamworks = require( "plugin.steamworks" )

-- Set the user ID of the friend to fetch information for
local friendSteamId = "FRIEND_ID"

-- Function used to print the above friend's relationship to the log
local function fetchFriendInfo()
    local userInfo = steamworks.getUserInfo( friendSteamId )
    if ( userInfo ) then
        -- Friend's info was successfully fetched
        print( "Relationship: " .. userInfo.relationship )
    else
        -- Friend's info has not yet been fetched from Steam
    end
end

-- Attempt to fetch the friend's information now
-- This might fail on app startup if not cached by the Steam client
fetchFriendInfo()

-- Called when info about one user has been received or changed
local function onUserInfoUpdated( event )
    if ( event.userSteamId == friendSteamId ) then
        fetchFriendInfo()
    end
end

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