UI Interface

Epic在线服务（EOS）支持通过覆层系统实现与产品相独立的窗口系统；这些覆层使用户能够独立于产品访问各种功能。UI接口（UI Interface）通过提供状态更新，显示或隐藏覆层，调整显示和热键偏好设置来管理与覆层的交互。

如需访问UI接口，你需要通过平台接口函数 EOS_Platform_GetUIInterface 获取 EOS_HUI 句柄。所有UI接口函数都需要此句柄作为其第一个参数。你必须确保 EOS_HPlatform 句柄处于更新状态，以便在操作完成时触发回调。

每个覆层都独立于产品运行，并与所有其他EOS产品以统一的方式运行。UI接口无法直接控制覆层，无法从它们读取数据或向它们写入数据，但它可以命令它们显示或隐藏自身，检测某个覆层当前是否可见，获取或设置用于显示或隐藏某个覆层的用户热键。

如需显示好友列表页，请使用 EOS_UI_ShowFriendsOptions 数据结构调用 EOS_UI_ShowFriends，初始化方法如下：

完成后，你的回调函数（类型是 EOS_UI_OnShowFriendsCallback）将接收到一个调用，其中包含一个 EOS_UI_ShowFriendsCallbackInfo 数据结构。

如需隐藏好友列表页，请使用包含以下信息的 EOS_UI_HideFriendsOptions 结构调用 EOS_UI_HideFriends：

操作完成后，EOS会运行你的回调函数（类型是 EOS_UI_OnHideFriendsCallback），向它传递一个 EOS_UI_HideFriendsCallbackInfo 类型的参数。

EOS_UI_ShowBlockPlayer和EOS_UI_ShowReportPlayer会在游戏中触发一个覆层，显示一个用于报告或屏蔽玩家的对话框。玩家可通过对话框来选择是否报告或屏蔽某位玩家，或者从该对话框中退出。

玩家在游戏中通过 EOS_UI_ShowReportPlayer 触发社交功能时，请在游戏中明确告诉玩家他们将调用该功能，并说明该功能是一个独立的覆层功能。 例如： RTCP聊天室中的 “REPORT” 按钮。

请参照下文配置 EOS_UI_ShowBlockPlayerOptions 参数：

请参照下文配置 EOS_UI_ShowReportPlayerOptions 的参数：

UI接口提供了两种级别的可视性状态信息。

第一种是覆层系统本身。当某个覆层中至少有一个页面显示时，系统整体上被视为可见的。此信息在制定某些高级决策时会非常有用，例如将输入路由到何处，或者何时暂停模拟。

第二种是针对单个页面的。这有助于了解代码是否应该发出指令，以便打开或关闭页面，或者用于确定玩家是否能够看到他们可能需要的信息。

EOS SDK允许开发人员注册回调函数，以便报告覆层系统的整体可视性状态。如需注册你的回调（类型为 EOS_UI_OnDisplaySettingsUpdatedCallback），请在加载EOS SDK时调用 EOS_UI_AddNotifyDisplaySettingsUpdated，并传入经过正确初始化的 EOS_UI_AddNotifyDisplaySettingsUpdatedOptions 数据结构：

在关闭时，请用 EOS_UI_RemoveNotifyDisplaySettingsUpdated 以及 EOS_UI_AddNotifyDisplaySettingsUpdated 最初注册时返回的 EOS_NotificationId 来移除回调。

所有可以被UI接口显示或隐藏的页面都有专门的函数来报告其可视性状态。如果是好友列表页面，请调用 EOS_UI_GetFriendsVisible，并以以下方式初始化 EOS_UI_GetFriendsVisibleOptions：

EOS_UI_GetFriendsVisible 会返回 EOS_Bool，表示页面是否可见。

社交覆层会在收到通知时进行处理。如需暂停此行为，清使用EOS_UI_PauseSocialOverlay。一般而言，你会在过场动画或加载界面中用到此功能。EOS_UI_IsSocialOverlayPaused可用于获取之前设置的暂停状态。

请参照下文配置 EOS_UI_PauseSocialOverlayOptions 参数：

用户可以用热键显示或隐藏覆层。热键支持页面切换，因此它既可以显示页面也可以隐藏页面。

要定义热键，必须选择一个主键以及一个或多个修改键。主键可以是 F1 到 F12、空格、退格键（Backspace）、结束键（Escape） 或 Tab。修改键包括 Shift、Control 和 Alt。

要描述热键，请使用 EOS_UI_EKeyCombination。你可以通过逐位“或”（OR）运算来构建一个热键组合，并使用 EOS_UI_IsValidKeyCombination 来验证它是否可以作为热键，示例代码如下：

UI接口提供了一些函数，可用于检查特定页面的当前热键，将热键设置为新值，或将其重置为系统默认值（使用 EOS_UI_EKeyCombination::EOS_UIK_NONE）。

请调用 EOS_UI_GetToggleFriendsKey 获取好友列表页面的当前热键。EOS_UI_GetToggleFriendsKeyOptions 参数配置如下：

如需设置（或重置）好友列表页面的热键，请使用 EOS_UI_SetToggleFriendsKeyOptions，EOS_UI_SetToggleFriendsKeyOptions 初始化方法如下：