PFLobbyCreateConfiguration

The initial configuration data used when creating a lobby.

Syntax

struct PFLobbyCreateConfiguration {  
    uint32_t maxMemberCount;  
    PFLobbyOwnerMigrationPolicy ownerMigrationPolicy;  
    PFLobbyAccessPolicy accessPolicy;  
    uint32_t searchPropertyCount;  
    const char* const* searchPropertyKeys;  
    const char* const* searchPropertyValues;  
    uint32_t lobbyPropertyCount;  
    const char* const* lobbyPropertyKeys;  
    const char* const* lobbyPropertyValues;  
}  

Members

maxMemberCount   uint32_t

The maximum number of members allowed in the new lobby.

This value must be at least PFLobbyMaxMemberCountLowerLimit and no more than PFLobbyMaxMemberCountUpperLimit.

If a client would violate this limit by calling PFMultiplayerJoinLobby() or PFLobbyAddMember, the operation will fail asynchronously.

ownerMigrationPolicy   PFLobbyOwnerMigrationPolicy

The owner migration policy for the new lobby.

When passed to PFMultiplayerCreateAndJoinLobby(), this value cannot be PFLobbyOwnerMigrationPolicy::Server. When passed to PFMultiplayerCreateAndClaimServerLobby(), this value must be PFLobbyOwnerMigrationPolicy::Server.

accessPolicy   PFLobbyAccessPolicy

The access policy for the new lobby.

searchPropertyCount   uint32_t

The number of initial search properties for the new lobby.

searchPropertyKeys   const char* const*
array of size searchPropertyCount

The keys of the initial search properties for the new lobby.

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

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 initial search properties for the new lobby.

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

lobbyPropertyCount   uint32_t

The number of initial lobby properties for the new lobby.

lobbyPropertyKeys   const char* const*
array of size lobbyPropertyCount

The keys of the initial lobby properties for the new lobby.

Lobby properties are only visible to members of the lobby.

lobbyPropertyValues   const char* const*
array of size lobbyPropertyCount

The values of the initial lobby properties for the new lobby.

Lobby properties are only visible to members of the lobby.

Requirements

Header: PFLobby.h

See also

PFLobby members