steamworks.removeEventListener()

类型 函数
返回值 布尔
修订版 版本 2024.3703
关键字 steam、steamworks、事件、removeEventListener
另请参阅 steamworks.addEventListener()
steamworks.*

概述

移除之前通过 steamworks.addEventListener() 函数添加到该插件的监听器。这将阻止该监听器为其对应事件调用。

如果监听器已从插件成功移除，则返回 true。如果给出了无效参数或给定的监听器引用尚未添加到该插件，则返回 false。

语法

steamworks.removeEventListener( eventName, listener )
eventName (必需)

字符串. 要停止监听的事件名称。必须为以下之一

  • "achievementImageUpdate" (参考)
  • "achievementInfoUpdate" (参考)
  • "microtransactionAuthorization" (参考)
  • "overlayStatus" (参考)
  • "userInfoUpdate" (参考)
  • "userProgressSave" (参考)
  • "userProgressUnload" (参考)
  • "userProgressUpdate" (参考)
listener (必需)

监听器. 对最初添加到 steamworks.addEventListener() 函数的相同监听器的引用。

示例

local steamworks = require( "plugin.steamworks" )

-- Set up a listener to be called when Steam's overlay has been shown/hidden
local function onSteamOverlayStatusChanged( event )
    print( "Steam Overlay Phase: " .. event.phase )
end
steamworks.addEventListener( "overlayStatus", onSteamOverlayStatusChanged )

-- Sometime later, stop listening to the Steam overlay that was set
steamworks.removeEventListener( "overlayStatus", onSteamOverlayStatusChanged )