EOS_Sessions_CreateSessionModificationOptions

EOS API reference page for EOS_Sessions_CreateSessionModificationOptions

This data structure is part of the Sessions Interface.

Remarks

Input parameters for the EOS_Sessions_CreateSessionModification function.

Properties

EOS_Sessions_CreateSessionModificationOptions

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_SESSIONS_CREATESESSIONMODIFICATION_API_LATEST.

const char* SessionName

Name of the session to create

const char* BucketId

Bucket ID associated with the session

uint32_t MaxPlayers

Maximum number of players allowed in the session

EOS_ProductUserId LocalUserId

The Product User ID of the local user associated with the session

EOS_Bool bPresenceEnabled

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* 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]

Related API Members