語法
enum class PartyOption : uint32_t
{
LocalUdpSocketBindAddress = 0,
LocalDeviceDirectPeerConnectivityOptionsMask = 1,
TextChatFilterLevel = 2,
LocalDeviceMaxDirectPeerConnections = 3,
RegionUpdateConfiguration = 4,
RegionQualityMeasurementConfiguration = 5,
}
常數
| 常數 | 描述 |
|---|---|
| LocalUdpSocketBindAddress | 用於設定 Party 程式庫如何繫結至 UDP 通訊端的選項。 若要覆寫此選項,請呼叫 PartyManager::SetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向 PartyLocalUdpSocketBindAddressConfiguration 結構的選用指標作為值。如果提供 null 的 PartyLocalUdpSocketBindAddressConfiguration 指標,則會還原預設設定。 若要查詢此選項,請呼叫 PartyManager::GetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向輸出 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 所允許的任何直接對等連線。對於所有其他版本的程式庫,本機裝置遮罩的預設值為 PartyDirectPeerConnectivityOptions::None 且無法變更;嘗試透過 PartyManager::SetOption 變更將會失敗。這表示這類裝置永遠不會嘗試直接對等連線。 若要覆寫此選項,請呼叫 PartyManager::SetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向包含所有所需選項旗標之 PartyDirectPeerConnectivityOptions 變數的選用指標。如果提供 null 的 PartyDirectPeerConnectivityOptions 指標,則會還原預設選項。 若要查詢此選項,請呼叫 PartyManager::GetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向 PartyDirectPeerConnectivityOptions 變數的指標,目前設定的選項旗標應寫入其中。 建議在未連線到任何網路時覆寫或查詢此選項。設定的值會在此裝置下一次將初始使用者驗證到新網路時生效。它不會變更已用於參與任何現有網路的設定。同樣地,查詢會擷取目前設定且將用於未來網路的值,而非用於現有網路的值。 在初始化 Party 程式庫之前覆寫或查詢此選項也是安全的。 |
| TextChatFilterLevel | 用於微調聊天文字篩選層級的選項。 此功能只適用於偵測為英文的傳入聊天文字。其他語言的篩選層級無法變更。 篩選層級會套用至用戶端上所有本機聊天控制項的傳入聊天文字。必須至少對一個本機聊天控制項使用 PartyLocalChatControl::SetTextChatOptions 啟用篩選,才會對聊天文字產生作用。 若要覆寫此選項,請呼叫 PartyManager::SetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向包含所需篩選層級之 PartyTextChatFilterLevel 變數的選用指標。如果提供 null 的 PartyTextChatFilterLevel 指標,則會還原預設層級。 若要查詢此選項,請呼叫 PartyManager::GetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向 PartyTextChatFilterLevel 變數的指標,目前設定的篩選層級應寫入其中。 可以隨時安全地覆寫或查詢此選項,包括在初始化 Party 程式庫之前。設定新值會立即生效。 |
| LocalDeviceMaxDirectPeerConnections | 用於設定此裝置嘗試與其他裝置建立之直接對等連線數目上限的選項。 在將初始本機使用者成功驗證到 PartyNetworkConfiguration::directPeerConnectivityOptions 欄位設為 PartyDirectPeerConnectivityOptions::None 以外值的網路中時,裝置可能會嘗試彼此建立直接對等連線。為了避免耗用過多資源,Party 程式庫會在內部防止任何指定裝置在其目前參與的所有網路中,嘗試建立超過此上限的直接對等連線。這不會影響裝置參與具有更多遠端裝置之大型網路或多個網路的能力,它只是定義裝置之間的端點訊息和聊天資料使用這些直接連線 (而非透過透明雲端轉送伺服器) 傳輸的機會數目。 您可以呼叫 PartyNetwork::GetDeviceConnectionType(),判斷本機裝置是否實際與網路中的特定遠端裝置建立了直接對等連線。 此選項的預設值為 c_maxDirectPeerConnectionsPerDevice,不過使用預設設定時,此值只適用於驗證 PlayFab 實體類型為 title_player_account 的本機使用者。改為以預設選項設定驗證 PlayFab 實體類型為 game_server 的本機使用者時,則沒有直接對等連線數目上限。 若要不論 PlayFab 實體類型為何都覆寫此值,請呼叫 PartyManager::SetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向 uint32_t 變數的選用指標作為值。如果提供 null 的 uint32_t 指標,則會還原預設值和行為。 若要查詢此選項,請呼叫 PartyManager::GetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向 uint32_t 變數的指標,目前設定的值應寫入其中。 可以隨時安全地覆寫或查詢此選項,包括在初始化 Party 程式庫之前。設定新值會對變更值之後加入的所有網路生效。 |
| RegionUpdateConfiguration | 用於設定 Party 程式庫何時執行自動區域探索和連線品質測量更新的選項。 若要覆寫此選項,請呼叫 PartyManager::SetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向 PartyRegionUpdateConfiguration 結構的選用指標作為值。如果提供 null 的 PartyRegionUpdateConfiguration 指標,則會還原預設設定。 若要查詢此選項,請呼叫 PartyManager::GetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向輸出 PartyRegionUpdateConfiguration 結構的指標作為值。 可以隨時安全地覆寫或查詢此選項,包括在初始化 Party 程式庫之前。覆寫區域更新設定會立即生效。 |
| RegionQualityMeasurementConfiguration | 用於精細控制 Party 程式庫區域品質測量行為的選項。 若要覆寫此選項,請呼叫 PartyManager::SetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向 PartyRegionQualityMeasurementConfiguration 結構的選用指標作為值。如果提供 null 的 PartyRegionQualityMeasurementConfiguration 指標,則會還原預設設定。 若要查詢此選項,請呼叫 PartyManager::GetOption,為物件參數傳遞 null,為選項參數傳遞此值,並傳遞指向輸出 PartyRegionQualityMeasurementConfiguration 結構的指標作為值。 可以隨時安全地覆寫或查詢此選項,包括在初始化 Party 程式庫之前。覆寫區域品質測量設定會在下一次區域更新時生效。 |
需求
標頭: Party.h另請參閱
Party 成員PartyManager::SetOption
PartyManager::GetOption
PartyLocalUdpSocketBindAddressConfiguration
PartyNetworkConfiguration
PartyDirectPeerConnectivityOptions
PartyRegionUpdateConfiguration
PartyRegionQualityMeasurementConfiguration
