Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Holds the per session information for named sessions
| Name | FNamedOnlineSession |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSessionSettings.h |
| Include Path | #include "OnlineSessionSettings.h" |
Syntax
class FNamedOnlineSession : public FOnlineSession
Inheritance Hierarchy
- FOnlineSession → FNamedOnlineSession
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| OnlineSessionSettings.h | |||
FNamedOnlineSession
(
const FNamedOnlineSession& Other |
OnlineSessionSettings.h | ||
FNamedOnlineSession
(
FNamedOnlineSession&& Other |
OnlineSessionSettings.h | ||
FNamedOnlineSession
(
FName InSessionName, |
Constructor used to create a named session directly | OnlineSessionSettings.h | |
FNamedOnlineSession
(
FName InSessionName, |
Constructor used to create a named session directly | OnlineSessionSettings.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNamedOnlineSession() |
OnlineSessionSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHosting | bool | Whether or not the local player is hosting this session | OnlineSessionSettings.h | |
| HostingPlayerNum | int32 | Index of the player who created the session [host] or joined it [client] | OnlineSessionSettings.h | |
| LocalOwnerId | FUniqueNetIdPtr | NetId of the local player that created this named session. | OnlineSessionSettings.h | |
| RegisteredPlayers | TArray< FUniqueNetIdRef > | List of players registered in the session | OnlineSessionSettings.h | |
| SessionName | const FName | The name of the session | OnlineSessionSettings.h | |
| SessionState | EOnlineSessionState::Type | State of the session (game thread write only) | OnlineSessionSettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetJoinability
(
bool& bPublicJoinable, |
Calculate the possible joinability state of this session check the values from left to right in order of precedence | OnlineSessionSettings.h |
Protected
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNamedOnlineSession & operator=
(
const FNamedOnlineSession& Other |
We delete the equals operator as SessionName is immutable. | OnlineSessionSettings.h | |
FNamedOnlineSession & operator=
(
FNamedOnlineSession&& Other |
OnlineSessionSettings.h |