PFLobbyDataUpdate
ロビーの共有部分を更新する要求。
構文
struct PFLobbyDataUpdate {
const PFEntityKey* newOwner;
const uint32_t* maxMemberCount;
const PFLobbyAccessPolicy* accessPolicy;
const PFLobbyMembershipLock* membershipLock;
uint32_t searchPropertyCount;
const char* const* searchPropertyKeys;
const char* const* searchPropertyValues;
uint32_t lobbyPropertyCount;
const char* const* lobbyPropertyKeys;
const char* const* lobbyPropertyValues;
}
メンバー
newOwner const PFEntityKey*
nullptr でもかまいません
ロビーのオプションの新しい所有者。
この値は、次のいずれかの条件でのみ更新できます。
- このフィールドを更新するメンバーはロビーの現在の所有者です
- 所有者移行ポリシーは
PFLobbyOwnerMigrationPolicy::Manualで、現在所有者がいません - 所有者移行ポリシーは
PFLobbyOwnerMigrationPolicy::Noneです
このロビーがクライアント所有の場合 (現在の所有者は title_player_account エンティティ)、新しい所有者も title_player_account エンティティである必要があります。 このロビーがサーバー所有の場合 (現在の所有者は game_serverエンティティ)、新しい所有者も game_server エンティティである必要があります。
maxMemberCount const uint32_t*
nullptr でもかまいません
このロビーのメンバー数のオプションの更新された容量。
この新しい値は、ロビーに現在存在するメンバーの数より大きく、PFLobbyMaxMemberCountUpperLimit より小さい値にする必要があります。
この値は、現在のロビー所有者のみが更新できます。
accessPolicy const PFLobbyAccessPolicy*
nullptr でもかまいません
このロビーのオプションの更新されたアクセス ポリシー。
この値は、現在のロビー所有者のみが更新できます。
membershipLock const PFLobbyMembershipLock*
nullptr でもかまいません
このロビーのメンバーシップ ロックのオプションの更新。
この値は、現在のロビー所有者のみが更新できます。
searchPropertyCount uint32_t
更新する検索プロパティの数。
現在のロビー所有者のみが検索プロパティを更新できます。
同時検索プロパティは、一度に PFLobbyMaxSearchPropertyCount 個のみ可能です。 そのため、これらのプロパティの半分を削除する場合、この更新プログラムで指定できる一意のプロパティの数は最大で 2 倍になります。
プロパティの制限に違反すると、更新操作全体が失敗します。
searchPropertyKeys const char* const*
サイズ searchPropertyCount の配列
更新する検索プロパティのキー。
ロビー プロパティを更新できるのは、現在のロビー所有者のみです。
検索プロパティは、ロビーの検索結果のフィルター処理と並べ替えに使用できるメタデータとしてロビーのメンバー以外に表示されます。
このキーの一覧で指定されたプロパティのみが更新されます。 キーがまだ存在しない場合は、プロパティが作成されます。 新しいプロパティ値が nullptr の場合、プロパティは削除されます。 この一覧から省略した既存のプロパティは変更されずに残ります。
検索プロパティは、string_keyN または number_keyN の形式である必要があります。ここで、"N" は 1 ~ PFLobbyMaxSearchPropertyCount の数値です。 例: string_key1、number_key14 など。
searchPropertyValues const char* const*
サイズ searchPropertyCount の配列
更新する検索プロパティの値。
現在のロビー所有者のみが検索プロパティを更新できます。
検索プロパティは、ロビーの検索結果のフィルター処理と並べ替えに使用できるメタデータとしてロビーのメンバー以外に表示されます。
値を削除するには、新しい値として nullptr を指定します。
lobbyPropertyCount uint32_t
更新するロビー プロパティの数。
ロビー プロパティを更新できるのは、現在のロビー所有者のみです。
ロビー プロパティは、同時に一度に PFLobbyMaxLobbyPropertyCount 個のみ可能です。 そのため、これらのプロパティの半分を削除する場合、この更新プログラムで指定できる一意のプロパティの数は最大で 2 倍になります。
プロパティの制限に違反すると、更新操作全体が失敗します。
lobbyPropertyKeys const char* const*
サイズ lobbyPropertyCount の配列
更新するロビー プロパティのキー。
ロビー プロパティを更新できるのは、現在のロビー所有者のみです。
ロビーのプロパティは、ロビーのメンバーにのみ表示されます。
このキーの一覧で指定されたプロパティのみが更新されます。 キーがまだ存在しない場合は、プロパティが作成されます。 新しいプロパティ値が nullptr の場合、プロパティは削除されます。 この一覧から省略した既存のプロパティは変更されずに残ります。
lobbyPropertyValues const char* const*
サイズ lobbyPropertyCount の配列
更新するロビー プロパティの値。
ロビー プロパティを更新できるのは、現在のロビー所有者のみです。
ロビーのプロパティは、ロビーのメンバーにのみ表示されます。
値を削除するには、新しい値として nullptr を指定します。
解説
ロビーの共有部分のほとんどのデータは、所有者のみが更新できます。 確認については、各フィールドのドキュメントを確認してください。
要件
ヘッダー: PFLobby.h