FOnlineSessionSetting

One setting describing an online session contains a key, value and how this setting is advertised to others, if at all

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

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

Include

#include "OnlineSessionSettings.h"

Syntax

struct FOnlineSessionSetting

Remarks

One setting describing an online session contains a key, value and how this setting is advertised to others, if at all

Variables

Name Description

Public variable

EOnlineDataAdve...

 

AdvertisementType

How is this session setting advertised with the backend or searches

Public variable

FVariantData

 

Data

Settings value

Public variable

int32

 

ID

Optional ID used in some platforms as the index instead of the session name

Constructors

Name Description

Public function

FOnlineSessionSetting()

Default constructor, used when serializing a network packet

Public function

FOnlineSessionSetting

(
    Type&& InData
)

Constructor for settings created/defined on the host for a session

Public function

FOnlineSessionSetting

(
    Type&& InData,
    EOnlineDataAdvertisementType::Type ...
)

Constructor for settings created/defined on the host for a session

Public function

FOnlineSessionSetting

(
    Type&& InData,
    EOnlineDataAdvertisementType::Type ...,
    int32 InID
)

Constructor for settings created/defined on the host for a session

Functions

Name Description

Public function Const

FString

 

ToString()

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FOnlineSessionSetting& Other
)

Public function Const

bool

 

operator==

(
    const FOnlineSessionSetting& Other
)

Comparison operator

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss