FOnlineSessionSearch

Encapsulation of a search for sessions request.

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 FOnlineSessionSearch

Remarks

Encapsulation of a search for sessions request. Contains all the search parameters and any search results returned after the OnFindSessionsCompleteDelegate has triggered Check the SearchState for Done/Failed state before using the data

Variables

Name Description

Public variable

bool

 

bIsLanQuery

Whether the query is intended for LAN matches or not

Public variable

int32

 

MaxSearchResults

Max number of queries returned by the matchmaking service

Public variable

int32

 

PingBucketSize

Used to sort games into buckets since a the difference in terms of feel for ping in the same bucket is often not a useful comparison and skill is better

Public variable

int32

 

PlatformHash

Search hash used by the online subsystem to disambiguate search queries, stamped every time FindSession is called

Public variable

FOnlineSearchSe...

 

QuerySettings

The query to use for finding matching servers

Public variable

TArray< FOnline...

 

SearchResults

Array of all sessions found when searching for the given criteria

Public variable

EOnlineAsyncTas...

 

SearchState

State of the search

Public variable

float

 

TimeoutInSeconds

Amount of time to wait for the search results. May not apply to all platforms.

Constructors

Destructors

Name Description

Public function Virtual

~FOnlineSessionSearch()

Functions

Name Description

Public function Virtual Const

TSharedPtr< ...

 

GetDefaultSessionSettings()

Get the default session settings for this search type Allows games to set reasonable defaults that aren't advertised but would be setup for each instantiated search result

Public function Virtual

void

 

SortSearchResults()

Give the game a chance to sort the returned results

Operators

Name Description

Public function

FOnlineSessi...

 

operator=

(
    FOnlineSessionSearch&&
)

Public function

FOnlineSessi...

 

operator=

(
    const FOnlineSessionSearch&
)