steamworks.showGameOverlay()

类型 函数
返回值 布尔值
修订版 版本 2024.3703
关键字 steam、steamworks、overlay、showGameOverlay
另请参见 steamworks.canShowOverlay
steamworks.showStoreOverlay()
steamworks.showUserOverlay()
steamworks.showWebOverlay()
steamworks.*

概述

在应用程序窗口顶部显示一个 Steam 覆盖层。此覆盖层会显示有关当前所玩游戏的信息,例如其主社区页面、用户统计信息、成就等,同时也是Shift+Tab常规显示的内容。

返回 true,表示 Steam 可显示覆盖图。

注意事项

此函数将返回false,并且覆盖图将不会显示,这种情况见如下:

语法

steamworks.showGameOverlay( [overlayName] )
overlayName (可选)

String. 要显示的覆盖图的唯一名称,包括以下选项。如果您省略此参数,或如果给定的名称未知,Steam 默认显示上次在游戏覆盖图中显示的内容。如果以前未显示覆盖图,Steam 默认显示游戏的主要覆盖图,通常在按下时显示Shift+Tab.

  • "成就"
  • "社区"
  • "好友"
  • "OfficialGameGroup"
  • "玩家"
  • "设置"
  • "统计信息"

示例

local steamworks = require( "plugin.steamworks" )

-- Attempt to show the user's current achievements
local wasShown = steamworks.showGameOverlay( "Achievements" )

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