steamworks.addEventListener()

类型 函数
返回值 布尔值
修订版 发行 2024.3703
关键词 steam、steamworks、event、addEventListener
另请参阅 steamworks.removeEventListener()
steamworks.*

概述

在插件的事件监听器集合中添加监听器。在指定事件发生时，调用监听器并提供一个表，表示该事件。

如果成功将监听器添加到插件，则返回 true。如果给出无效参数（如监听器不是函数、或其是缺少与事件名称匹配的函数的表），则返回 false。

语法

steamworks.addEventListener( eventName, listener )
eventName （必填）

字符串. 要侦听的事件名称。必须为以下选项之一

  • "achievementImageUpdate"（参考）
  • "achievementInfoUpdate"（参考）
  • "microtransactionAuthorization"（参考）
  • "overlayStatus"（参考）
  • "userInfoUpdate"（参考）
  • "userProgressSave"（参考）
  • "userProgressUnload"（参考）
  • "userProgressUpdate"（参考）
listener （必填）

监听器. 插件分派一个其 name 属性与所给 eventName 参数匹配的事件时调用的监听器。此参数必须是一个函数或包含一个具有与该事件相同的名称的函数的表对象。

示例

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 )

-- Set up a listener to be called when a Steam user's info has been changed
local function onSteamUserInfoUpdated( event )
    print( "Steam user info has changed." )
end
steamworks.addEventListener( "userInfoUpdate", onSteamUserInfoUpdated )