Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Filters to use when querying for tournament information.
Some of these fields may be required, depending on the backing online system. Some fields may not be specified if other fields are specified, depending on the backing online system.
| Name | FOnlineTournamentQueryFilter |
| Type | struct |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineTournamentInterface.h |
| Include Path | #include "Interfaces/OnlineTournamentInterface.h" |
Syntax
struct FOnlineTournamentQueryFilter
Enums
Public
| Name | Remarks |
|---|---|
| EOnlineTournamentSortDirection | What direction to sort these results by (useful when specifying limits and offsetts) |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Format | TOptional< EOnlineTournamentFormat > | Filter tournament information that does not match this tournament format | Interfaces/OnlineTournamentInterface.h | |
| Limit | TOptional< uint32 > | Limit the results to this many entries | Interfaces/OnlineTournamentInterface.h | |
| Offset | TOptional< uint32 > | Start the results this many entries in | Interfaces/OnlineTournamentInterface.h | |
| ParticipantType | TOptional< EOnlineTournamentParticipantType > | Filter tournament information that does not match this participant type | Interfaces/OnlineTournamentInterface.h | |
| PlayerId | TOptional< FUniqueNetIdRef > | Only include tournament information that includes this player | Interfaces/OnlineTournamentInterface.h | |
| SortDirection | TOptional< EOnlineTournamentSortDirection > | Sort the results in this direction | Interfaces/OnlineTournamentInterface.h | |
| TeamId | TOptional< FOnlineTournamentTeamIdRef > | Only include tournament information that includes this team (on team tournaments) | Interfaces/OnlineTournamentInterface.h |