Syntax
enum class PartyOption : uint32_t
{
LocalUdpSocketBindAddress = 0,
LocalDeviceDirectPeerConnectivityOptionsMask = 1,
TextChatFilterLevel = 2,
LocalDeviceMaxDirectPeerConnections = 3,
RegionUpdateConfiguration = 4,
RegionQualityMeasurementConfiguration = 5,
}
Constants
| Constant | Description | ||
|---|---|---|---|
| LocalUdpSocketBindAddress | 一个用于配置 Party 库如何绑定到 UDP 套接字的选项。 若要重写此选项，请调用 PartyManager::SetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向 PartyLocalUdpSocketBindAddressConfiguration 结构的可选指针。如果提供了 null PartyLocalUdpSocketBindAddressConfiguration 指针，则会还原默认配置。 若要查询此选项，请调用 PartyManager::GetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向输出 PartyLocalUdpSocketBindAddressConfiguration 结构的指针。 在初始化 Party 库之前重写或查询此选项是安全的，并且是推荐的。重写本地 UDP 套接字绑定地址配置将在下次初始化 Party 库时生效。它不会修改已初始化的任何 Party 库套接字绑定。同样，查询检索的是将用于下次 Party 库初始化的配置，而不是已初始化时正在使用的值。 | ||
| LocalDeviceDirectPeerConnectivityOptionsMask | 一个选项，用于在允许尝试此类连接的网络中约束本地设备与其他设备之间允许的直接对等连接。 当成功将初始本地用户身份验证进入某个 PartyNetworkConfiguration::directPeerConnectivityOptions 字段设置为非 PartyDirectPeerConnectivityOptions::None 值的网络时，或当远程设备身份验证进入这样的网络时，可能会尝试在本地设备与网络中的远程设备之间进行直接对等连接。此选项配置的标志可用于进一步约束允许涉及本地设备进行这些尝试的特定类型的远程设备。所有标志均使用按位 AND 运算进行评估。也就是说，只有当特定标志在三处均已启用时，它才会对给定网络的一对设备实际生效：网络的 PartyNetworkConfiguration 结构中，以及两台设备各自的本地掩码选项中。即使 Party 网络允许相关形式的直接对等连接，任一设备也可通过在重写此选项时不启用该标志，单方面选择退出彼此之间的 IP 地址披露和直接连接尝试。 Windows、Microsoft Game Core、PlayStation®、Switch、Linux 和 macOS 版本的库支持直接对等连接。在这些平台上，尚未设置本地设备掩码时的默认值为 ```PartyDirectPeerConnectivityOptions::AnyPlatformType | PartyDirectPeerConnectivityOptions::AnyEntityLoginProvider | PartyDirectPeerConnectivityOptions::OnlyServers。这意味着此类设备不会限制网络的 [PartyNetworkConfiguration](/services/playfab/multiplayer/networking/reference/structs/partynetworkconfiguration) 所允许的任何直接对等连接，直到显式将其重写为限制性更强的值。对于库的所有其他版本，本地设备掩码的默认值为 PartyDirectPeerConnectivityOptions::None``` 且无法更改；尝试通过 PartyManager::SetOption 更改它将失败。这意味着此类设备永远不会尝试直接对等连接。 若要重写此选项，请调用 PartyManager::SetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向包含所需所有选项标志的 PartyDirectPeerConnectivityOptions 变量的可选指针。如果提供了 null PartyDirectPeerConnectivityOptions 指针，则会还原默认选项。 若要查询此选项，请调用 PartyManager::GetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向 PartyDirectPeerConnectivityOptions 变量的指针，用于写入当前配置的选项标志。 建议在未连接到任何网络时重写或查询此选项。已配置的值将在此设备下次将初始用户身份验证进入新网络时生效。它不会改变已在使用中的、用于参与任何现有网络的设置。同样，查询检索的是将用于将来网络的当前配置值，而不是用于现有网络的值。 在初始化 Party 库之前重写或查询此选项也是安全的。 |
| TextChatFilterLevel | 一个用于微调聊天文本筛选级别的选项。 此功能仅适用于检测为英语的传入聊天文本。无法为其他语言更改筛选级别。 该筛选级别将应用于客户端上所有本地聊天控件的传入聊天文本。必须至少为一个本地聊天控件使用 PartyLocalChatControl::SetTextChatOptions 启用筛选，此设置才会对聊天文本产生影响。 若要重写此选项，请调用 PartyManager::SetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向包含所需筛选级别的 PartyTextChatFilterLevel 变量的可选指针。如果提供了 null PartyTextChatFilterLevel 指针，则会还原默认级别。 若要查询此选项，请调用 PartyManager::GetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向 PartyTextChatFilterLevel 变量的指针，用于写入当前配置的筛选级别。 随时（包括在初始化 Party 库之前）重写或查询此选项都是安全的。设置新值将立即生效。 | ||
| LocalDeviceMaxDirectPeerConnections | 一个选项，用于配置此设备尝试与其他设备建立的直接对等连接的最大数量。 当成功将初始本地用户身份验证进入某个 PartyNetworkConfiguration::directPeerConnectivityOptions 字段设置为非 PartyDirectPeerConnectivityOptions::None 值的网络时，设备之间可能会尝试直接对等连接。为避免过度消耗资源，Party 库将在内部阻止任何给定设备在其当前参与的所有网络中尝试建立超过此最大数量的直接对等连接。这不会影响设备参与更多远程设备的大型或多个网络的能力，它只是定义了设备之间的终结点消息和聊天数据可以使用这些直接连接（而不是通过透明云中继服务器）传输的机会数量。 你可以通过调用 PartyNetwork::GetDeviceConnectionType() 来确定本地设备是否实际建立了与网络中特定远程设备的直接对等连接。 此选项的默认值为 c_maxDirectPeerConnectionsPerDevice，但是在使用默认设置时，该值仅在使用 PlayFab 实体类型 title_player_account 对本地用户进行身份验证时适用。相反，在使用默认选项配置对具有 PlayFab 实体类型 game_server 的本地用户进行身份验证时，没有直接对等连接的最大数量。 若要不论 PlayFab 实体类型如何都重写此值，请调用 PartyManager::SetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向 uint32_t 变量的可选指针。如果提供了 null uint32_t 指针，则会还原默认值和行为。 若要查询此选项，请调用 PartyManager::GetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向 uint32_t 变量的指针，用于写入当前配置的值。 随时（包括在初始化 Party 库之前）重写或查询此选项都是安全的。设置新值将对更改值之后加入的所有网络生效。 | ||
| RegionUpdateConfiguration | 一个用于配置 Party 库何时执行自动区域发现和连接质量测量更新的选项。 若要重写此选项，请调用 PartyManager::SetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向 PartyRegionUpdateConfiguration 结构的可选指针。如果提供了 null PartyRegionUpdateConfiguration 指针，则会还原默认配置。 若要查询此选项，请调用 PartyManager::GetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向输出 PartyRegionUpdateConfiguration 结构的指针。 随时（包括在初始化 Party 库之前）重写或查询此选项都是安全的。重写区域更新配置将立即生效。 | ||
| RegionQualityMeasurementConfiguration | 一个选项，用于对 Party 库区域质量测量行为进行细粒度控制。 若要重写此选项，请调用 PartyManager::SetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向 PartyRegionQualityMeasurementConfiguration 结构的可选指针。如果提供了 null PartyRegionQualityMeasurementConfiguration 指针，则会还原默认配置。 若要查询此选项，请调用 PartyManager::GetOption，为 object 参数传递 null，为 option 参数传递此值，并为 value 传递指向输出 PartyRegionQualityMeasurementConfiguration 结构的指针。 随时（包括在初始化 Party 库之前）重写或查询此选项都是安全的。重写区域质量测量配置将在下次区域更新时生效。 |
Requirements
Header: Party.hSee also
Party membersPartyManager::SetOption
PartyManager::GetOption
PartyLocalUdpSocketBindAddressConfiguration
PartyNetworkConfiguration
PartyDirectPeerConnectivityOptions
PartyRegionUpdateConfiguration
PartyRegionQualityMeasurementConfiguration