EOS API reference page for EOS_Lobby_CreateLobbyOptions

5 mins to read

This data structure is part of the Lobby Interface.


Input parameters for the EOS_Lobby_CreateLobby function.



int32_t ApiVersionAPI Version: Set this to EOS_LOBBY_CREATELOBBY_API_LATEST.
EOS_ProductUserId LocalUserIdThe Product User ID of the local user creating the lobby; this user will automatically join the lobby as its owner
uint32_t MaxLobbyMembersThe maximum number of users who can be in the lobby at a time
EOS_ELobbyPermissionLevel PermissionLevelThe initial permission level of the lobby
EOS_Bool bPresenceEnabledIf true, this lobby will be associated with 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 bAllowInvitesAre members of the lobby allowed to invite others
const char* BucketIdBucket ID associated with the lobby
EOS_Bool bDisableHostMigrationIs 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 bEnableRTCRoomCreates 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 bEnableJoinByIdIs 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 bRejoinAfterKickRequiresInviteDoes 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.