This data structure is part of the Lobby Interface.
Remarks
Input parameters for the EOS_Lobby_CreateLobby function.
Properties
EOS_Lobby_CreateLobbyOptions
| Property | Value |
|---|---|
| int32_t ApiVersion | API Version: Set this to EOS_LOBBY_CREATELOBBY_API_LATEST. |
| EOS_ProductUserId LocalUserId | The Product User ID of the local user creating the lobby; this user will automatically join the lobby as its owner |
| uint32_t MaxLobbyMembers | The maximum number of users who can be in the lobby at a time |
| EOS_ELobbyPermissionLevel PermissionLevel | The initial permission level of the lobby |
| EOS_Bool bPresenceEnabled | If true, this lobby will be associated with the local user's presence information. A user's presence can only be associated with one lobby at a time. This affects the ability of the Social Overlay to show game related actions to take in the user's social graph. * using the bPresenceEnabled flags within the Sessions interface * using the bPresenceEnabled flags within the Lobby interface * using EOS_PresenceModification_SetJoinInfo |
| EOS_Bool bAllowInvites | Are members of the lobby allowed to invite others |
| const char* BucketId | Bucket ID associated with the lobby |
| EOS_Bool bDisableHostMigration | Is host migration allowed (will the lobby stay open if the original host leaves?) NOTE: EOS_Lobby_PromoteMember is still allowed regardless of this setting |
| EOS_Bool bEnableRTCRoom | Creates a real-time communication (RTC) room for all members of this lobby. All members of the lobby will automatically join the RTC room when they connect to the lobby and they will automatically leave the RTC room when they leave or are removed from the lobby. While the joining and leaving of the RTC room is automatic, applications will still need to use the EOS RTC interfaces to handle all other functionality for the room. |
| const EOS_Lobby_LocalRTCOptions* LocalRTCOptions | (Optional) Allows the local application to set local audio options for the RTC Room if it is enabled. Set this to NULL if the RTC RTC room is disabled or you would like to use the defaults. |
| EOS_LobbyId LobbyId | (Optional) Set to a globally unique value to override the backend assignment If not specified the backend service will assign one to the lobby. Do not mix and match override and non override settings. This value can be of size [EOS_LOBBY_MIN_LOBBYIDOVERRIDE_LENGTH, EOS_LOBBY_MAX_LOBBYIDOVERRIDE_LENGTH] |
| EOS_Bool bEnableJoinById | Is EOS_Lobby_JoinLobbyById allowed. This is provided to support cases where an integrated platform's invite system is used. In these cases the game should provide the lobby ID securely to the invited player. Such as by attaching the lobby ID to the integrated platform's session data or sending the lobby ID within the invite data. |
| EOS_Bool bRejoinAfterKickRequiresInvite | Does rejoining after being kicked require an invite? When this is set, a kicked player cannot return to the session even if the session was set with EOS_LPL_PUBLICADVERTISED. When this is set, a player with invite privileges must use EOS_Lobby_SendInvite to allow the kicked player to return to the session. |
| const uint32_t* AllowedPlatformIds | Array of platform IDs indicating the player platforms allowed to register with the session. Platform IDs are found in the EOS header file, e.g. EOS_OPT_Epic. For some platforms, the value will be in the EOS Platform specific header file. If null, the lobby will be unrestricted. |
| uint32_t AllowedPlatformIdsCount | Number of platform IDs in the array |
| EOS_Bool bCrossplayOptOut | This value indicates whether or not the lobby owner allows crossplay interactions. If false, the lobby owner will be treated as allowing crossplay. If it is set to true, AllowedPlatformIds must have a single entry that matches the platform of the lobby owner. |