Class EOS_Sessions_CreateSessionModificationOptions
java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.sessions.options.EOS_Sessions_CreateSessionModificationOptions
- Direct Known Subclasses:
EOS_Sessions_CreateSessionModificationOptions.ByReference
,EOS_Sessions_CreateSessionModificationOptions.ByValue
@FieldOrder({"ApiVersion","SessionName","BucketId","MaxPlayers","LocalUserId","IsPresenceEnabled","SessionId","IsSanctionsEnabled","AllowedPlatformIds","AllowedPlatformIdsCount"})
public class EOS_Sessions_CreateSessionModificationOptions
extends com.sun.jna.Structure
Input parameters for the EOS_Sessions_CreateSessionModification function.
- Since:
- 9/5/2023
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
Nested classes/interfaces inherited from class com.sun.jna.Structure
com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField
-
Field Summary
Modifier and TypeFieldDescriptioncom.sun.jna.ptr.IntByReference
Array of platform IDs indicating the player platforms allowed to register with the session.int
Number of platform IDs in the arrayint
API Version: Set this toEOS_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST
.Bucket ID associated with the sessionstatic int
Maximum length of the name of the attribute associated with the sessionstatic int
Maximum number of attributes allowed on the sessionstatic int
Maximum number of characters allowed in the session id overridestatic int
Minimum number of characters allowed in the session id overridestatic int
The most recent version of the EOS_Sessions_CreateSessionModification API.Determines whether or not this session should be the one associated with the local user's presence information.If true, sanctioned players can neither join nor register with this session and, in the case of join, will return EOS_EResult code EOS_Sessions_PlayerSanctionedThe Product User ID of the local user associated with the sessionint
Maximum number of players allowed in the sessionOptional session id - set to a globally unique value to override the backend assignment If not specified the backend service will assign one to the session.Name of the session to createFields inherited from class com.sun.jna.Structure
ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE
-
Constructor Summary
-
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
-
Field Details
-
EOS_SESSIONMODIFICATION_MAX_SESSION_ATTRIBUTES
public static int EOS_SESSIONMODIFICATION_MAX_SESSION_ATTRIBUTESMaximum number of attributes allowed on the session -
EOS_SESSIONMODIFICATION_MAX_SESSION_ATTRIBUTE_LENGTH
public static int EOS_SESSIONMODIFICATION_MAX_SESSION_ATTRIBUTE_LENGTHMaximum length of the name of the attribute associated with the session -
EOS_SESSIONMODIFICATION_MIN_SESSIONIDOVERRIDE_LENGTH
public static int EOS_SESSIONMODIFICATION_MIN_SESSIONIDOVERRIDE_LENGTHMinimum number of characters allowed in the session id override -
EOS_SESSIONMODIFICATION_MAX_SESSIONIDOVERRIDE_LENGTH
public static int EOS_SESSIONMODIFICATION_MAX_SESSIONIDOVERRIDE_LENGTHMaximum number of characters allowed in the session id override -
EOS_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST
public static int EOS_SESSIONS_CREATESESSIONMODIFICATION_API_LATESTThe most recent version of the EOS_Sessions_CreateSessionModification API. -
ApiVersion
public int ApiVersionAPI Version: Set this toEOS_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST
. -
SessionName
Name of the session to create -
BucketId
Bucket ID associated with the session -
MaxPlayers
public int MaxPlayersMaximum number of players allowed in the session -
LocalUserId
The Product User ID of the local user associated with the session -
IsPresenceEnabled
Determines whether or not this session should be the one associated with the local user's presence information. If true, this session will be associated with presence. Only one session at a time can have this flag true. 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
-
SessionId
Optional session id - set to a globally unique value to override the backend assignment If not specified the backend service will assign one to the session. Do not mix and match. This value can be of size [EOS_SESSIONMODIFICATION_MIN_SESSIONIDOVERRIDE_LENGTH
,EOS_SESSIONMODIFICATION_MAX_SESSIONIDOVERRIDE_LENGTH
] -
IsSanctionsEnabled
If true, sanctioned players can neither join nor register with this session and, in the case of join, will return EOS_EResult code EOS_Sessions_PlayerSanctioned -
AllowedPlatformIds
public com.sun.jna.ptr.IntByReference AllowedPlatformIdsArray 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 session will be unrestricted. -
AllowedPlatformIdsCount
public int AllowedPlatformIdsCountNumber of platform IDs in the array
-
-
Constructor Details
-
EOS_Sessions_CreateSessionModificationOptions
public EOS_Sessions_CreateSessionModificationOptions() -
EOS_Sessions_CreateSessionModificationOptions
public EOS_Sessions_CreateSessionModificationOptions(com.sun.jna.Pointer peer)
-