FOnlineSessionSettings

Container for all settings describing a single online session

Choose your operating system:

Windows

macOS

Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSessionSettings.h

Include

#include "OnlineSessionSettings.h"

Syntax

class FOnlineSessionSettings

Remarks

Container for all settings describing a single online session

Variables

Name Description

Public variable

bool

 

bAllowInvites

Whether the match allows invitations for this session or not

Public variable

bool

 

bAllowJoinInProgress

Whether joining in progress is allowed or not

Public variable

bool

 

bAllowJoinViaPresence

Whether joining via player presence is allowed or not

Public variable

bool

 

bAllowJoinViaPresenceFriendsOnly

Whether joining via player presence is allowed for friends only or not

Public variable

bool

 

bAntiCheatProtected

Whether the server employs anti-cheat (punkbuster, vac, etc)

Public variable

bool

 

bIsDedicated

Whether the server is dedicated or player hosted

Public variable

bool

 

bIsLANMatch

This game will be lan only and not be visible to external players

Public variable

bool

 

bShouldAdvertise

Whether this match is publicly advertised on the online service

Public variable

int32

 

BuildUniqueId

Used to keep different builds from seeing each other during searches

Public variable

bool

 

bUseLobbiesIfAvailable

Whether to prefer lobbies APIs if the platform supports them

Public variable

bool

 

bUseLobbiesVoiceChatIfAvailable

Whether to create (and auto join) a voice chat room for the lobby, if the platform supports it

Public variable

bool

 

bUsesPresence

Whether to display user presence information or not

Public variable

bool

 

bUsesStats

Whether the match should gather stats or not

Public variable

TUniqueNetIdMap...

 

MemberSettings

Map of custom settings per session member (Not currently used by every OSS)

Public variable

int32

 

NumPrivateConnections

The number of connections that are private (invite/password) only

Public variable

int32

 

NumPublicConnections

The number of publicly available connections advertised

Public variable

FSessionSetting...

 

Settings

Array of custom session settings

Constructors

Name Description

Public function

FOnlineSessionSettings()

Default constructor, used when serializing a network packet

Public function

FOnlineSessionSettings

(
    FOnlineSessionSettings&&
)

Public function

FOnlineSessionSettings

(
    const FOnlineSessionSettings&
)

Destructors

Name Description

Public function Virtual

~FOnlineSessionSettings()

Functions

Name Description

Public function Const

bool

 

Get

(
    FName Key,
    ValueType& Value
)

Gets a key value pair combination that defines a session setting

Public function Const

EOnlineDataA...

 

GetAdvertisementType

(
    FName Key
)

Retrieve a session setting's advertisement type

Public function Const

int32

 

GetID

(
    FName Key
)

Retrieve a session setting's ID

Public function

bool

 

Remove

(
    FName Key
)

Removes a key value pair combination

Public function

void

 

Set

(
    FName Key,
    const FOnlineSessionSetting& SrcSe...
)

Sets a key value pair combination that defines a session setting from an existing session setting

Public function

void

 

Set

(
    FName Key,
    const ValueType& Value,
    EOnlineDataAdvertisementType::Type ...
)

Sets a key value pair combination that defines a session setting

Public function

void

 

Set

(
    FName Key,
    const ValueType& Value,
    EOnlineDataAdvertisementType::Type ...,
    int32 InID
)

Sets a key value pair combination that defines a session setting with an ID

Operators

Name Description

Public function

FOnlineSessi...

 

operator=

(
    FOnlineSessionSettings&&
)

Public function

FOnlineSessi...

 

operator=

(
    const FOnlineSessionSettings&
)