EOS API reference page for EOS_Sessions_CreateSessionModificationOptions

3 mins to read

This data structure is part of the Sessions Interface.


Input parameters for the EOS_Sessions_CreateSessionModification function.



const char* SessionNameName of the session to create
const char* BucketIdBucket ID associated with the session
uint32_t MaxPlayersMaximum number of players allowed in the session
EOS_ProductUserId LocalUserIdThe Product User ID of the local user associated with the session
EOS_Bool bPresenceEnabledDetermines 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. * using the bPresenceEnabled flags within the Sessions interface * using the bPresenceEnabled flags within the Lobby interface * using EOS_PresenceModification_SetJoinInfo
const char* SessionIdOptional 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]
EOS_Bool bSanctionsEnabledIf 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
const uint32_t* 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.
uint32_t AllowedPlatformIdsCountNumber of platform IDs in the array