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

Class EOS_Lobby_JoinLobbyOptions

java.lang.Object

com.sun.jna.Structure

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

Direct Known Subclasses:

EOS_Lobby_JoinLobbyOptions.ByReference, EOS_Lobby_JoinLobbyOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","LobbyDetailsHandle","LocalUserId","IsPresenceEnabled","LocalRTCOptions","IsCrossplayOptOut","RTCRoomJoinActionType"})
public class EOS_Lobby_JoinLobbyOptions
extends com.sun.jna.Structure

Input parameters for the EOS_Lobby_JoinLobby function.

Since:

8/17/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Lobby_JoinLobbyOptions.ByReference
static class	EOS_Lobby_JoinLobbyOptions.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 and Description
int	ApiVersion API Version: Set this to EOS_LOBBY_JOINLOBBY_API_LATEST.
static int	EOS_LOBBY_JOINLOBBY_API_LATEST The most recent version of the EOS_Lobby_JoinLobby API.
EOS_Bool	IsCrossplayOptOut This value indicates whether or not the local user allows crossplay interactions.
EOS_Bool	IsPresenceEnabled If true, this lobby will be associated with the local user's presence information.
EOS_LobbyDetails	LobbyDetailsHandle The handle of the lobby to join
EOS_Lobby_LocalRTCOptions.ByReference	LocalRTCOptions (Optional) Set this value to override the default local options for the RTC Room, if it is enabled for this lobby.
EOS_ProductUserId	LocalUserId The Product User ID of the local user joining the lobby
EOS_ELobbyRTCRoomJoinActionType	RTCRoomJoinActionType For lobbies with the RTC Room feature enabled, this value indicates the action to take against the RTC Room when joining the lobby.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_Lobby_JoinLobbyOptions()
EOS_Lobby_JoinLobbyOptions(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 Detail

EOS_LOBBY_JOINLOBBY_API_LATEST

public static final int EOS_LOBBY_JOINLOBBY_API_LATEST

The most recent version of the EOS_Lobby_JoinLobby API.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LOBBY_JOINLOBBY_API_LATEST.

LobbyDetailsHandle

public EOS_LobbyDetails LobbyDetailsHandle

The handle of the lobby to join

LocalUserId

public EOS_ProductUserId LocalUserId

The Product User ID of the local user joining the lobby

IsPresenceEnabled

public EOS_Bool IsPresenceEnabled

If true, this lobby will be associated with the local user's presence information. A user can only associate one lobby at a time with their presence information. 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:

EOS_PresenceModification_SetJoinInfoOptions, EOS_Lobby_CreateLobbyOptions, EOS_Lobby_JoinLobbyOptions, EOS_Sessions_CreateSessionModificationOptions, EOS_Sessions_JoinSessionOptions

LocalRTCOptions

public EOS_Lobby_LocalRTCOptions.ByReference LocalRTCOptions

(Optional) Set this value to override the default local options for the RTC Room, if it is enabled for this lobby. Set this to NULL if your application does not use the Lobby RTC Rooms feature, or if you would like to use the default settings. This option is ignored if the specified lobby does not have an RTC Room enabled and will not cause errors.

IsCrossplayOptOut

public EOS_Bool IsCrossplayOptOut

This value indicates whether or not the local user allows crossplay interactions. If it is false, the local user will be treated as allowing crossplay.

RTCRoomJoinActionType

public EOS_ELobbyRTCRoomJoinActionType RTCRoomJoinActionType

For lobbies with the RTC Room feature enabled, this value indicates the action to take against the RTC Room when joining the lobby. This may be used to indicate the RTCRoom should be joined immediately or manually at a later time.

Constructor Detail

EOS_Lobby_JoinLobbyOptions

public EOS_Lobby_JoinLobbyOptions()

EOS_Lobby_JoinLobbyOptions

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