Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
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
| Name | FOnlineSessionSearch |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSessionSettings.h |
| Include Path | #include "OnlineSessionSettings.h" |
Syntax
class FOnlineSessionSearch
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Constructor | OnlineSessionSettings.h | ||
| OnlineSessionSettings.h | |||
FOnlineSessionSearch
(
const FOnlineSessionSearch& |
OnlineSessionSettings.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FOnlineSessionSearch() |
OnlineSessionSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsLanQuery | bool | Whether the query is intended for LAN matches or not | OnlineSessionSettings.h | |
| MaxSearchResults | int32 | Max number of queries returned by the matchmaking service | OnlineSessionSettings.h | |
| PingBucketSize | int32 | 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 | OnlineSessionSettings.h | |
| PlatformHash | int32 | Search hash used by the online subsystem to disambiguate search queries, stamped every time FindSession is called | OnlineSessionSettings.h | |
| QuerySettings | FOnlineSearchSettings | The query to use for finding matching servers | OnlineSessionSettings.h | |
| SearchResults | TArray< FOnlineSessionSearchResult > | Array of all sessions found when searching for the given criteria | OnlineSessionSettings.h | |
| SearchState | EOnlineAsyncTaskState::Type | State of the search | OnlineSessionSettings.h | |
| TimeoutInSeconds | float | Amount of time to wait for the search results. May not apply to all platforms. | OnlineSessionSettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< FOnlineSessionSettings > 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 | OnlineSessionSettings.h | |
virtual void SortSearchResults() |
Give the game a chance to sort the returned results | OnlineSessionSettings.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| OnlineSessionSettings.h | |||
FOnlineSessionSearch & operator=
(
const FOnlineSessionSearch& |
OnlineSessionSettings.h |