Package host.anzo.eossdk.eos.sdk.lobby.options

Class EOS_Lobby_CreateLobbyOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.lobby.options.EOS_Lobby_CreateLobbyOptions
Direct Known Subclasses:
EOS_Lobby_CreateLobbyOptions.ByReference, EOS_Lobby_CreateLobbyOptions.ByValue
@FieldOrder({"ApiVersion","LocalUserId","MaxLobbyMembers","PermissionLevel","IsPresenceEnabled","IsAllowInvites","BucketId","IsDisableHostMigration","IsEnableRTCRoom","LocalRTCOptions","LobbyId","IsEnableJoinById","IsRejoinAfterKickRequiresInvite","AllowedPlatformIds","AllowedPlatformIdsCount","IsCrossplayOptOut"}) public class EOS_Lobby_CreateLobbyOptions extends com.sun.jna.Structure
Input parameters for the EOS_Lobby_CreateLobby function.
Since:
8/17/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_Lobby_CreateLobbyOptions.ByReference
     
    static class 
    EOS_Lobby_CreateLobbyOptions.ByValue
     

    Nested classes/interfaces inherited from class com.sun.jna.Structure

    com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    com.sun.jna.ptr.IntByReference
    AllowedPlatformIds
    Array of platform IDs indicating the player platforms allowed to register with the session.
    int
    AllowedPlatformIdsCount
    Number of platform IDs in the array
    int
    ApiVersion
    API Version: Set this to EOS_LOBBY_CREATELOBBY_API_LATEST.
    String
    BucketId
    Bucket ID associated with the lobby
    static final int
    EOS_LOBBY_CREATELOBBY_API_LATEST
    The most recent version of the EOS_Lobby_CreateLobby API.
    EOS_Bool
    IsAllowInvites
    Are members of the lobby allowed to invite others
    EOS_Bool
    IsCrossplayOptOut
    This value indicates whether or not the lobby owner allows crossplay interactions.
    EOS_Bool
    IsDisableHostMigration
    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
    IsEnableJoinById
    Is EOS_Lobby_JoinLobbyById allowed.
    EOS_Bool
    IsEnableRTCRoom
    Creates a real-time communication (RTC) room for all members of this lobby.
    EOS_Bool
    IsPresenceEnabled
    If true, this lobby will be associated with the local user's presence information.
    EOS_Bool
    IsRejoinAfterKickRequiresInvite
    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.
    String
    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.
    EOS_Lobby_LocalRTCOptions.ByReference
    LocalRTCOptions
    (Optional) Allows the local application to set local audio options for the RTC Room if it is enabled.
    EOS_ProductUserId
    LocalUserId
    The Product User ID of the local user creating the lobby; this user will automatically join the lobby as its owner
    int
    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

    Fields inherited from class com.sun.jna.Structure

    ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    EOS_Lobby_CreateLobbyOptions()
     
    EOS_Lobby_CreateLobbyOptions(com.sun.jna.Pointer peer)
     

  • Method Summary

    Methods inherited from class com.sun.jna.Structure

    allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • EOS_LOBBY_CREATELOBBY_API_LATEST

      public static final int EOS_LOBBY_CREATELOBBY_API_LATEST
      The most recent version of the EOS_Lobby_CreateLobby API.
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_LOBBY_CREATELOBBY_API_LATEST.

    • LocalUserId

      public EOS_ProductUserId LocalUserId
      The Product User ID of the local user creating the lobby; this user will automatically join the lobby as its owner

    • MaxLobbyMembers

      public int MaxLobbyMembers
      The maximum number of users who can be in the lobby at a time

    • PermissionLevel

      public EOS_ELobbyPermissionLevel PermissionLevel
      The initial permission level of the lobby

    • IsPresenceEnabled

      public EOS_Bool IsPresenceEnabled
      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.
      The Social Overlay can handle only one of the following three options at a time:
      • using the bPresenceEnabled flags within the Sessions interface
      • using the bPresenceEnabled flags within the Lobby interface
      • using EOS_PresenceModification_SetJoinInfo
      See Also:

    • IsAllowInvites

      public EOS_Bool IsAllowInvites
      Are members of the lobby allowed to invite others

    • BucketId

      public String BucketId
      Bucket ID associated with the lobby

    • IsDisableHostMigration

      public EOS_Bool IsDisableHostMigration
      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

    • IsEnableRTCRoom

      public EOS_Bool IsEnableRTCRoom
      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.
      See Also:

    • LocalRTCOptions

      public EOS_Lobby_LocalRTCOptions.ByReference 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.

    • LobbyId

      public String 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]

    • IsEnableJoinById

      public EOS_Bool IsEnableJoinById
      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.

    • IsRejoinAfterKickRequiresInvite

      public EOS_Bool IsRejoinAfterKickRequiresInvite
      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.

    • AllowedPlatformIds

      public com.sun.jna.ptr.IntByReference 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.

    • AllowedPlatformIdsCount

      public int AllowedPlatformIdsCount
      Number of platform IDs in the array

    • IsCrossplayOptOut

      public EOS_Bool IsCrossplayOptOut
      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.

  • Constructor Details

    • EOS_Lobby_CreateLobbyOptions

      public EOS_Lobby_CreateLobbyOptions()

    • EOS_Lobby_CreateLobbyOptions

      public EOS_Lobby_CreateLobbyOptions(com.sun.jna.Pointer peer)