1. Epic GamesDeveloper
  3. FOnlineSessionSettings

FOnlineSessionSettings

Container for all settings describing a single online session

API > API/Plugins > API/Plugins/OnlineSubsystem

Container for all settings describing a single online session

   
Name FOnlineSessionSettings
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSessionSettings.h
Include Path #include "OnlineSessionSettings.h"

Syntax

class FOnlineSessionSettings

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor, used when serializing a network packet OnlineSessionSettings.h  
  OnlineSessionSettings.h  
  OnlineSessionSettings.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FOnlineSessionSettings()

   OnlineSessionSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowInvites bool Whether the match allows invitations for this session or not OnlineSessionSettings.h  
bAllowJoinInProgress bool Whether joining in progress is allowed or not OnlineSessionSettings.h  
bAllowJoinViaPresence bool Whether joining via player presence is allowed or not OnlineSessionSettings.h  
bAllowJoinViaPresenceFriendsOnly bool Whether joining via player presence is allowed for friends only or not OnlineSessionSettings.h  
bAntiCheatProtected bool Whether the server employs anti-cheat (punkbuster, vac, etc) OnlineSessionSettings.h  
bIsDedicated bool Whether the server is dedicated or player hosted OnlineSessionSettings.h  
bIsLANMatch bool This game will be lan only and not be visible to external players OnlineSessionSettings.h  
bShouldAdvertise bool Whether this match is publicly advertised on the online service OnlineSessionSettings.h  
BuildUniqueId int32 Used to keep different builds from seeing each other during searches OnlineSessionSettings.h  
bUseLobbiesIfAvailable bool Whether to prefer lobbies APIs if the platform supports them OnlineSessionSettings.h  
bUseLobbiesVoiceChatIfAvailable bool Whether to create (and auto join) a voice chat room for the lobby, if the platform supports it OnlineSessionSettings.h  
bUsesPresence bool Whether to display user presence information or not OnlineSessionSettings.h  
bUsesStats bool Whether the match should gather stats or not OnlineSessionSettings.h  
MemberSettings TUniqueNetIdMap< FSessionSettings > Map of custom settings per session member (Not currently used by every OSS) OnlineSessionSettings.h  
NumPrivateConnections int32 The number of connections that are private (invite/password) only OnlineSessionSettings.h  
NumPublicConnections int32 The number of publicly available connections advertised OnlineSessionSettings.h  
SessionIdOverride FString Manual override for the Session Id instead of having one assigned by the backend. OnlineSessionSettings.h  
Settings FSessionSettings Array of custom session settings OnlineSessionSettings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Get ( FName Key,
ValueType& Value
) const

 Gets a key value pair combination that defines a session setting OnlineSessionSettings.h  

EOnlineDataAdvertisementType::Type GetAdvertisementType ( FName Key
) const

 Retrieve a session setting's advertisement type OnlineSessionSettings.h  

int32 GetID ( FName Key
) const

 Retrieve a session setting's ID OnlineSessionSettings.h  

bool Remove ( FName Key
)

 Removes a key value pair combination OnlineSessionSettings.h  

void Set ( FName Key,
const FOnlineSessionSetting& SrcSetting
)

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

void Set ( FName Key,
const ValueType& Value,
EOnlineDataAdvertisementType::Type InType
)

 Sets a key value pair combination that defines a session setting OnlineSessionSettings.h  

void Set ( FName Key,
const ValueType& Value,
EOnlineDataAdvertisementType::Type InType,
int32 InID
)

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

Operators

Name Remarks Include Path Unreal Specifiers
  OnlineSessionSettings.h  
  OnlineSessionSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page