通过

XGameUiShowPlayerPickerAsync

  • 项目

显示一个选取器 UI，它允许正玩游戏的某个人从展示的人员列表中选择玩家。

语法

HRESULT XGameUiShowPlayerPickerAsync(  
         XAsyncBlock* async,  
         XUserHandle requestingUser,  
         const char* promptText,  
         uint32_t selectFromPlayersCount,  
         const uint64_t* selectFromPlayers,  
         uint32_t preSelectedPlayersCount,  
         const uint64_t* preSelectedPlayers,  
         uint32_t minSelectionCount,  
         uint32_t maxSelectionCount  
)

参数

async _In_
类型：XAsyncBlock*

指向传递到 XAsyncRun 的 XAsyncBlock 的指针。

requestingUser _In_
类型：XUserHandle

请求玩家选取器 UI 的用户的句柄。

promptText _In_z_
类型：char*

提示显示文本。

selectFromPlayersCount _In_
类型：uint32_t

调用方可从中选择的玩家数。

selectFromPlayers _In_reads_(selectFromPlayersCount)
类型：uint64_t*

指向调用方可以从中选择的玩家 ID 的列表的指针。

preSelectedPlayersCount _In_
类型：uint32_t

在呈现 UI 时预先选择的玩家数。

preSelectedPlayers _In_reads_opt_(preSelectedPlayersCount)
类型：uint64_t*

指向在呈现 UI 时预先选择的玩家 ID 列表的指针。

minSelectionCount _In_
类型：uint32_t

调用方必须选择的最少人数。

maxSelectionCount _In_
类型：uint32_t

调用方可以选择的最多人数。

返回值

类型：HRESULT

异步调用的 HRESULT 成功或错误代码。

要获取结果，请在 AsyncBlock 回调中或 AsyncBlock 完成后调用 XGameUiShowPlayerPickerResultCount 和 XGameUiShowPlayerPickerResult。

备注

玩家 ID 必须是作为 uint64_t 值的 Xbox 用户 ID (XUID)。

调用 UI 将导致游戏进入约束模式。 在约束模式下，您的游戏将在处于已调用的 UI 的后台中时接收较少的系统资源。 要详细了解游戏的约束模式和其他操作模式，请参阅 Xbox 游戏生命周期（NDA 主题）。

要求

头文件： XGameUI.h

库：xgameruntime.lib

支持平台：Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XGameUI
XGameUiShowPlayerPickerResult
XGameUiShowPlayerPickerResultCount
Xbox 游戏生命周期（NDA 主题）