Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
The details of a tournament
| Name | IOnlineTournamentDetails |
| Type | struct |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineTournamentInterface.h |
| Include Path | #include "Interfaces/OnlineTournamentInterface.h" |
Syntax
struct IOnlineTournamentDetails : public TSharedFromThis< IOnlineTournamentDetails >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IOnlineTournamentDetails
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOnlineTournamentDetails() |
Interfaces/OnlineTournamentInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TOptional< FVariantData > GetAttribute
(
const FName AttributeName |
Get meta-data for this tournament (varies based on online platform) | Interfaces/OnlineTournamentInterface.h | |
| Get the check-in time of this tournament in UTC | Interfaces/OnlineTournamentInterface.h | ||
const FString & GetDescription() |
Get the Description for this tournament | Interfaces/OnlineTournamentInterface.h | |
| Get the end time of this tournament in UTC | Interfaces/OnlineTournamentInterface.h | ||
EOnlineTournamentFormat GetFormat() |
Get the the format of this tournament | Interfaces/OnlineTournamentInterface.h | |
| Get the last time in UTC this tournament's details were updated | Interfaces/OnlineTournamentInterface.h | ||
const TArray< TSharedRef< const IOnlineTournamentParticipantDetails > > & GetParticipants() |
Get the list of Participant IDs for this tournament if known | Interfaces/OnlineTournamentInterface.h | |
EOnlineTournamentParticipantType GetParticipantType() |
Get the type of participants that are involved in this tournament | Interfaces/OnlineTournamentInterface.h | |
| Get the registration end time of this tournament in UTC | Interfaces/OnlineTournamentInterface.h | ||
| Get the registration start time of this tournament in UTC | Interfaces/OnlineTournamentInterface.h | ||
| Get the start time of this tournament in UTC | Interfaces/OnlineTournamentInterface.h | ||
EOnlineTournamentState GetState() |
Get the current state of this tournament | Interfaces/OnlineTournamentInterface.h | |
const FString & GetTitle() |
Get the Title for this tournament | Interfaces/OnlineTournamentInterface.h | |
FOnlineTournamentIdRef GetTournamentId() |
Get the Tournament ID for this tournament | Interfaces/OnlineTournamentInterface.h | |
TOptional< bool > RequiresPremiumSubscription() |
Does this tournament require a premium subscription to participate in? | Interfaces/OnlineTournamentInterface.h |