Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FOnlineSessionSetting

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

Choose your operating system:

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
EOnlineDataAdve...	AdvertisementType	How is this session setting advertised with the backend or searches
FVariantData	Data	Settings value
int32	ID	Optional ID used in some platforms as the index instead of the session name

Constructors

	Name	Description
	FOnlineSessionSetting()	Default constructor, used when serializing a network packet
	FOnlineSessionSetting ( Type&& InData )	Constructor for settings created/defined on the host for a session
	FOnlineSessionSetting ( Type&& InData, EOnlineDataAdvertisementType::Type ... )	Constructor for settings created/defined on the host for a session
	FOnlineSessionSetting ( Type&& InData, EOnlineDataAdvertisementType::Type ..., int32 InID )	Constructor for settings created/defined on the host for a session

Functions

		Name	Description
	FString	ToString()

Operators

		Name	Description
	bool	operator!= ( const FOnlineSessionSetting& Other )
	bool	operator== ( const FOnlineSessionSetting& Other )	Comparison operator