Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
One setting describing an online session contains a key, value and how this setting is advertised to others, if at all
| Name | FOnlineSessionSetting |
| Type | struct |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSessionSettings.h |
| Include Path | #include "OnlineSessionSettings.h" |
Syntax
struct FOnlineSessionSetting
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor, used when serializing a network packet | OnlineSessionSettings.h | ||
FOnlineSessionSetting
(
Type&& InData |
Constructor for settings created/defined on the host for a session | OnlineSessionSettings.h | |
FOnlineSessionSetting
(
Type&& InData, |
Constructor for settings created/defined on the host for a session | OnlineSessionSettings.h | |
FOnlineSessionSetting
(
Type&& InData, |
Constructor for settings created/defined on the host for a session | OnlineSessionSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AdvertisementType | EOnlineDataAdvertisementType::Type | How is this session setting advertised with the backend or searches | OnlineSessionSettings.h | |
| Data | FVariantData | Settings value | OnlineSessionSettings.h | |
| ID | int32 | Optional ID used in some platforms as the index instead of the session name | OnlineSessionSettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString ToString() |
OnlineSessionSettings.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FOnlineSessionSetting& Other |
OnlineSessionSettings.h | ||
bool operator==
(
const FOnlineSessionSetting& Other |
Comparison operator | OnlineSessionSettings.h |