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