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

Class EOS_LobbyDetails_Info

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.lobby.EOS_LobbyDetails_Info

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

EOS_LobbyDetails_Info.ByReference, EOS_LobbyDetails_Info.ByValue

@FieldOrder({"ApiVersion","LobbyId","LobbyOwnerUserId","PermissionLevel","AvailableSlots","MaxMembers","IsAllowInvites","BucketId","IsAllowHostMigration","IsRTCRoomEnabled","IsAllowJoinById","IsRejoinAfterKickRequiresInvite","IsPresenceEnabled","AllowedPlatformIds","AllowedPlatformIdsCount"})
public class EOS_LobbyDetails_Info
extends com.sun.jna.Structure
implements AutoCloseable

Since:

8/16/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_LobbyDetails_Info.ByReference
static class	EOS_LobbyDetails_Info.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_LOBBYDETAILS_INFO_API_LATEST.
int	AvailableSlots	Current available space
String	BucketId	The main indexed parameter for this lobby, can be any string (i.e.
static final int	EOS_LOBBYDETAILS_INFO_API_LATEST
EOS_Bool	IsAllowHostMigration	Is host migration allowed
EOS_Bool	IsAllowInvites	If true, users can invite others to this lobby
EOS_Bool	IsAllowJoinById	Is EOS_Lobby_JoinLobbyById allowed
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
EOS_Bool	IsRTCRoomEnabled	Was a Real-Time Communication (RTC) room enabled at lobby creation?
String	LobbyId	Lobby ID
EOS_ProductUserId	LobbyOwnerUserId	The Product User ID of the current owner of the lobby
int	MaxMembers	Max allowed members in the lobby
int	PermissionLevel	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_LobbyDetails_Info()
EOS_LobbyDetails_Info(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method	Description
void	close()
void	release()

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_LOBBYDETAILS_INFO_API_LATEST

public static final int EOS_LOBBYDETAILS_INFO_API_LATEST

See Also:

• Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LOBBYDETAILS_INFO_API_LATEST.

LobbyId

public String LobbyId

Lobby ID

LobbyOwnerUserId

public EOS_ProductUserId LobbyOwnerUserId

The Product User ID of the current owner of the lobby

PermissionLevel

public int PermissionLevel

Permission level of the lobby

AvailableSlots

public int AvailableSlots

Current available space

MaxMembers

public int MaxMembers

Max allowed members in the lobby

IsAllowInvites

public EOS_Bool IsAllowInvites

If true, users can invite others to this lobby

BucketId

public String BucketId

The main indexed parameter for this lobby, can be any string (i.e. "Region:GameMode")

IsAllowHostMigration

public EOS_Bool IsAllowHostMigration

Is host migration allowed

IsRTCRoomEnabled

public EOS_Bool IsRTCRoomEnabled

Was a Real-Time Communication (RTC) room enabled at lobby creation?

IsAllowJoinById

public EOS_Bool IsAllowJoinById

Is EOS_Lobby_JoinLobbyById allowed

IsRejoinAfterKickRequiresInvite

public EOS_Bool IsRejoinAfterKickRequiresInvite

Does rejoining after being kicked require an invite

IsPresenceEnabled

public EOS_Bool IsPresenceEnabled

If true, this lobby will be associated with the local user's presence information.

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

Constructor Details

EOS_LobbyDetails_Info

public EOS_LobbyDetails_Info()

EOS_LobbyDetails_Info

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

Method Details

release

public void release()

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception