FNamedOnlineSession

Holds the per session information for named sessions

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public variable

bool

 

bHosting

Whether or not the local player is hosting this session

Public variable

int32

 

HostingPlayerNum

Index of the player who created the session [host] or joined it [client]

Public variable

FUniqueNetIdPtr

 

LocalOwnerId

NetId of the local player that created this named session.

Public variable

TArray< FUnique...

 

RegisteredPlayers

List of players registered in the session

Public variable

const FName

 

SessionName

The name of the session

Public variable

EOnlineSessionS...

 

SessionState

State of the session (game thread write only)

Constructors

Name Description

Protected function

FNamedOnlineSession()

Public function

FNamedOnlineSession

(
    const FNamedOnlineSession& Other
)

Public function

FNamedOnlineSession

(
    FNamedOnlineSession&& Other
)

Public function

FNamedOnlineSession

(
    FName InSessionName,
    const FOnlineSessionSettings& InSe...
)

Constructor used to create a named session directly

Public function

FNamedOnlineSession

(
    FName InSessionName,
    const FOnlineSession& Session
)

Constructor used to create a named session directly

Destructors

Name Description

Public function Virtual

~FNamedOnlineSession()

Functions

Name Description

Public function Const

bool

 

GetJoinability

(
    bool& bPublicJoinable,
    bool& bFriendJoinable,
    bool& bInviteOnly,
    bool& bAllowInvites
)

Calculate the possible joinability state of this session check the values from left to right in order of precedence

Operators

Name Description

Public function

FNamedOnline...

 

operator=

(
    const FNamedOnlineSession& Other
)

We delete the equals operator as SessionName is immutable.

Public function

FNamedOnline...

 

operator=

(
    FNamedOnlineSession&& Other
)