overlayStatus

类型 事件
修订版 版本 2024.3703
关键字 steam、steamworks、overlay、overlayStatus
另请参阅 steamworks.addEventListener()
steamworks.*

概述

当 Steam 叠层显示或隐藏时,会发生此事件。可以通过调用插件的“显示”API 或用户已按下时显示叠层Shift+Tab(默认 Steam 键绑定会显示其叠层)。如果用户正在游戏过程中,最好在叠层显示时暂停游戏。

您可以通过 steamworks.addEventListener() 函数将 侦听器 添加到插件来接收这些事件。

属性

event.name

event.phase

示例

local steamworks = require( "plugin.steamworks" )

-- Called when the Steam overlay has been shown/hidden
local function onOverlayStatusChanged( event )
    if ( event.phase == "shown" ) then
        -- Steam overlay is being shown
        -- You might want to pause gameplay here
    else
        -- Steam overlay is no longer being shown
    end
end

-- Set up a listener to be invoked when the Steam overlay has been shown/hidden
steamworks.addEventListener( "overlayStatus", onAchievementUpdated )