PFLobbyDataUpdate

  • Article

A request to make an update to the shared portion of the lobby.

Syntax

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;  
}

Members

newOwner   const PFEntityKey*
may be nullptr

An optional, new owner of the lobby.

This value can only be updated under one of the following conditions:

  • The member updating this field is the lobby's current owner
  • The owner migration policy is PFLobbyOwnerMigrationPolicy::Manual and there is currently no owner
  • The owner migration policy is PFLobbyOwnerMigrationPolicy::None

    If this lobby is client-owned (the current owner is a title_player_account entity), the new owner must also be a title_player_account entity. If this lobby is server-owned (the current owner is a game_server entity), the new owner must also be a game_server entity.

maxMemberCount   const uint32_t*
may be nullptr

An optional, updated capacity for the number of members in this lobby.

This new value must be greater than than the number of members currently in the lobby and less than PFLobbyMaxMemberCountUpperLimit.

This value can only be updated by the current lobby owner.

accessPolicy   const PFLobbyAccessPolicy*
may be nullptr

An optional, updated access policy for this lobby.

This value can only be updated by the current lobby owner.

membershipLock   const PFLobbyMembershipLock*
may be nullptr

An optional update to the membership lock on this lobby.

This value can only be updated by the current lobby owner.

searchPropertyCount   uint32_t

The number of search properties to update.

Only the current lobby owner can update the search properties.

There may only be PFLobbyMaxSearchPropertyCount concurrent search properties at any given time. Therefore, at most, twice that many unique properties can be specified in this update if half of those properties are being deleted.

If the property limits are violated, the entire update operation will fail.

searchPropertyKeys   const char* const*
array of size searchPropertyCount

The keys of the search properties to update.

Only the current lobby owner can update the lobby properties.

Search properties are visible to non-members of the lobby as metadata which can be used to filter and sort lobby search results.

Only the properties specified in this list of keys will be updated. If the key doesn't exist yet, the property will be created. If the new property value is nullptr, the property will be deleted. Any existing properties omitted from this list will be left unmodified.

Search properties must be of the form string_keyN or number_keyN where "N" is a number between 1 and PFLobbyMaxSearchPropertyCount. e.g. string_key1, number_key14, etc.

searchPropertyValues   const char* const*
array of size searchPropertyCount

The values of the search properties to update.

Only the current lobby owner can update the search properties.

Search properties are visible to non-members of the lobby as metadata which can be used to filter and sort lobby search results.

To delete a value, provide nullptr as its new value.

lobbyPropertyCount   uint32_t

The number of lobby properties to update.

Only the current lobby owner can update the lobby properties.

There may only be PFLobbyMaxLobbyPropertyCount concurrent lobby properties at any given time. Therefore, at most, twice that many unique properties can be specified in this update if half of those properties are being deleted.

If the property limits are violated, the entire update operation will fail.

lobbyPropertyKeys   const char* const*
array of size lobbyPropertyCount

The keys of the lobby properties to update.

Only the current lobby owner can update the lobby properties.

Lobby properties are only visible to members of the lobby.

Only the properties specified in this list of keys will be updated. If the key doesn't exist yet, the property will be created. If the new property value is nullptr, the property will be deleted. Any existing properties omitted from this list will be left unmodified.

lobbyPropertyValues   const char* const*
array of size lobbyPropertyCount

The values of the lobby properties to update.

Only the current lobby owner can update the lobby properties.

Lobby properties are only visible to members of the lobby.

To delete a value, provide nullptr as its new value.

Remarks

Most data in the shared portion of the lobby can only be updated by the owner. Check the documentation for each field for confirmation.

Requirements

Header: PFLobby.h

See also

PFLobby members