構文
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 操作を使用して評価されます。つまり、特定のフラグが特定のネットワークのデバイスのペアに対して実際に有効になるのは、それが 3 つの場所で有効になっている場合のみです。すなわち、ネットワークの 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 を呼び出し、オブジェクト パラメーターに null、オプション パラメーターにこの値、望ましいオプション フラグをすべて含む PartyDirectPeerConnectivityOptions 変数への省略可能なポインターを渡します。null の PartyDirectPeerConnectivityOptions ポインターが提供された場合、既定のオプションが復元されます。 このオプションを照会するには、PartyManager::GetOption を呼び出し、オブジェクト パラメーターに null、オプション パラメーターにこの値、現在構成されているオプション フラグを書き込む PartyDirectPeerConnectivityOptions 変数へのポインターを渡します。 どのネットワークにも接続されていないときにこのオプションをオーバーライドまたは照会することをお勧めします。構成された値は、このデバイスが次に新しいネットワークに最初のユーザーを認証するときに有効になります。既存のネットワークへの参加に既に使用されている設定は変更されません。同様に、照会は、既存のネットワークで使用されている値ではなく、将来のネットワークで使用される現在構成されている値を取得します。 Party ライブラリを初期化する前にこのオプションをオーバーライドまたは照会することも安全です。 |
| TextChatFilterLevel | チャット テキストがフィルターされるレベルを微調整するためのオプション。 この機能は、英語として検出された受信チャット テキストにのみ適用されます。他の言語ではフィルター レベルを変更できません。 フィルター レベルは、クライアント上のすべてのローカル チャット コントロールの受信チャット テキストに適用されます。これがチャット テキストに効果を持つには、少なくとも 1 つのローカル チャット コントロールで 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