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

> Unreal Engine API Reference > Plugins > OnlineSubsystem > FOnlineSessionSearch

Light Theme

Dark Theme

FOnlineSessionSearch

Encapsulation of a search for sessions request.

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
bool	bIsLanQuery	Whether the query is intended for LAN matches or not
int32	MaxSearchResults	Max number of queries returned by the matchmaking service
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
int32	PlatformHash	Search hash used by the online subsystem to disambiguate search queries, stamped every time FindSession is called
FOnlineSearchSe...	QuerySettings	The query to use for finding matching servers
TArray< FOnline...	SearchResults	Array of all sessions found when searching for the given criteria
EOnlineAsyncTas...	SearchState	State of the search
float	TimeoutInSeconds	Amount of time to wait for the search results. May not apply to all platforms.

Constructors

	Name	Description
	FOnlineSessionSearch()	Constructor
	FOnlineSessionSearch ( FOnlineSessionSearch&& )
	FOnlineSessionSearch ( const FOnlineSessionSearch& )

Destructors

	Name	Description
	~FOnlineSessionSearch()

Functions

		Name	Description
	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
	void	SortSearchResults()	Give the game a chance to sort the returned results

Operators

		Name	Description
	FOnlineSessi...	operator= ( FOnlineSessionSearch&& )
	FOnlineSessi...	operator= ( const FOnlineSessionSearch& )

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

Take our survey

Dismiss