steamworks.showUserOverlay()

概述

在应用程序窗口上方显示 Steam 叠加层。此叠加层用于与其他用户交互或显示有关其他用户的信息。

如果 Steam 能够显示叠加层，则返回 true。

注意事项

在以下情况下，此函数将返回 false 并且不会显示叠加层：

• 指定了无效的参数。
• steamworks.canShowOverlay 属性为 false。
• steamworks.isLoggedOn 属性为 false，表示应用程序当前未连接到 Steam 客户端。
• Steam 客户端当前未运行。
• 用户已在 Steam 客户端的游戏中设置屏幕中禁用了叠加层。
• 在应用程序启动后的前几秒内。这是正常现象，因为 Steam 客户端需要时间绑定到应用程序进程。

语法

steamworks.showUserOverlay( userSteamId [, overlayName] )

示例

local steamworks = require( "plugin.steamworks" )

-- Attempt to show a friend's achievements on screen
local friendSteamId = "FRIEND_ID"

local wasShown = steamworks.showUserOverlay( friendSteamId, "achievements" )

if not wasShown then
    print( "Failed to display the overlay." )
end