Navigation
API > API/Plugins > API/Plugins/OnlineServicesCommon > API/Plugins/OnlineServicesCommon/Online
Inheritance Hierarchy
- ISession
- FSessionCommon
- FSessionLAN
- FSessionEOSGS
- FSessionOSSAdapter
References
| Module | OnlineServicesCommon |
| Header | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesCommon/Public/Online/SessionsCommon.h |
| Include | #include "Online/SessionsCommon.h" |
Syntax
class FSessionCommon : public UE::Online::ISession
Variables
| Type | Name | Description | |
|---|---|---|---|
| FAccountId | OwnerAccountId | The following members can be updated, and such update will be transmitted via a FSessionUpdated event The user who currently owns the session | |
| FSessionInfo | SessionInfo | Session information that will remain constant throughout the session's lifetime | |
| FSessionMemberIdsSet | SessionMembers | Set containing user ids for all the session members | |
| FSessionSettings | SessionSettings | Set of session properties that can be altered by the session owner |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FSessionCommon
(
const FSessionCommon& InSession |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | |||
| void | |||
| void |
Overridden from ISession
| Type | Name | Description | |
|---|---|---|---|
| void | DumpState () |
Returns a string with all the information in the session | |
| const uint32 | Retrieves the number of available slots for new session members | ||
| const FAccountId | ISession. | ||
| const FOnlineSessionId | GetSessionId () |
Retrieves the id handle for the session | |
| const FSessionInfo & | Retrieves the set of constant information about the session | ||
| const FSessionMemberIdsSet & | Retrieves the list of users currently in the session | ||
| const FSessionSettings & | Retrieves the set of variable information about the session | ||
| bool | IsJoinable () |
Evaluates a series of factors to determine if a session is accepting new members | |
| FString | ToLogString () |
Returns a string with the minimal information to identify the session |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FSessionCommon & | operator+=
(
const FSessionUpdate& SessionUpdate |
FSessionCommon |